diff --git a/DiscoveryJson/aiplatform.v1.json b/DiscoveryJson/aiplatform.v1.json
index b21f72dac87..526bccef74d 100644
--- a/DiscoveryJson/aiplatform.v1.json
+++ b/DiscoveryJson/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,
@@ -19988,191 +25152,2382 @@
}
}
}
- }
+ }
+ }
+ }
+ },
+ "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"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "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": "v1/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": "v1/{+name}:cancel",
+ "request": {
+ "$ref": "GoogleCloudAiplatformV1CancelTrainingPipelineRequest"
+ },
+ "response": {
+ "$ref": "GoogleProtobufEmpty"
+ },
+ "scopes": [
+ "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}",
+ "httpMethod": "DELETE",
+ "id": "aiplatform.projects.locations.trainingPipelines.delete",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "GoogleLongrunningOperation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Gets a TrainingPipeline.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}",
+ "httpMethod": "GET",
+ "id": "aiplatform.projects.locations.trainingPipelines.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the TrainingPipeline resource. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "GoogleCloudAiplatformV1TrainingPipeline"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "description": "Lists TrainingPipelines in a Location.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines",
+ "httpMethod": "GET",
+ "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": "The standard list page size.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "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 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}/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.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": {
+ "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"
+ },
+ "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"
+ },
+ "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/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"
},
- "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"
- ]
- }
- }
+ "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"
+ ]
},
- "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/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"
},
@@ -20180,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",
@@ -20279,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"
},
@@ -20495,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"
},
@@ -20617,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"
],
@@ -20633,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"
}
@@ -20648,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"
],
@@ -20658,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"
}
@@ -20673,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"
],
@@ -20683,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"
}
@@ -20698,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"
],
@@ -20713,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"
},
@@ -20741,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": {
- "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": "^tensorboards/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
- "path": "v1/{+endpoint}:computeTokens",
- "request": {
- "$ref": "GoogleCloudAiplatformV1ComputeTokensRequest"
+ "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": {
+ "name": {
+ "description": "The name of the operation resource to be deleted.",
+ "location": "path",
+ "pattern": "^tensorboards/[^/]+/operations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
},
+ "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"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "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.trainingPipelines.operations.cancel",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be cancelled.",
+ "location": "path",
+ "pattern": "^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/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": "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/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}",
+ "httpMethod": "GET",
+ "id": "aiplatform.trainingPipelines.operations.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "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",
- "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",
- "httpMethod": "POST",
- "id": "aiplatform.publishers.models.generateContent",
+ "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": [
- "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": "^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/{+model}:generateContent",
- "request": {
- "$ref": "GoogleCloudAiplatformV1GenerateContentRequest"
+ "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": "The name of the operation resource to wait on.",
+ "location": "path",
+ "pattern": "^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": "GoogleCloudAiplatformV1GenerateContentResponse"
+ "$ref": "GoogleLongrunningOperation"
},
"scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
+ "https://www.googleapis.com/auth/cloud-platform"
]
- },
- "get": {
- "description": "Gets a Model Garden publisher model.",
- "flatPath": "v1/publishers/{publishersId}/models/{modelsId}",
- "httpMethod": "GET",
- "id": "aiplatform.publishers.models.get",
+ }
+ }
+ }
+ }
+ },
+ "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.tuningJobs.operations.cancel",
"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}`",
+ "description": "The name of the operation resource to be cancelled.",
"location": "path",
- "pattern": "^publishers/[^/]+/models/[^/]+$",
+ "pattern": "^tuningJobs/[^/]+/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": "v1/{+name}",
+ "path": "v1/{+name}:cancel",
"response": {
- "$ref": "GoogleCloudAiplatformV1PublisherModel"
+ "$ref": "GoogleProtobufEmpty"
},
"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",
+ "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}`",
+ "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}: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/publishers/{publishersId}/models/{modelsId}:predictLongRunning",
- "httpMethod": "POST",
- "id": "aiplatform.publishers.models.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/tuningJobs/{tuningJobsId}/operations/{operationsId}",
+ "httpMethod": "GET",
+ "id": "aiplatform.tuningJobs.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": "^publishers/[^/]+/models/[^/]+$",
+ "pattern": "^tuningJobs/[^/]+/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"
]
},
- "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": "20251010",
+ "revision": "20251027",
"rootUrl": "https://aiplatform.googleapis.com/",
"schemas": {
"CloudAiLargeModelsVisionGenerateVideoResponse": {
@@ -26906,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."
@@ -26932,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",
@@ -27387,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."
@@ -30474,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.",
@@ -30485,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",
@@ -30796,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": {
@@ -31659,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"
@@ -35639,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.",
@@ -39822,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",
@@ -40396,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"
@@ -40470,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",
@@ -48376,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."
@@ -48499,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",
diff --git a/DiscoveryJson/apihub.v1.json b/DiscoveryJson/apihub.v1.json
index 89bf9c1f95d..343ae7ab09b 100644
--- a/DiscoveryJson/apihub.v1.json
+++ b/DiscoveryJson/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/DiscoveryJson/businessprofileperformance.v1.json b/DiscoveryJson/businessprofileperformance.v1.json
index 0e66bace4cf..a3cad61acb5 100644
--- a/DiscoveryJson/businessprofileperformance.v1.json
+++ b/DiscoveryJson/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/DiscoveryJson/chat.v1.json b/DiscoveryJson/chat.v1.json
index d0787c30a81..07e9aebbcba 100644
--- a/DiscoveryJson/chat.v1.json
+++ b/DiscoveryJson/chat.v1.json
@@ -1535,7 +1535,7 @@
}
}
},
- "revision": "20251016",
+ "revision": "20251023",
"rootUrl": "https://chat.googleapis.com/",
"schemas": {
"AccessSettings": {
@@ -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"
}
diff --git a/DiscoveryJson/chromewebstore.v2.json b/DiscoveryJson/chromewebstore.v2.json
index e5fffbbd838..e17435629ec 100644
--- a/DiscoveryJson/chromewebstore.v2.json
+++ b/DiscoveryJson/chromewebstore.v2.json
@@ -272,39 +272,9 @@
}
}
},
- "revision": "20251020",
+ "revision": "20251026",
"rootUrl": "https://chromewebstore.googleapis.com/",
"schemas": {
- "Blobstore2Info": {
- "description": "Information to read/write to blobstore2.",
- "id": "Blobstore2Info",
- "properties": {
- "blobGeneration": {
- "description": "The blob generation id.",
- "format": "int64",
- "type": "string"
- },
- "blobId": {
- "description": "The blob id, e.g., /blobstore/prod/playground/scotty",
- "type": "string"
- },
- "downloadReadHandle": {
- "description": "Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.",
- "format": "byte",
- "type": "string"
- },
- "readToken": {
- "description": "The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.",
- "type": "string"
- },
- "uploadMetadataContainer": {
- "description": "Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.",
- "format": "byte",
- "type": "string"
- }
- },
- "type": "object"
- },
"CancelSubmissionRequest": {
"description": "Request message for CancelSubmission.",
"id": "CancelSubmissionRequest",
@@ -317,106 +287,6 @@
"properties": {},
"type": "object"
},
- "CompositeMedia": {
- "description": "A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites.",
- "id": "CompositeMedia",
- "properties": {
- "blobRef": {
- "deprecated": true,
- "description": "Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.",
- "format": "byte",
- "type": "string"
- },
- "blobstore2Info": {
- "$ref": "Blobstore2Info",
- "description": "Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob."
- },
- "cosmoBinaryReference": {
- "description": "A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.",
- "format": "byte",
- "type": "string"
- },
- "crc32cHash": {
- "description": "crc32.c hash for the payload.",
- "format": "uint32",
- "type": "integer"
- },
- "inline": {
- "description": "Media data, set if reference_type is INLINE",
- "format": "byte",
- "type": "string"
- },
- "length": {
- "description": "Size of the data, in bytes",
- "format": "int64",
- "type": "string"
- },
- "md5Hash": {
- "description": "MD5 hash for the payload.",
- "format": "byte",
- "type": "string"
- },
- "objectId": {
- "$ref": "ObjectId",
- "description": "Reference to a TI Blob, set if reference_type is BIGSTORE_REF."
- },
- "path": {
- "description": "Path to the data, set if reference_type is PATH",
- "type": "string"
- },
- "referenceType": {
- "description": "Describes what the field reference contains.",
- "enum": [
- "PATH",
- "BLOB_REF",
- "INLINE",
- "BIGSTORE_REF",
- "COSMO_BINARY_REFERENCE"
- ],
- "enumDescriptions": [
- "Reference contains a GFS path or a local path.",
- "Reference points to a blobstore object. This could be either a v1 blob_ref or a v2 blobstore2_info. Clients should check blobstore2_info first, since v1 is being deprecated.",
- "Data is included into this proto buffer",
- "Reference points to a bigstore object",
- "Indicates the data is stored in cosmo_binary_reference."
- ],
- "type": "string"
- },
- "sha1Hash": {
- "description": "SHA-1 hash for the payload.",
- "format": "byte",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ContentTypeInfo": {
- "description": "Detailed Content-Type information from Scotty. The Content-Type of the media will typically be filled in by the header or Scotty's best_guess, but this extended information provides the backend with more information so that it can make a better decision if needed. This is only used on media upload requests from Scotty.",
- "id": "ContentTypeInfo",
- "properties": {
- "bestGuess": {
- "description": "Scotty's best guess of what the content type of the file is.",
- "type": "string"
- },
- "fromBytes": {
- "description": "The content type of the file derived by looking at specific bytes (i.e. \"magic bytes\") of the actual file.",
- "type": "string"
- },
- "fromFileName": {
- "description": "The content type of the file derived from the file extension of the original file name used by the client.",
- "type": "string"
- },
- "fromHeader": {
- "description": "The content type of the file as specified in the request headers, multipart headers, or RUPIO start request.",
- "type": "string"
- },
- "fromUrlPath": {
- "description": "The content type of the file derived from the file extension of the URL path. The URL path is assumed to represent a file name (which is typically only true for agents that are providing a REST API).",
- "type": "string"
- }
- },
- "type": "object"
- },
"DeployInfo": {
"description": "Deployment information for a specific release channel. Used in requests to update deployment parameters.",
"id": "DeployInfo",
@@ -429,96 +299,6 @@
},
"type": "object"
},
- "DiffChecksumsResponse": {
- "description": "Backend response for a Diff get checksums response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.",
- "id": "DiffChecksumsResponse",
- "properties": {
- "checksumsLocation": {
- "$ref": "CompositeMedia",
- "description": "Exactly one of these fields must be populated. If checksums_location is filled, the server will return the corresponding contents to the user. If object_location is filled, the server will calculate the checksums based on the content there and return that to the user. For details on the format of the checksums, see http://go/scotty-diff-protocol."
- },
- "chunkSizeBytes": {
- "description": "The chunk size of checksums. Must be a multiple of 256KB.",
- "format": "int64",
- "type": "string"
- },
- "objectLocation": {
- "$ref": "CompositeMedia",
- "description": "If set, calculate the checksums based on the contents and return them to the caller."
- },
- "objectSizeBytes": {
- "description": "The total size of the server object.",
- "format": "int64",
- "type": "string"
- },
- "objectVersion": {
- "description": "The object version of the object the checksums are being returned for.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "DiffDownloadResponse": {
- "description": "Backend response for a Diff download response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.",
- "id": "DiffDownloadResponse",
- "properties": {
- "objectLocation": {
- "$ref": "CompositeMedia",
- "description": "The original object location."
- }
- },
- "type": "object"
- },
- "DiffUploadRequest": {
- "description": "A Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.",
- "id": "DiffUploadRequest",
- "properties": {
- "checksumsInfo": {
- "$ref": "CompositeMedia",
- "description": "The location of the checksums for the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received. For details on the format of the checksums, see http://go/scotty-diff-protocol."
- },
- "objectInfo": {
- "$ref": "CompositeMedia",
- "description": "The location of the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received."
- },
- "objectVersion": {
- "description": "The object version of the object that is the base version the incoming diff script will be applied to. This field will always be filled in.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "DiffUploadResponse": {
- "description": "Backend response for a Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.",
- "id": "DiffUploadResponse",
- "properties": {
- "objectVersion": {
- "description": "The object version of the object at the server. Must be included in the end notification response. The version in the end notification response must correspond to the new version of the object that is now stored at the server, after the upload.",
- "type": "string"
- },
- "originalObject": {
- "$ref": "CompositeMedia",
- "description": "The location of the original file for a diff upload request. Must be filled in if responding to an upload start notification."
- }
- },
- "type": "object"
- },
- "DiffVersionResponse": {
- "description": "Backend response for a Diff get version response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.",
- "id": "DiffVersionResponse",
- "properties": {
- "objectSizeBytes": {
- "description": "The total size of the server object.",
- "format": "int64",
- "type": "string"
- },
- "objectVersion": {
- "description": "The version of the object stored at the server.",
- "type": "string"
- }
- },
- "type": "object"
- },
"DistributionChannel": {
"description": "Deployment information for a specific release channel",
"id": "DistributionChannel",
@@ -535,21 +315,6 @@
},
"type": "object"
},
- "DownloadParameters": {
- "description": "Parameters specific to media downloads.",
- "id": "DownloadParameters",
- "properties": {
- "allowGzipCompression": {
- "description": "A boolean to be returned in the response to Scotty. Allows/disallows gzip encoding of the payload content when the server thinks it's advantageous (hence, does not guarantee compression) which allows Scotty to GZip the response to the client.",
- "type": "boolean"
- },
- "ignoreRange": {
- "description": "Determining whether or not Apiary should skip the inclusion of any Content-Range header on its response to Scotty.",
- "type": "boolean"
- }
- },
- "type": "object"
- },
"FetchItemStatusResponse": {
"description": "Response message for `FetchItemStatus`.",
"id": "FetchItemStatusResponse",
@@ -643,267 +408,6 @@
},
"type": "object"
},
- "Media": {
- "description": "A reference to data stored on the filesystem, on GFS or in blobstore.",
- "id": "Media",
- "properties": {
- "algorithm": {
- "deprecated": true,
- "description": "Deprecated, use one of explicit hash type fields instead. Algorithm used for calculating the hash. As of 2011/01/21, \"MD5\" is the only possible value for this field. New values may be added at any time.",
- "type": "string"
- },
- "bigstoreObjectRef": {
- "deprecated": true,
- "description": "Use object_id instead.",
- "format": "byte",
- "type": "string"
- },
- "blobRef": {
- "deprecated": true,
- "description": "Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.",
- "format": "byte",
- "type": "string"
- },
- "blobstore2Info": {
- "$ref": "Blobstore2Info",
- "description": "Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob."
- },
- "compositeMedia": {
- "description": "A composite media composed of one or more media objects, set if reference_type is COMPOSITE_MEDIA. The media length field must be set to the sum of the lengths of all composite media objects. Note: All composite media must have length specified.",
- "items": {
- "$ref": "CompositeMedia"
- },
- "type": "array"
- },
- "contentType": {
- "description": "MIME type of the data",
- "type": "string"
- },
- "contentTypeInfo": {
- "$ref": "ContentTypeInfo",
- "description": "Extended content type information provided for Scotty uploads."
- },
- "cosmoBinaryReference": {
- "description": "A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.",
- "format": "byte",
- "type": "string"
- },
- "crc32cHash": {
- "description": "For Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided by the agent to be used to verify the data being downloaded. Currently only supported for inline payloads. Further, only crc32c_hash is currently supported.",
- "format": "uint32",
- "type": "integer"
- },
- "diffChecksumsResponse": {
- "$ref": "DiffChecksumsResponse",
- "description": "Set if reference_type is DIFF_CHECKSUMS_RESPONSE."
- },
- "diffDownloadResponse": {
- "$ref": "DiffDownloadResponse",
- "description": "Set if reference_type is DIFF_DOWNLOAD_RESPONSE."
- },
- "diffUploadRequest": {
- "$ref": "DiffUploadRequest",
- "description": "Set if reference_type is DIFF_UPLOAD_REQUEST."
- },
- "diffUploadResponse": {
- "$ref": "DiffUploadResponse",
- "description": "Set if reference_type is DIFF_UPLOAD_RESPONSE."
- },
- "diffVersionResponse": {
- "$ref": "DiffVersionResponse",
- "description": "Set if reference_type is DIFF_VERSION_RESPONSE."
- },
- "downloadParameters": {
- "$ref": "DownloadParameters",
- "description": "Parameters for a media download."
- },
- "filename": {
- "description": "Original file name",
- "type": "string"
- },
- "hash": {
- "deprecated": true,
- "description": "Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media.",
- "type": "string"
- },
- "hashVerified": {
- "description": "For Scotty uploads only. If a user sends a hash code and the backend has requested that Scotty verify the upload against the client hash, Scotty will perform the check on behalf of the backend and will reject it if the hashes don't match. This is set to true if Scotty performed this verification.",
- "type": "boolean"
- },
- "inline": {
- "description": "Media data, set if reference_type is INLINE",
- "format": "byte",
- "type": "string"
- },
- "isPotentialRetry": {
- "description": "|is_potential_retry| is set false only when Scotty is certain that it has not sent the request before. When a client resumes an upload, this field must be set true in agent calls, because Scotty cannot be certain that it has never sent the request before due to potential failure in the session state persistence.",
- "type": "boolean"
- },
- "length": {
- "description": "Size of the data, in bytes",
- "format": "int64",
- "type": "string"
- },
- "md5Hash": {
- "description": "Scotty-provided MD5 hash for an upload.",
- "format": "byte",
- "type": "string"
- },
- "mediaId": {
- "description": "Media id to forward to the operation GetMedia. Can be set if reference_type is GET_MEDIA.",
- "format": "byte",
- "type": "string"
- },
- "objectId": {
- "$ref": "ObjectId",
- "description": "Reference to a TI Blob, set if reference_type is BIGSTORE_REF."
- },
- "path": {
- "description": "Path to the data, set if reference_type is PATH",
- "type": "string"
- },
- "referenceType": {
- "description": "Describes what the field reference contains.",
- "enum": [
- "PATH",
- "BLOB_REF",
- "INLINE",
- "GET_MEDIA",
- "COMPOSITE_MEDIA",
- "BIGSTORE_REF",
- "DIFF_VERSION_RESPONSE",
- "DIFF_CHECKSUMS_RESPONSE",
- "DIFF_DOWNLOAD_RESPONSE",
- "DIFF_UPLOAD_REQUEST",
- "DIFF_UPLOAD_RESPONSE",
- "COSMO_BINARY_REFERENCE",
- "ARBITRARY_BYTES"
- ],
- "enumDescriptions": [
- "Reference contains a GFS path or a local path.",
- "Reference points to a blobstore object. This could be either a v1 blob_ref or a v2 blobstore2_info. Clients should check blobstore2_info first, since v1 is being deprecated.",
- "Data is included into this proto buffer",
- "Data should be accessed from the current service using the operation GetMedia.",
- "The content for this media object is stored across multiple partial media objects under the composite_media field.",
- "Reference points to a bigstore object",
- "Indicates the data is stored in diff_version_response.",
- "Indicates the data is stored in diff_checksums_response.",
- "Indicates the data is stored in diff_download_response.",
- "Indicates the data is stored in diff_upload_request.",
- "Indicates the data is stored in diff_upload_response.",
- "Indicates the data is stored in cosmo_binary_reference.",
- "Informs Scotty to generate a response payload with the size specified in the length field. The contents of the payload are generated by Scotty and are undefined. This is useful for testing download speeds between the user and Scotty without involving a real payload source. Note: range is not supported when using arbitrary_bytes."
- ],
- "type": "string"
- },
- "sha1Hash": {
- "description": "Scotty-provided SHA1 hash for an upload.",
- "format": "byte",
- "type": "string"
- },
- "sha256Hash": {
- "description": "Scotty-provided SHA256 hash for an upload.",
- "format": "byte",
- "type": "string"
- },
- "timestamp": {
- "description": "Time at which the media data was last updated, in milliseconds since UNIX epoch",
- "format": "uint64",
- "type": "string"
- },
- "token": {
- "description": "A unique fingerprint/version id for the media data",
- "type": "string"
- }
- },
- "type": "object"
- },
- "MediaRequestInfo": {
- "description": "Extra information added to operations that support Scotty media requests.",
- "id": "MediaRequestInfo",
- "properties": {
- "currentBytes": {
- "description": "The number of current bytes uploaded or downloaded.",
- "format": "int64",
- "type": "string"
- },
- "customData": {
- "description": "Data to be copied to backend requests. Custom data is returned to Scotty in the agent_state field, which Scotty will then provide in subsequent upload notifications.",
- "type": "string"
- },
- "diffObjectVersion": {
- "description": "Set if the http request info is diff encoded. The value of this field is the version number of the base revision. This is corresponding to Apiary's mediaDiffObjectVersion (//depot/google3/java/com/google/api/server/media/variable/DiffObjectVersionVariable.java). See go/esf-scotty-diff-upload for more information.",
- "type": "string"
- },
- "finalStatus": {
- "description": "The existence of the final_status field indicates that this is the last call to the agent for this request_id. http://google3/uploader/agent/scotty_agent.proto?l=737&rcl=347601929",
- "format": "int32",
- "type": "integer"
- },
- "notificationType": {
- "description": "The type of notification received from Scotty.",
- "enum": [
- "START",
- "PROGRESS",
- "END",
- "RESPONSE_SENT",
- "ERROR"
- ],
- "enumDescriptions": [
- "Such requests signals the start of a request containing media upload. Only the media field(s) in the inserted/updated resource are set. The response should either return an error or succeed. On success, responses don't need to contain anything.",
- "Such requests signals that the upload has progressed and that the backend might want to access the media file specified in relevant fields in the resource. Only the media field(s) in the inserted/updated resource are set. The response should either return an error or succeed. On success, responses don't need to contain anything.",
- "Such requests signals the end of a request containing media upload. END should be handled just like normal Insert/Upload requests, that is, they should process the request and return a complete resource in the response. Pointers to media data (a GFS path usually) appear in the relevant fields in the inserted/updated resource. See gdata.Media in data.proto.",
- "Such requests occur after an END and signal that the response has been sent back to the client. RESPONSE_SENT is only sent to the backend if it is configured to receive them. The response does not need to contain anything.",
- "Such requests indicate that an error occurred while processing the request. ERROR is only sent to the backend if it is configured to receive them. It is not guaranteed that all errors will result in this notification to the backend, even if the backend requests them. Since these requests are just for informational purposes, the response does not need to contain anything."
- ],
- "type": "string"
- },
- "physicalHeaders": {
- "description": "The physical headers provided by RequestReceivedParameters in Scotty request. type is uploader_service.KeyValuePairs.",
- "format": "byte",
- "type": "string"
- },
- "requestId": {
- "description": "The Scotty request ID.",
- "type": "string"
- },
- "requestReceivedParamsServingInfo": {
- "description": "The partition of the Scotty server handling this request. type is uploader_service.RequestReceivedParamsServingInfo LINT.IfChange(request_received_params_serving_info_annotations) LINT.ThenChange()",
- "format": "byte",
- "type": "string"
- },
- "totalBytes": {
- "description": "The total size of the file.",
- "format": "int64",
- "type": "string"
- },
- "totalBytesIsEstimated": {
- "description": "Whether the total bytes field contains an estimated data.",
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "ObjectId": {
- "description": "This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763.",
- "id": "ObjectId",
- "properties": {
- "bucketName": {
- "description": "The name of the bucket to which this object belongs.",
- "type": "string"
- },
- "generation": {
- "description": "Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions",
- "format": "int64",
- "type": "string"
- },
- "objectName": {
- "description": "The name of the object.",
- "type": "string"
- }
- },
- "type": "object"
- },
"PublishItemRequest": {
"description": "Request message for PublishItem.",
"id": "PublishItemRequest",
@@ -996,16 +500,7 @@
"UploadItemPackageRequest": {
"description": "Request message for UploadItemPackage.",
"id": "UploadItemPackageRequest",
- "properties": {
- "blob": {
- "$ref": "Media",
- "description": "Reference to the uploaded media."
- },
- "mediaRequestInfo": {
- "$ref": "MediaRequestInfo",
- "description": "Info about the media upload request."
- }
- },
+ "properties": {},
"type": "object"
},
"UploadItemPackageResponse": {
diff --git a/DiscoveryJson/cloudfunctions.v1.json b/DiscoveryJson/cloudfunctions.v1.json
index d6a95f575f7..764be874ac9 100644
--- a/DiscoveryJson/cloudfunctions.v1.json
+++ b/DiscoveryJson/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/DiscoveryJson/cloudfunctions.v2.json b/DiscoveryJson/cloudfunctions.v2.json
index f7176e5cc51..d7ca3553754 100644
--- a/DiscoveryJson/cloudfunctions.v2.json
+++ b/DiscoveryJson/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/DiscoveryJson/cloudfunctions.v2alpha.json b/DiscoveryJson/cloudfunctions.v2alpha.json
index 04e26fb91a6..7d2c3a2399a 100644
--- a/DiscoveryJson/cloudfunctions.v2alpha.json
+++ b/DiscoveryJson/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/DiscoveryJson/cloudfunctions.v2beta.json b/DiscoveryJson/cloudfunctions.v2beta.json
index 0dedf52b651..60aebd8f927 100644
--- a/DiscoveryJson/cloudfunctions.v2beta.json
+++ b/DiscoveryJson/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/DiscoveryJson/cloudscheduler.v1.json b/DiscoveryJson/cloudscheduler.v1.json
index 6d2bfb7c106..bb0a79a8a79 100644
--- a/DiscoveryJson/cloudscheduler.v1.json
+++ b/DiscoveryJson/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/DiscoveryJson/cloudscheduler.v1beta1.json b/DiscoveryJson/cloudscheduler.v1beta1.json
index 3d6dacb4f24..e5f126d6329 100644
--- a/DiscoveryJson/cloudscheduler.v1beta1.json
+++ b/DiscoveryJson/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/DiscoveryJson/cloudtasks.v2beta2.json b/DiscoveryJson/cloudtasks.v2beta2.json
index 1527172a874..0a8680d289f 100644
--- a/DiscoveryJson/cloudtasks.v2beta2.json
+++ b/DiscoveryJson/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/DiscoveryJson/cloudtasks.v2beta3.json b/DiscoveryJson/cloudtasks.v2beta3.json
index f08d537fa34..e5e17a4e60f 100644
--- a/DiscoveryJson/cloudtasks.v2beta3.json
+++ b/DiscoveryJson/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/DiscoveryJson/deploymentmanager.v2.json b/DiscoveryJson/deploymentmanager.v2.json
index fa0beb48e38..b9c6bba4922 100644
--- a/DiscoveryJson/deploymentmanager.v2.json
+++ b/DiscoveryJson/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/DiscoveryJson/deploymentmanager.v2beta.json b/DiscoveryJson/deploymentmanager.v2beta.json
index 2613a4cc555..e126cea494c 100644
--- a/DiscoveryJson/deploymentmanager.v2beta.json
+++ b/DiscoveryJson/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/DiscoveryJson/discoveryengine.v1.json b/DiscoveryJson/discoveryengine.v1.json
index 1fe50327a18..ad6fd465dc1 100644
--- a/DiscoveryJson/discoveryengine.v1.json
+++ b/DiscoveryJson/discoveryengine.v1.json
@@ -8078,7 +8078,7 @@
}
}
},
- "revision": "20251020",
+ "revision": "20251026",
"rootUrl": "https://discoveryengine.googleapis.com/",
"schemas": {
"GdataBlobstore2Info": {
@@ -13275,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": [
@@ -15526,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",
@@ -15558,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",
@@ -21146,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": [
@@ -23101,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",
@@ -23133,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",
@@ -25874,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": [
@@ -27337,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",
@@ -27369,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",
diff --git a/DiscoveryJson/discoveryengine.v1alpha.json b/DiscoveryJson/discoveryengine.v1alpha.json
index 4e25f730229..d4598bec5f5 100644
--- a/DiscoveryJson/discoveryengine.v1alpha.json
+++ b/DiscoveryJson/discoveryengine.v1alpha.json
@@ -762,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": {
@@ -10956,7 +11118,7 @@
}
}
},
- "revision": "20251023",
+ "revision": "20251026",
"rootUrl": "https://discoveryengine.googleapis.com/",
"schemas": {
"ApiservingMediaRequestInfo": {
@@ -13411,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": [
@@ -14676,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",
@@ -14708,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",
@@ -18137,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",
@@ -20877,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": [
@@ -23772,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",
@@ -24450,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",
@@ -24482,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",
@@ -30365,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": [
@@ -31828,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",
@@ -31860,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",
diff --git a/DiscoveryJson/discoveryengine.v1beta.json b/DiscoveryJson/discoveryengine.v1beta.json
index 4a4583ed0c1..8877b89e58c 100644
--- a/DiscoveryJson/discoveryengine.v1beta.json
+++ b/DiscoveryJson/discoveryengine.v1beta.json
@@ -8802,7 +8802,7 @@
}
}
},
- "revision": "20251020",
+ "revision": "20251026",
"rootUrl": "https://discoveryengine.googleapis.com/",
"schemas": {
"GdataBlobstore2Info": {
@@ -11090,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": [
@@ -12355,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",
@@ -12387,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",
@@ -16017,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": [
@@ -17972,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",
@@ -18004,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",
@@ -23989,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": [
@@ -26583,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",
@@ -26615,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",
diff --git a/DiscoveryJson/docs.v1.json b/DiscoveryJson/docs.v1.json
index b1dc16c4cba..181847abf1d 100644
--- a/DiscoveryJson/docs.v1.json
+++ b/DiscoveryJson/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/DiscoveryJson/documentai.v1.json b/DiscoveryJson/documentai.v1.json
index d9326ee0c3f..ee3ff2a3ab4 100644
--- a/DiscoveryJson/documentai.v1.json
+++ b/DiscoveryJson/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 `\u00b9\u2044\u2087\u2082` 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_ \u00f7 `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 `\u00b9\u2044\u2087\u2082` 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_ \u00f7 `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/DiscoveryJson/documentai.v1beta3.json b/DiscoveryJson/documentai.v1beta3.json
index 0d5f5de84fb..3819f4eeb15 100644
--- a/DiscoveryJson/documentai.v1beta3.json
+++ b/DiscoveryJson/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/DiscoveryJson/firebaseapphosting.v1beta.json b/DiscoveryJson/firebaseapphosting.v1beta.json
index 7dd43d87998..a7df26f6cea 100644
--- a/DiscoveryJson/firebaseapphosting.v1beta.json
+++ b/DiscoveryJson/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"
@@ -1103,7 +1103,7 @@
}
}
},
- "revision": "20251020",
+ "revision": "20251023",
"rootUrl": "https://firebaseapphosting.googleapis.com/",
"schemas": {
"ArchiveSource": {
diff --git a/DiscoveryJson/gkeonprem.v1.json b/DiscoveryJson/gkeonprem.v1.json
index c61d36bbec8..7d394bb6a96 100644
--- a/DiscoveryJson/gkeonprem.v1.json
+++ b/DiscoveryJson/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/DiscoveryJson/ids.v1.json b/DiscoveryJson/ids.v1.json
index 8603ea0c051..56b6ba9cee4 100644
--- a/DiscoveryJson/ids.v1.json
+++ b/DiscoveryJson/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/DiscoveryJson/parametermanager.v1.json b/DiscoveryJson/parametermanager.v1.json
index 94c3cf9d5c0..bcbc7730874 100644
--- a/DiscoveryJson/parametermanager.v1.json
+++ b/DiscoveryJson/parametermanager.v1.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"
@@ -821,7 +821,7 @@
}
}
},
- "revision": "20251015",
+ "revision": "20251025",
"rootUrl": "https://parametermanager.googleapis.com/",
"schemas": {
"Empty": {
diff --git a/DiscoveryJson/paymentsresellersubscription.v1.json b/DiscoveryJson/paymentsresellersubscription.v1.json
index 23b67da27bf..0dfb6ef51b3 100644
--- a/DiscoveryJson/paymentsresellersubscription.v1.json
+++ b/DiscoveryJson/paymentsresellersubscription.v1.json
@@ -586,7 +586,7 @@
}
}
},
- "revision": "20251019",
+ "revision": "20251026",
"rootUrl": "https://paymentsresellersubscription.googleapis.com/",
"schemas": {
"Amount": {
@@ -1001,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/DiscoveryJson/retail.v2alpha.json b/DiscoveryJson/retail.v2alpha.json
index 062e69f344c..3f1aec1b70d 100644
--- a/DiscoveryJson/retail.v2alpha.json
+++ b/DiscoveryJson/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/DiscoveryJson/retail.v2beta.json b/DiscoveryJson/retail.v2beta.json
index 15e967e8dfe..f3e3a8d6091 100644
--- a/DiscoveryJson/retail.v2beta.json
+++ b/DiscoveryJson/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/DiscoveryJson/securitycenter.v1.json b/DiscoveryJson/securitycenter.v1.json
index 11737fea166..d26dc0fa091 100644
--- a/DiscoveryJson/securitycenter.v1.json
+++ b/DiscoveryJson/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": "20251017",
+ "revision": "20251024",
"rootUrl": "https://securitycenter.googleapis.com/",
"schemas": {
"Access": {
diff --git a/DiscoveryJson/securitycenter.v1beta1.json b/DiscoveryJson/securitycenter.v1beta1.json
index 372e732e180..66bff3130df 100644
--- a/DiscoveryJson/securitycenter.v1beta1.json
+++ b/DiscoveryJson/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": "20251017",
+ "revision": "20251024",
"rootUrl": "https://securitycenter.googleapis.com/",
"schemas": {
"Access": {
diff --git a/DiscoveryJson/serviceusage.v1beta1.json b/DiscoveryJson/serviceusage.v1beta1.json
index 84581cc1b71..5b575e00238 100644
--- a/DiscoveryJson/serviceusage.v1beta1.json
+++ b/DiscoveryJson/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/DiscoveryJson/sqladmin.v1.json b/DiscoveryJson/sqladmin.v1.json
index b0caf5474a6..d87f41bf9c6 100644
--- a/DiscoveryJson/sqladmin.v1.json
+++ b/DiscoveryJson/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/DiscoveryJson/storagebatchoperations.v1.json b/DiscoveryJson/storagebatchoperations.v1.json
index 0d1af224e39..76f3188b9eb 100644
--- a/DiscoveryJson/storagebatchoperations.v1.json
+++ b/DiscoveryJson/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/DiscoveryJson/vpcaccess.v1.json b/DiscoveryJson/vpcaccess.v1.json
index e7fabfdd5f3..c28938f128e 100644
--- a/DiscoveryJson/vpcaccess.v1.json
+++ b/DiscoveryJson/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/Src/Generated/Google.Apis.APIhub.v1/Google.Apis.APIhub.v1.cs b/Src/Generated/Google.Apis.APIhub.v1/Google.Apis.APIhub.v1.cs
index 5ba843b8bff..d6bd7dcb569 100644
--- a/Src/Generated/Google.Apis.APIhub.v1/Google.Apis.APIhub.v1.cs
+++ b/Src/Generated/Google.Apis.APIhub.v1/Google.Apis.APIhub.v1.cs
@@ -1034,10 +1034,15 @@ protected override void InitParameters()
///
/// 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.
+ /// 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.
///
/// The body of the request.
///
@@ -1052,10 +1057,15 @@ public virtual PatchRequest Patch(Google.Apis.APIhub.v1.Data.GoogleCloudApihubV1
///
/// 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.
+ /// 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.
///
public class PatchRequest : APIhubBaseServiceRequest
{
@@ -2522,9 +2532,9 @@ protected override void InitParameters()
///
/// 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.
+ /// 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.
///
/// The body of the request.
///
@@ -2539,9 +2549,9 @@ public virtual PatchRequest Patch(Google.Apis.APIhub.v1.Data.GoogleCloudApihubV1
///
/// 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.
+ /// 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.
///
public class PatchRequest : APIhubBaseServiceRequest
{
@@ -5415,6 +5425,17 @@ public ListRequest(Google.Apis.Services.IClientService service, string name) : b
[Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
public virtual string PageToken { get; set; }
+ ///
+ /// When set to `true`, operations that are reachable are returned as normal, and those that are
+ /// unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be
+ /// `true` when reading across collections e.g. when `parent` is set to
+ /// `"projects/example/locations/-"`. This field is not by default supported and will result in an
+ /// `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product
+ /// specific documentation.
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("returnPartialSuccess", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual System.Nullable ReturnPartialSuccess { get; set; }
+
/// Gets the method name.
public override string MethodName => "list";
@@ -5460,6 +5481,14 @@ protected override void InitParameters()
DefaultValue = null,
Pattern = null,
});
+ RequestParameters.Add("returnPartialSuccess", new Google.Apis.Discovery.Parameter
+ {
+ Name = "returnPartialSuccess",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
}
}
}
@@ -7171,8 +7200,8 @@ public ListRequest(Google.Apis.Services.IClientService service, string name) : b
public virtual string Name { get; private set; }
///
- /// 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.
///
[Google.Apis.Util.RequestParameterAttribute("extraLocationTypes", Google.Apis.Util.RequestParameterType.Query)]
public virtual Google.Apis.Util.Repeatable ExtraLocationTypes { get; set; }
@@ -7635,7 +7664,10 @@ public virtual System.DateTimeOffset? CreateTimeDateTimeOffset
[Newtonsoft.Json.JsonPropertyAttribute("documentation")]
public virtual GoogleCloudApihubV1Documentation Documentation { get; set; }
- /// 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.
+ ///
[Newtonsoft.Json.JsonPropertyAttribute("fingerprint")]
public virtual string Fingerprint { get; set; }
@@ -12392,6 +12424,14 @@ public class GoogleLongrunningListOperationsResponse : Google.Apis.Requests.IDir
[Newtonsoft.Json.JsonPropertyAttribute("operations")]
public virtual System.Collections.Generic.IList Operations { get; set; }
+ ///
+ /// 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.
+ ///
+ [Newtonsoft.Json.JsonPropertyAttribute("unreachable")]
+ public virtual System.Collections.Generic.IList Unreachable { get; set; }
+
/// The ETag of the item.
public virtual string ETag { get; set; }
}
diff --git a/Src/Generated/Google.Apis.APIhub.v1/Google.Apis.APIhub.v1.csproj b/Src/Generated/Google.Apis.APIhub.v1/Google.Apis.APIhub.v1.csproj
index 1684fa66fbf..6724623b733 100644
--- a/Src/Generated/Google.Apis.APIhub.v1/Google.Apis.APIhub.v1.csproj
+++ b/Src/Generated/Google.Apis.APIhub.v1/Google.Apis.APIhub.v1.csproj
@@ -3,7 +3,7 @@
Google.Apis.APIhub.v1 Client Library
- 1.71.0.3907
+ 1.72.0.3950
Google LLC
Copyright 2025 Google LLC
Google
@@ -59,8 +59,8 @@
-
-
+
+
diff --git a/Src/Generated/Google.Apis.Aiplatform.v1/Google.Apis.Aiplatform.v1.cs b/Src/Generated/Google.Apis.Aiplatform.v1/Google.Apis.Aiplatform.v1.cs
index 86a5851ef19..206f4951a57 100644
--- a/Src/Generated/Google.Apis.Aiplatform.v1/Google.Apis.Aiplatform.v1.cs
+++ b/Src/Generated/Google.Apis.Aiplatform.v1/Google.Apis.Aiplatform.v1.cs
@@ -35,12 +35,39 @@ public AiplatformService() : this(new Google.Apis.Services.BaseClientService.Ini
public AiplatformService(Google.Apis.Services.BaseClientService.Initializer initializer) : base(initializer)
{
BatchPredictionJobs = new BatchPredictionJobsResource(this);
+ CustomJobs = new CustomJobsResource(this);
+ DataLabelingJobs = new DataLabelingJobsResource(this);
Datasets = new DatasetsResource(this);
+ DeploymentResourcePools = new DeploymentResourcePoolsResource(this);
Endpoints = new EndpointsResource(this);
+ FeatureGroups = new FeatureGroupsResource(this);
+ FeatureOnlineStores = new FeatureOnlineStoresResource(this);
+ Featurestores = new FeaturestoresResource(this);
+ HyperparameterTuningJobs = new HyperparameterTuningJobsResource(this);
+ IndexEndpoints = new IndexEndpointsResource(this);
+ Indexes = new IndexesResource(this);
Media = new MediaResource(this);
+ MetadataStores = new MetadataStoresResource(this);
+ MigratableResources = new MigratableResourcesResource(this);
+ ModelDeploymentMonitoringJobs = new ModelDeploymentMonitoringJobsResource(this);
+ Models = new ModelsResource(this);
+ NotebookExecutionJobs = new NotebookExecutionJobsResource(this);
+ NotebookRuntimeTemplates = new NotebookRuntimeTemplatesResource(this);
+ NotebookRuntimes = new NotebookRuntimesResource(this);
+ Operations = new OperationsResource(this);
+ PersistentResources = new PersistentResourcesResource(this);
+ PipelineJobs = new PipelineJobsResource(this);
Projects = new ProjectsResource(this);
Publishers = new PublishersResource(this);
+ RagCorpora = new RagCorporaResource(this);
+ RagEngineConfig = new RagEngineConfigResource(this);
ReasoningEngines = new ReasoningEnginesResource(this);
+ Schedules = new SchedulesResource(this);
+ SpecialistPools = new SpecialistPoolsResource(this);
+ Studies = new StudiesResource(this);
+ Tensorboards = new TensorboardsResource(this);
+ TrainingPipelines = new TrainingPipelinesResource(this);
+ TuningJobs = new TuningJobsResource(this);
BaseUri = GetEffectiveUri(BaseUriOverride, "https://aiplatform.googleapis.com/");
BatchUri = GetEffectiveUri(null, "https://aiplatform.googleapis.com/batch");
}
@@ -96,23 +123,104 @@ public static class ScopeConstants
/// Gets the BatchPredictionJobs resource.
public virtual BatchPredictionJobsResource BatchPredictionJobs { get; }
+ /// Gets the CustomJobs resource.
+ public virtual CustomJobsResource CustomJobs { get; }
+
+ /// Gets the DataLabelingJobs resource.
+ public virtual DataLabelingJobsResource DataLabelingJobs { get; }
+
/// Gets the Datasets resource.
public virtual DatasetsResource Datasets { get; }
+ /// Gets the DeploymentResourcePools resource.
+ public virtual DeploymentResourcePoolsResource DeploymentResourcePools { get; }
+
/// Gets the Endpoints resource.
public virtual EndpointsResource Endpoints { get; }
+ /// Gets the FeatureGroups resource.
+ public virtual FeatureGroupsResource FeatureGroups { get; }
+
+ /// Gets the FeatureOnlineStores resource.
+ public virtual FeatureOnlineStoresResource FeatureOnlineStores { get; }
+
+ /// Gets the Featurestores resource.
+ public virtual FeaturestoresResource Featurestores { get; }
+
+ /// Gets the HyperparameterTuningJobs resource.
+ public virtual HyperparameterTuningJobsResource HyperparameterTuningJobs { get; }
+
+ /// Gets the IndexEndpoints resource.
+ public virtual IndexEndpointsResource IndexEndpoints { get; }
+
+ /// Gets the Indexes resource.
+ public virtual IndexesResource Indexes { get; }
+
/// Gets the Media resource.
public virtual MediaResource Media { get; }
+ /// Gets the MetadataStores resource.
+ public virtual MetadataStoresResource MetadataStores { get; }
+
+ /// Gets the MigratableResources resource.
+ public virtual MigratableResourcesResource MigratableResources { get; }
+
+ /// Gets the ModelDeploymentMonitoringJobs resource.
+ public virtual ModelDeploymentMonitoringJobsResource ModelDeploymentMonitoringJobs { get; }
+
+ /// Gets the Models resource.
+ public virtual ModelsResource Models { get; }
+
+ /// Gets the NotebookExecutionJobs resource.
+ public virtual NotebookExecutionJobsResource NotebookExecutionJobs { get; }
+
+ /// Gets the NotebookRuntimeTemplates resource.
+ public virtual NotebookRuntimeTemplatesResource NotebookRuntimeTemplates { get; }
+
+ /// Gets the NotebookRuntimes resource.
+ public virtual NotebookRuntimesResource NotebookRuntimes { get; }
+
+ /// Gets the Operations resource.
+ public virtual OperationsResource Operations { get; }
+
+ /// Gets the PersistentResources resource.
+ public virtual PersistentResourcesResource PersistentResources { get; }
+
+ /// Gets the PipelineJobs resource.
+ public virtual PipelineJobsResource PipelineJobs { get; }
+
/// Gets the Projects resource.
public virtual ProjectsResource Projects { get; }
/// Gets the Publishers resource.
public virtual PublishersResource Publishers { get; }
+ /// Gets the RagCorpora resource.
+ public virtual RagCorporaResource RagCorpora { get; }
+
+ /// Gets the RagEngineConfig resource.
+ public virtual RagEngineConfigResource RagEngineConfig { get; }
+
/// Gets the ReasoningEngines resource.
public virtual ReasoningEnginesResource ReasoningEngines { get; }
+
+ /// Gets the Schedules resource.
+ public virtual SchedulesResource Schedules { get; }
+
+ /// Gets the SpecialistPools resource.
+ public virtual SpecialistPoolsResource SpecialistPools { get; }
+
+ /// Gets the Studies resource.
+ public virtual StudiesResource Studies { get; }
+
+ /// Gets the Tensorboards resource.
+ public virtual TensorboardsResource Tensorboards { get; }
+
+ /// Gets the TrainingPipelines resource.
+ public virtual TrainingPipelinesResource TrainingPipelines { get; }
+
+ /// Gets the TuningJobs resource.
+ public virtual TuningJobsResource TuningJobs { get; }
}
/// A base abstract class for Aiplatform requests.
@@ -526,109 +634,114 @@ protected override void InitParameters()
}
}
- /// The "datasets" collection of methods.
- public class DatasetsResource
+ /// The "customJobs" collection of methods.
+ public class CustomJobsResource
{
- private const string Resource = "datasets";
+ private const string Resource = "customJobs";
/// The service which this resource belongs to.
private readonly Google.Apis.Services.IClientService service;
/// Constructs a new resource.
- public DatasetsResource(Google.Apis.Services.IClientService service)
+ public CustomJobsResource(Google.Apis.Services.IClientService service)
{
this.service = service;
- DatasetVersions = new DatasetVersionsResource(service);
+ Operations = new OperationsResource(service);
}
- /// Gets the DatasetVersions resource.
- public virtual DatasetVersionsResource DatasetVersions { get; }
+ /// Gets the Operations resource.
+ public virtual OperationsResource Operations { get; }
- /// The "datasetVersions" collection of methods.
- public class DatasetVersionsResource
+ /// The "operations" collection of methods.
+ public class OperationsResource
{
- private const string Resource = "datasetVersions";
+ private const string Resource = "operations";
/// The service which this resource belongs to.
private readonly Google.Apis.Services.IClientService service;
/// Constructs a new resource.
- public DatasetVersionsResource(Google.Apis.Services.IClientService service)
+ public OperationsResource(Google.Apis.Services.IClientService service)
{
this.service = service;
}
- /// Create a version from a Dataset.
- /// The body of the request.
- ///
- /// Required. The name of the Dataset resource. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}`
- ///
- public virtual CreateRequest Create(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1DatasetVersion body, string parent)
+ ///
+ /// Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel
+ /// the operation, but success is not guaranteed. If the server doesn't support this method, it returns
+ /// `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check
+ /// whether the cancellation succeeded or whether the operation completed despite cancellation. On
+ /// successful cancellation, the operation is not deleted; instead, it becomes an operation with an
+ /// Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+ ///
+ /// The name of the operation resource to be cancelled.
+ public virtual CancelRequest Cancel(string name)
{
- return new CreateRequest(this.service, body, parent);
+ return new CancelRequest(this.service, name);
}
- /// Create a version from a Dataset.
- public class CreateRequest : AiplatformBaseServiceRequest
+ ///
+ /// Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel
+ /// the operation, but success is not guaranteed. If the server doesn't support this method, it returns
+ /// `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check
+ /// whether the cancellation succeeded or whether the operation completed despite cancellation. On
+ /// successful cancellation, the operation is not deleted; instead, it becomes an operation with an
+ /// Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+ ///
+ public class CancelRequest : AiplatformBaseServiceRequest
{
- /// Constructs a new Create request.
- public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1DatasetVersion body, string parent) : base(service)
+ /// Constructs a new Cancel request.
+ public CancelRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
- Parent = parent;
- Body = body;
+ Name = name;
InitParameters();
}
- ///
- /// Required. The name of the Dataset resource. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Parent { get; private set; }
-
- /// Gets or sets the body of this request.
- Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1DatasetVersion Body { get; set; }
-
- /// Returns the body of the request.
- protected override object GetBody() => Body;
+ /// The name of the operation resource to be cancelled.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
/// Gets the method name.
- public override string MethodName => "create";
+ public override string MethodName => "cancel";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
- public override string RestPath => "v1/{+parent}/datasetVersions";
+ public override string RestPath => "v1/{+name}:cancel";
- /// Initializes Create parameter list.
+ /// Initializes Cancel parameter list.
protected override void InitParameters()
{
base.InitParameters();
- RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- Name = "parent",
+ Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
- Pattern = @"^datasets/[^/]+$",
+ Pattern = @"^customJobs/[^/]+/operations/[^/]+$",
});
}
}
- /// Deletes a Dataset version.
- ///
- /// Required. The resource name of the Dataset version to delete. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{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`.
+ ///
+ /// The name of the operation resource to be deleted.
public virtual DeleteRequest Delete(string name)
{
return new DeleteRequest(this.service, name);
}
- /// Deletes a Dataset version.
- public class DeleteRequest : AiplatformBaseServiceRequest
+ ///
+ /// Deletes a long-running operation. This method indicates that the client is no longer interested in the
+ /// operation result. It does not cancel the operation. If the server doesn't support this method, it
+ /// returns `google.rpc.Code.UNIMPLEMENTED`.
+ ///
+ public class DeleteRequest : AiplatformBaseServiceRequest
{
/// Constructs a new Delete request.
public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
@@ -637,10 +750,7 @@ public DeleteRequest(Google.Apis.Services.IClientService service, string name) :
InitParameters();
}
- ///
- /// 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.
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
@@ -663,23 +773,26 @@ protected override void InitParameters()
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
- Pattern = @"^datasets/[^/]+/datasetVersions/[^/]+$",
+ Pattern = @"^customJobs/[^/]+/operations/[^/]+$",
});
}
}
- /// Gets a Dataset version.
- ///
- /// Required. The resource name of the Dataset version to delete. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{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.
+ ///
+ /// The name of the operation resource.
public virtual GetRequest Get(string name)
{
return new GetRequest(this.service, name);
}
- /// Gets a Dataset version.
- public class GetRequest : AiplatformBaseServiceRequest
+ ///
+ /// Gets the latest state of a long-running operation. Clients can use this method to poll the operation
+ /// result at intervals as recommended by the API service.
+ ///
+ public class GetRequest : AiplatformBaseServiceRequest
{
/// Constructs a new Get request.
public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
@@ -688,17 +801,10 @@ public GetRequest(Google.Apis.Services.IClientService service, string name) : ba
InitParameters();
}
- ///
- /// 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.
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
- /// Mask specifying which fields to read.
- [Google.Apis.Util.RequestParameterAttribute("readMask", Google.Apis.Util.RequestParameterType.Query)]
- public virtual object ReadMask { get; set; }
-
/// Gets the method name.
public override string MethodName => "get";
@@ -718,68 +824,59 @@ protected override void InitParameters()
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
- Pattern = @"^datasets/[^/]+/datasetVersions/[^/]+$",
- });
- RequestParameters.Add("readMask", new Google.Apis.Discovery.Parameter
- {
- Name = "readMask",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
+ Pattern = @"^customJobs/[^/]+/operations/[^/]+$",
});
}
}
- /// Lists DatasetVersions in a Dataset.
- ///
- /// Required. The resource name of the Dataset to list DatasetVersions from. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}`
- ///
- public virtual ListRequest List(string parent)
+ ///
+ /// Lists operations that match the specified filter in the request. If the server doesn't support this
+ /// method, it returns `UNIMPLEMENTED`.
+ ///
+ /// The name of the operation's parent resource.
+ public virtual ListRequest List(string name)
{
- return new ListRequest(this.service, parent);
+ return new ListRequest(this.service, name);
}
- /// Lists DatasetVersions in a Dataset.
- public class ListRequest : AiplatformBaseServiceRequest
+ ///
+ /// Lists operations that match the specified filter in the request. If the server doesn't support this
+ /// method, it returns `UNIMPLEMENTED`.
+ ///
+ public class ListRequest : AiplatformBaseServiceRequest
{
/// Constructs a new List request.
- public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service)
+ public ListRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
- Parent = parent;
+ Name = name;
InitParameters();
}
- ///
- /// Required. The resource name of the Dataset to list DatasetVersions from. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Parent { get; private set; }
+ /// The name of the operation's parent resource.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Optional. The standard list filter.
+ /// The standard list filter.
[Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
public virtual string Filter { get; set; }
- ///
- /// Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after
- /// a field name for descending.
- ///
- [Google.Apis.Util.RequestParameterAttribute("orderBy", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string OrderBy { get; set; }
-
- /// Optional. The standard list page size.
+ /// The standard list page size.
[Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
public virtual System.Nullable PageSize { get; set; }
- /// Optional. The standard list page token.
+ /// The standard list page token.
[Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
public virtual string PageToken { get; set; }
- /// Optional. Mask specifying which fields to read.
- [Google.Apis.Util.RequestParameterAttribute("readMask", Google.Apis.Util.RequestParameterType.Query)]
- public virtual object ReadMask { get; set; }
+ ///
+ /// When set to `true`, operations that are reachable are returned as normal, and those that are
+ /// unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true`
+ /// when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This
+ /// field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless
+ /// explicitly documented otherwise in service or product specific documentation.
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("returnPartialSuccess", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual System.Nullable ReturnPartialSuccess { get; set; }
/// Gets the method name.
public override string MethodName => "list";
@@ -788,19 +885,19 @@ public ListRequest(Google.Apis.Services.IClientService service, string parent) :
public override string HttpMethod => "GET";
/// Gets the REST path.
- public override string RestPath => "v1/{+parent}/datasetVersions";
+ public override string RestPath => "v1/{+name}/operations";
/// Initializes List parameter list.
protected override void InitParameters()
{
base.InitParameters();
- RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- Name = "parent",
+ Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
- Pattern = @"^datasets/[^/]+$",
+ Pattern = @"^customJobs/[^/]+$",
});
RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
{
@@ -810,14 +907,6 @@ protected override void InitParameters()
DefaultValue = null,
Pattern = null,
});
- RequestParameters.Add("orderBy", new Google.Apis.Discovery.Parameter
- {
- Name = "orderBy",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
{
Name = "pageSize",
@@ -834,9 +923,9 @@ protected override void InitParameters()
DefaultValue = null,
Pattern = null,
});
- RequestParameters.Add("readMask", new Google.Apis.Discovery.Parameter
+ RequestParameters.Add("returnPartialSuccess", new Google.Apis.Discovery.Parameter
{
- Name = "readMask",
+ Name = "returnPartialSuccess",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
@@ -845,58 +934,59 @@ protected override void InitParameters()
}
}
- /// Updates a DatasetVersion.
- /// The body of the request.
- ///
- /// Output only. Identifier. The resource name of the DatasetVersion. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
- ///
- public virtual PatchRequest Patch(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1DatasetVersion body, string 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.
+ ///
+ /// The name of the operation resource to wait on.
+ public virtual WaitRequest Wait(string name)
{
- return new PatchRequest(this.service, body, name);
+ return new WaitRequest(this.service, name);
}
- /// Updates a DatasetVersion.
- public class PatchRequest : AiplatformBaseServiceRequest
+ ///
+ /// Waits until the specified long-running operation is done or reaches at most a specified timeout,
+ /// returning the latest state. If the operation is already done, the latest state is immediately returned.
+ /// If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If
+ /// the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this
+ /// method is on a best-effort basis. It may return the latest state before the specified timeout (including
+ /// immediately), meaning even an immediate response is no guarantee that the operation is done.
+ ///
+ public class WaitRequest : AiplatformBaseServiceRequest
{
- /// Constructs a new Patch request.
- public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1DatasetVersion body, string name) : base(service)
+ /// Constructs a new Wait request.
+ public WaitRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
Name = name;
- Body = body;
InitParameters();
}
- ///
- /// 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.
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
///
- /// Required. The update mask applies to the resource. For the `FieldMask` definition, see
- /// google.protobuf.FieldMask. Updatable fields: * `display_name`
+ /// The maximum duration to wait before timing out. If left blank, the wait will be at most the time
+ /// permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the
+ /// shorter one will be used.
///
- [Google.Apis.Util.RequestParameterAttribute("updateMask", Google.Apis.Util.RequestParameterType.Query)]
- public virtual object UpdateMask { get; set; }
-
- /// Gets or sets the body of this request.
- Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1DatasetVersion Body { get; set; }
-
- /// Returns the body of the request.
- protected override object GetBody() => Body;
+ [Google.Apis.Util.RequestParameterAttribute("timeout", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual object Timeout { get; set; }
/// Gets the method name.
- public override string MethodName => "patch";
+ public override string MethodName => "wait";
/// Gets the HTTP method.
- public override string HttpMethod => "PATCH";
+ public override string HttpMethod => "POST";
/// Gets the REST path.
- public override string RestPath => "v1/{+name}";
+ public override string RestPath => "v1/{+name}:wait";
- /// Initializes Patch parameter list.
+ /// Initializes Wait parameter list.
protected override void InitParameters()
{
base.InitParameters();
@@ -906,11 +996,11 @@ protected override void InitParameters()
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
- Pattern = @"^datasets/[^/]+/datasetVersions/[^/]+$",
+ Pattern = @"^customJobs/[^/]+/operations/[^/]+$",
});
- RequestParameters.Add("updateMask", new Google.Apis.Discovery.Parameter
+ RequestParameters.Add("timeout", new Google.Apis.Discovery.Parameter
{
- Name = "updateMask",
+ Name = "timeout",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
@@ -918,44 +1008,86 @@ protected override void InitParameters()
});
}
}
+ }
+ }
- /// Restores a dataset version.
- ///
- /// Required. The name of the DatasetVersion resource. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
- ///
- public virtual RestoreRequest Restore(string name)
+ /// The "dataLabelingJobs" collection of methods.
+ public class DataLabelingJobsResource
+ {
+ private const string Resource = "dataLabelingJobs";
+
+ /// The service which this resource belongs to.
+ private readonly Google.Apis.Services.IClientService service;
+
+ /// Constructs a new resource.
+ public DataLabelingJobsResource(Google.Apis.Services.IClientService service)
+ {
+ this.service = service;
+ Operations = new OperationsResource(service);
+ }
+
+ /// Gets the Operations resource.
+ public virtual OperationsResource Operations { get; }
+
+ /// The "operations" collection of methods.
+ public class OperationsResource
+ {
+ private const string Resource = "operations";
+
+ /// The service which this resource belongs to.
+ private readonly Google.Apis.Services.IClientService service;
+
+ /// Constructs a new resource.
+ public OperationsResource(Google.Apis.Services.IClientService service)
{
- return new RestoreRequest(this.service, name);
+ this.service = service;
}
- /// Restores a dataset version.
- public class RestoreRequest : AiplatformBaseServiceRequest
+ ///
+ /// Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel
+ /// the operation, but success is not guaranteed. If the server doesn't support this method, it returns
+ /// `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check
+ /// whether the cancellation succeeded or whether the operation completed despite cancellation. On
+ /// successful cancellation, the operation is not deleted; instead, it becomes an operation with an
+ /// Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+ ///
+ /// The name of the operation resource to be cancelled.
+ public virtual CancelRequest Cancel(string name)
{
- /// Constructs a new Restore request.
- public RestoreRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ return new CancelRequest(this.service, name);
+ }
+
+ ///
+ /// Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel
+ /// the operation, but success is not guaranteed. If the server doesn't support this method, it returns
+ /// `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check
+ /// whether the cancellation succeeded or whether the operation completed despite cancellation. On
+ /// successful cancellation, the operation is not deleted; instead, it becomes an operation with an
+ /// Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+ ///
+ public class CancelRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Cancel request.
+ public CancelRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
Name = name;
InitParameters();
}
- ///
- /// Required. The name of the DatasetVersion resource. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
- ///
+ /// The name of the operation resource to be cancelled.
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
/// Gets the method name.
- public override string MethodName => "restore";
+ public override string MethodName => "cancel";
/// Gets the HTTP method.
- public override string HttpMethod => "GET";
+ public override string HttpMethod => "POST";
/// Gets the REST path.
- public override string RestPath => "v1/{+name}:restore";
+ public override string RestPath => "v1/{+name}:cancel";
- /// Initializes Restore parameter list.
+ /// Initializes Cancel parameter list.
protected override void InitParameters()
{
base.InitParameters();
@@ -965,1227 +1097,1155 @@ protected override void InitParameters()
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
- Pattern = @"^datasets/[^/]+/datasetVersions/[^/]+$",
+ Pattern = @"^dataLabelingJobs/[^/]+/operations/[^/]+$",
});
}
}
- }
-
- /// Creates a Dataset.
- /// The body of the request.
- public virtual CreateRequest Create(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1Dataset body)
- {
- return new CreateRequest(this.service, body);
- }
- /// Creates a Dataset.
- public class CreateRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Create request.
- public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1Dataset body) : base(service)
+ ///
+ /// Deletes a long-running operation. This method indicates that the client is no longer interested in the
+ /// operation result. It does not cancel the operation. If the server doesn't support this method, it
+ /// returns `google.rpc.Code.UNIMPLEMENTED`.
+ ///
+ /// The name of the operation resource to be deleted.
+ public virtual DeleteRequest Delete(string name)
{
- Body = body;
- InitParameters();
+ return new DeleteRequest(this.service, name);
}
///
- /// Required. The resource name of the Location to create the Dataset in. Format:
- /// `projects/{project}/locations/{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`.
///
- [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string Parent { get; set; }
-
- /// Gets or sets the body of this request.
- Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1Dataset Body { get; set; }
+ public class DeleteRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Delete request.
+ public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// Returns the body of the request.
- protected override object GetBody() => Body;
+ /// The name of the operation resource to be deleted.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Gets the method name.
- public override string MethodName => "create";
+ /// Gets the method name.
+ public override string MethodName => "delete";
- /// Gets the HTTP method.
- public override string HttpMethod => "POST";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "DELETE";
- /// Gets the REST path.
- public override string RestPath => "v1/datasets";
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}";
- /// Initializes Create parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
+ /// Initializes Delete parameter list.
+ protected override void InitParameters()
{
- Name = "parent",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
+ {
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^dataLabelingJobs/[^/]+/operations/[^/]+$",
+ });
+ }
}
- }
-
- /// Deletes a Dataset.
- ///
- /// Required. The resource name of the Dataset to delete. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}`
- ///
- public virtual DeleteRequest Delete(string name)
- {
- return new DeleteRequest(this.service, name);
- }
- /// Deletes a Dataset.
- public class DeleteRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Delete request.
- public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ ///
+ /// Gets the latest 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.
+ public virtual GetRequest Get(string name)
{
- Name = name;
- InitParameters();
+ return new GetRequest(this.service, name);
}
///
- /// Required. The resource name of the Dataset to delete. Format:
- /// `projects/{project}/locations/{location}/datasets/{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.
///
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
-
- /// Gets the method name.
- public override string MethodName => "delete";
-
- /// Gets the HTTP method.
- public override string HttpMethod => "DELETE";
-
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}";
-
- /// Initializes Delete parameter list.
- protected override void InitParameters()
+ public class GetRequest : AiplatformBaseServiceRequest
{
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
+ /// Constructs a new Get request.
+ public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^datasets/[^/]+$",
- });
- }
- }
-
- /// Gets a Dataset.
- /// Required. The name of the Dataset resource.
- public virtual GetRequest Get(string name)
- {
- return new GetRequest(this.service, name);
- }
-
- /// Gets a Dataset.
- public class GetRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Get request.
- public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
-
- /// Required. The name of the Dataset resource.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ Name = name;
+ InitParameters();
+ }
- /// Mask specifying which fields to read.
- [Google.Apis.Util.RequestParameterAttribute("readMask", Google.Apis.Util.RequestParameterType.Query)]
- public virtual object ReadMask { get; set; }
+ /// The name of the operation resource.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Gets the method name.
- public override string MethodName => "get";
+ /// Gets the method name.
+ public override string MethodName => "get";
- /// Gets the HTTP method.
- public override string HttpMethod => "GET";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "GET";
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}";
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}";
- /// Initializes Get parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^datasets/[^/]+$",
- });
- RequestParameters.Add("readMask", new Google.Apis.Discovery.Parameter
+ /// Initializes Get parameter list.
+ protected override void InitParameters()
{
- Name = "readMask",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
+ {
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^dataLabelingJobs/[^/]+/operations/[^/]+$",
+ });
+ }
}
- }
-
- /// Lists Datasets in a Location.
- public virtual ListRequest List()
- {
- return new ListRequest(this.service);
- }
- /// Lists Datasets in a Location.
- public class ListRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new List request.
- public ListRequest(Google.Apis.Services.IClientService service) : base(service)
+ ///
+ /// Lists operations that match the specified filter in the request. If the server doesn't support this
+ /// method, it returns `UNIMPLEMENTED`.
+ ///
+ /// The name of the operation's parent resource.
+ public virtual ListRequest List(string name)
{
- InitParameters();
+ return new ListRequest(this.service, name);
}
///
- /// 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"`
+ /// Lists operations that match the specified filter in the request. If the server doesn't support this
+ /// method, it returns `UNIMPLEMENTED`.
///
- [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string Filter { get; set; }
+ public class ListRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new List request.
+ public ListRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- ///
- /// 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`
- ///
- [Google.Apis.Util.RequestParameterAttribute("orderBy", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string OrderBy { get; set; }
+ /// The name of the operation's parent resource.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// The standard list page size.
- [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
- public virtual System.Nullable PageSize { get; set; }
+ /// The standard list filter.
+ [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string Filter { get; set; }
- /// The standard list page token.
- [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string PageToken { get; set; }
+ /// The standard list page size.
+ [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual System.Nullable PageSize { get; set; }
- ///
- /// Required. The name of the Dataset's parent resource. Format: `projects/{project}/locations/{location}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string Parent { get; set; }
+ /// The standard list page token.
+ [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string PageToken { get; set; }
- /// Mask specifying which fields to read.
- [Google.Apis.Util.RequestParameterAttribute("readMask", Google.Apis.Util.RequestParameterType.Query)]
- public virtual object ReadMask { get; set; }
+ ///
+ /// When set to `true`, operations that are reachable are returned as normal, and those that are
+ /// unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true`
+ /// when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This
+ /// field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless
+ /// explicitly documented otherwise in service or product specific documentation.
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("returnPartialSuccess", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual System.Nullable ReturnPartialSuccess { get; set; }
- /// Gets the method name.
- public override string MethodName => "list";
+ /// Gets the method name.
+ public override string MethodName => "list";
- /// Gets the HTTP method.
- public override string HttpMethod => "GET";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "GET";
- /// Gets the REST path.
- public override string RestPath => "v1/datasets";
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}/operations";
- /// Initializes List parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
- {
- Name = "filter",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("orderBy", new Google.Apis.Discovery.Parameter
- {
- Name = "orderBy",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
- {
- Name = "pageSize",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
- {
- Name = "pageToken",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
- {
- Name = "parent",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("readMask", new Google.Apis.Discovery.Parameter
+ /// Initializes List parameter list.
+ protected override void InitParameters()
{
- Name = "readMask",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- }
- }
-
- /// Updates a Dataset.
- /// The body of the request.
- ///
- /// Output only. Identifier. The resource name of the Dataset. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}`
- ///
- public virtual PatchRequest Patch(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1Dataset body, string name)
- {
- return new PatchRequest(this.service, body, name);
- }
-
- /// Updates a Dataset.
- public class PatchRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Patch request.
- public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1Dataset body, string name) : base(service)
- {
- Name = name;
- Body = body;
- InitParameters();
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
+ {
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^dataLabelingJobs/[^/]+$",
+ });
+ RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
+ {
+ Name = "filter",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
+ {
+ Name = "pageSize",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
+ {
+ Name = "pageToken",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("returnPartialSuccess", new Google.Apis.Discovery.Parameter
+ {
+ Name = "returnPartialSuccess",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ }
}
///
- /// Output only. Identifier. The resource name of the Dataset. Format:
- /// `projects/{project}/locations/{location}/datasets/{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.
///
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ /// The name of the operation resource to wait on.
+ public virtual WaitRequest Wait(string name)
+ {
+ return new WaitRequest(this.service, name);
+ }
///
- /// Required. The update mask applies to the resource. For the `FieldMask` definition, see
- /// google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels`
+ /// Waits until the specified long-running operation is done or reaches at most a specified timeout,
+ /// returning the latest state. If the operation is already done, the latest state is immediately returned.
+ /// If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If
+ /// the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this
+ /// method is on a best-effort basis. It may return the latest state before the specified timeout (including
+ /// immediately), meaning even an immediate response is no guarantee that the operation is done.
///
- [Google.Apis.Util.RequestParameterAttribute("updateMask", Google.Apis.Util.RequestParameterType.Query)]
- public virtual object UpdateMask { get; set; }
+ public class WaitRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Wait request.
+ public WaitRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// Gets or sets the body of this request.
- Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1Dataset Body { get; set; }
+ /// The name of the operation resource to wait on.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Returns the body of the request.
- protected override object GetBody() => Body;
+ ///
+ /// The maximum duration to wait before timing out. If left blank, the wait will be at most the time
+ /// permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the
+ /// shorter one will be used.
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("timeout", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual object Timeout { get; set; }
- /// Gets the method name.
- public override string MethodName => "patch";
+ /// Gets the method name.
+ public override string MethodName => "wait";
- /// Gets the HTTP method.
- public override string HttpMethod => "PATCH";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "POST";
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}";
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}:wait";
- /// Initializes Patch parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^datasets/[^/]+$",
- });
- RequestParameters.Add("updateMask", new Google.Apis.Discovery.Parameter
+ /// Initializes Wait parameter list.
+ protected override void InitParameters()
{
- Name = "updateMask",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
+ {
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^dataLabelingJobs/[^/]+/operations/[^/]+$",
+ });
+ RequestParameters.Add("timeout", new Google.Apis.Discovery.Parameter
+ {
+ Name = "timeout",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ }
}
}
}
- /// The "endpoints" collection of methods.
- public class EndpointsResource
+ /// The "datasets" collection of methods.
+ public class DatasetsResource
{
- private const string Resource = "endpoints";
+ private const string Resource = "datasets";
/// The service which this resource belongs to.
private readonly Google.Apis.Services.IClientService service;
/// Constructs a new resource.
- public EndpointsResource(Google.Apis.Services.IClientService service)
+ public DatasetsResource(Google.Apis.Services.IClientService service)
{
this.service = service;
- Chat = new ChatResource(service);
+ AnnotationSpecs = new AnnotationSpecsResource(service);
+ DataItems = new DataItemsResource(service);
+ DatasetVersions = new DatasetVersionsResource(service);
+ Operations = new OperationsResource(service);
+ SavedQueries = new SavedQueriesResource(service);
}
- /// Gets the Chat resource.
- public virtual ChatResource Chat { get; }
+ /// Gets the AnnotationSpecs resource.
+ public virtual AnnotationSpecsResource AnnotationSpecs { get; }
- /// The "chat" collection of methods.
- public class ChatResource
+ /// The "annotationSpecs" collection of methods.
+ public class AnnotationSpecsResource
{
- private const string Resource = "chat";
+ private const string Resource = "annotationSpecs";
/// The service which this resource belongs to.
private readonly Google.Apis.Services.IClientService service;
/// Constructs a new resource.
- public ChatResource(Google.Apis.Services.IClientService service)
+ public AnnotationSpecsResource(Google.Apis.Services.IClientService service)
{
this.service = service;
+ Operations = new OperationsResource(service);
}
- /// Exposes an OpenAI-compatible endpoint for chat completions.
- /// The body of the request.
- ///
- /// Required. The name of the endpoint requested to serve the prediction. Format:
- /// `projects/{project}/locations/{location}/endpoints/{endpoint}`
- ///
- public virtual CompletionsRequest Completions(Google.Apis.Aiplatform.v1.Data.GoogleApiHttpBody body, string endpoint)
- {
- return new CompletionsRequest(this.service, body, endpoint);
- }
+ /// Gets the Operations resource.
+ public virtual OperationsResource Operations { get; }
- /// Exposes an OpenAI-compatible endpoint for chat completions.
- public class CompletionsRequest : AiplatformBaseServiceRequest
+ /// The "operations" collection of methods.
+ public class OperationsResource
{
- /// Constructs a new Completions request.
- public CompletionsRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleApiHttpBody body, string endpoint) : base(service)
+ private const string Resource = "operations";
+
+ /// The service which this resource belongs to.
+ private readonly Google.Apis.Services.IClientService service;
+
+ /// Constructs a new resource.
+ public OperationsResource(Google.Apis.Services.IClientService service)
{
- Endpoint = endpoint;
- Body = body;
- InitParameters();
+ this.service = service;
}
///
- /// Required. The name of the endpoint requested to serve the prediction. Format:
- /// `projects/{project}/locations/{location}/endpoints/{endpoint}`
+ /// Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
+ /// cancel the operation, but success is not guaranteed. If the server doesn't support this method, it
+ /// returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to
+ /// check whether the cancellation succeeded or whether the operation completed despite cancellation. On
+ /// successful cancellation, the operation is not deleted; instead, it becomes an operation with an
+ /// Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
///
- [Google.Apis.Util.RequestParameterAttribute("endpoint", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Endpoint { get; private set; }
+ /// The name of the operation resource to be cancelled.
+ public virtual CancelRequest Cancel(string name)
+ {
+ return new CancelRequest(this.service, name);
+ }
- /// Gets or sets the body of this request.
- Google.Apis.Aiplatform.v1.Data.GoogleApiHttpBody Body { get; 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`.
+ ///
+ public class CancelRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Cancel request.
+ public CancelRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// Returns the body of the request.
- protected override object GetBody() => Body;
+ /// The name of the operation resource to be cancelled.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Gets the method name.
- public override string MethodName => "completions";
+ /// Gets the method name.
+ public override string MethodName => "cancel";
- /// Gets the HTTP method.
- public override string HttpMethod => "POST";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "POST";
- /// Gets the REST path.
- public override string RestPath => "v1/{+endpoint}/chat/completions";
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}:cancel";
- /// Initializes Completions parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("endpoint", new Google.Apis.Discovery.Parameter
+ /// Initializes Cancel parameter list.
+ protected override void InitParameters()
{
- Name = "endpoint",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^endpoints/[^/]+$",
- });
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
+ {
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$",
+ });
+ }
}
- }
- }
- /// Return a list of tokens based on the input text.
- /// The body of the request.
- ///
- /// Required. The name of the Endpoint requested to get lists of tokens and token ids.
- ///
- public virtual ComputeTokensRequest ComputeTokens(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1ComputeTokensRequest body, string endpoint)
- {
- return new ComputeTokensRequest(this.service, body, endpoint);
- }
+ ///
+ /// Deletes a long-running operation. This method indicates that the client is no longer interested in
+ /// the operation result. It does not cancel the operation. If the server doesn't support this method,
+ /// it returns `google.rpc.Code.UNIMPLEMENTED`.
+ ///
+ /// The name of the operation resource to be deleted.
+ public virtual DeleteRequest Delete(string name)
+ {
+ return new DeleteRequest(this.service, name);
+ }
- /// Return a list of tokens based on the input text.
- public class ComputeTokensRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new ComputeTokens request.
- public ComputeTokensRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1ComputeTokensRequest body, string endpoint) : base(service)
- {
- Endpoint = endpoint;
- Body = body;
- InitParameters();
- }
+ ///
+ /// Deletes a long-running operation. This method indicates that the client is no longer interested in
+ /// the operation result. It does not cancel the operation. If the server doesn't support this method,
+ /// it returns `google.rpc.Code.UNIMPLEMENTED`.
+ ///
+ public class DeleteRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Delete request.
+ public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// Required. The name of the Endpoint requested to get lists of tokens and token ids.
- [Google.Apis.Util.RequestParameterAttribute("endpoint", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Endpoint { get; private set; }
+ /// The name of the operation resource to be deleted.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Gets or sets the body of this request.
- Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1ComputeTokensRequest Body { get; set; }
+ /// Gets the method name.
+ public override string MethodName => "delete";
- /// Returns the body of the request.
- protected override object GetBody() => Body;
+ /// Gets the HTTP method.
+ public override string HttpMethod => "DELETE";
- /// Gets the method name.
- public override string MethodName => "computeTokens";
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}";
- /// Gets the HTTP method.
- public override string HttpMethod => "POST";
+ /// Initializes Delete parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
+ {
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$",
+ });
+ }
+ }
- /// Gets the REST path.
- public override string RestPath => "v1/{+endpoint}:computeTokens";
+ ///
+ /// Gets the latest 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.
+ public virtual GetRequest Get(string name)
+ {
+ return new GetRequest(this.service, name);
+ }
- /// Initializes ComputeTokens parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("endpoint", new Google.Apis.Discovery.Parameter
+ ///
+ /// Gets the latest state of a long-running operation. Clients can use this method to poll the operation
+ /// result at intervals as recommended by the API service.
+ ///
+ public class GetRequest : AiplatformBaseServiceRequest
{
- Name = "endpoint",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^endpoints/[^/]+$",
- });
- }
- }
+ /// Constructs a new Get request.
+ public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// Perform a token counting.
- /// The body of the request.
- ///
- /// Required. The name of the Endpoint requested to perform token counting. Format:
- /// `projects/{project}/locations/{location}/endpoints/{endpoint}`
- ///
- public virtual CountTokensRequest CountTokens(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1CountTokensRequest body, string endpoint)
- {
- return new CountTokensRequest(this.service, body, endpoint);
- }
+ /// The name of the operation resource.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Perform a token counting.
- public class CountTokensRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new CountTokens request.
- public CountTokensRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1CountTokensRequest body, string endpoint) : base(service)
- {
- Endpoint = endpoint;
- Body = body;
- InitParameters();
- }
+ /// Gets the method name.
+ public override string MethodName => "get";
- ///
- /// Required. The name of the Endpoint requested to perform token counting. Format:
- /// `projects/{project}/locations/{location}/endpoints/{endpoint}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("endpoint", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Endpoint { get; private set; }
+ /// Gets the HTTP method.
+ public override string HttpMethod => "GET";
- /// Gets or sets the body of this request.
- Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1CountTokensRequest Body { get; set; }
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}";
- /// Returns the body of the request.
- protected override object GetBody() => Body;
+ /// Initializes Get parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
+ {
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$",
+ });
+ }
+ }
- /// Gets the method name.
- public override string MethodName => "countTokens";
+ ///
+ /// Lists operations that match the specified filter in the request. If the server doesn't support this
+ /// method, it returns `UNIMPLEMENTED`.
+ ///
+ /// The name of the operation's parent resource.
+ public virtual ListRequest List(string name)
+ {
+ return new ListRequest(this.service, name);
+ }
- /// Gets the HTTP method.
- public override string HttpMethod => "POST";
+ ///
+ /// Lists operations that match the specified filter in the request. If the server doesn't support this
+ /// method, it returns `UNIMPLEMENTED`.
+ ///
+ public class ListRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new List request.
+ public ListRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// Gets the REST path.
- public override string RestPath => "v1/{+endpoint}:countTokens";
-
- /// Initializes CountTokens parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("endpoint", new Google.Apis.Discovery.Parameter
- {
- Name = "endpoint",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^endpoints/[^/]+$",
- });
- }
- }
+ /// The name of the operation's parent resource.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Fetch an asynchronous online prediction operation.
- /// The body of the request.
- ///
- /// 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}`
- ///
- public virtual FetchPredictOperationRequest FetchPredictOperation(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1FetchPredictOperationRequest body, string endpoint)
- {
- return new FetchPredictOperationRequest(this.service, body, endpoint);
- }
+ /// The standard list filter.
+ [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string Filter { get; set; }
- /// Fetch an asynchronous online prediction operation.
- public class FetchPredictOperationRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new FetchPredictOperation request.
- public FetchPredictOperationRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1FetchPredictOperationRequest body, string endpoint) : base(service)
- {
- Endpoint = endpoint;
- Body = body;
- InitParameters();
- }
+ /// The standard list page size.
+ [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual System.Nullable PageSize { get; set; }
- ///
- /// 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}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("endpoint", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Endpoint { get; private set; }
+ /// The standard list page token.
+ [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string PageToken { get; set; }
- /// Gets or sets the body of this request.
- Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1FetchPredictOperationRequest Body { get; set; }
+ ///
+ /// When set to `true`, operations that are reachable are returned as normal, and those that are
+ /// unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be
+ /// `true` when reading across collections e.g. when `parent` is set to
+ /// `"projects/example/locations/-"`. This field is not by default supported and will result in an
+ /// `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product
+ /// specific documentation.
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("returnPartialSuccess", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual System.Nullable ReturnPartialSuccess { get; set; }
- /// Returns the body of the request.
- protected override object GetBody() => Body;
+ /// Gets the method name.
+ public override string MethodName => "list";
- /// Gets the method name.
- public override string MethodName => "fetchPredictOperation";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "GET";
- /// Gets the HTTP method.
- public override string HttpMethod => "POST";
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}/operations";
- /// Gets the REST path.
- public override string RestPath => "v1/{+endpoint}:fetchPredictOperation";
+ /// Initializes List parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
+ {
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^datasets/[^/]+/annotationSpecs/[^/]+$",
+ });
+ RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
+ {
+ Name = "filter",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
+ {
+ Name = "pageSize",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
+ {
+ Name = "pageToken",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("returnPartialSuccess", new Google.Apis.Discovery.Parameter
+ {
+ Name = "returnPartialSuccess",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ }
+ }
- /// Initializes FetchPredictOperation parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("endpoint", new Google.Apis.Discovery.Parameter
+ ///
+ /// Waits until the specified long-running operation is done or reaches at most a specified timeout,
+ /// returning the latest state. If the operation is already done, the latest state is immediately
+ /// returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
+ /// timeout is used. If the server does not support this method, it returns
+ /// `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the
+ /// latest state before the specified timeout (including immediately), meaning even an immediate
+ /// response is no guarantee that the operation is done.
+ ///
+ /// The name of the operation resource to wait on.
+ public virtual WaitRequest Wait(string name)
{
- Name = "endpoint",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^endpoints/[^/]+$",
- });
- }
- }
-
- /// Generate content with multimodal inputs.
- /// The body of the request.
- ///
- /// 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}`
- ///
- public virtual GenerateContentRequest GenerateContent(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1GenerateContentRequest body, string model)
- {
- return new GenerateContentRequest(this.service, body, model);
- }
-
- /// Generate content with multimodal inputs.
- public class GenerateContentRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new GenerateContent request.
- public GenerateContentRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1GenerateContentRequest body, string model) : base(service)
- {
- Model = model;
- Body = body;
- InitParameters();
- }
+ return new WaitRequest(this.service, name);
+ }
- ///
- /// 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}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("model", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Model { get; private 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.
+ ///
+ public class WaitRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Wait request.
+ public WaitRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// Gets or sets the body of this request.
- Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1GenerateContentRequest Body { get; set; }
+ /// The name of the operation resource to wait on.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Returns the body of the request.
- protected override object GetBody() => Body;
+ ///
+ /// The maximum duration to wait before timing out. If left blank, the wait will be at most the time
+ /// permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the
+ /// shorter one will be used.
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("timeout", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual object Timeout { get; set; }
- /// Gets the method name.
- public override string MethodName => "generateContent";
+ /// Gets the method name.
+ public override string MethodName => "wait";
- /// Gets the HTTP method.
- public override string HttpMethod => "POST";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "POST";
- /// Gets the REST path.
- public override string RestPath => "v1/{+model}:generateContent";
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}:wait";
- /// Initializes GenerateContent parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("model", new Google.Apis.Discovery.Parameter
- {
- Name = "model",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^endpoints/[^/]+$",
- });
+ /// Initializes Wait parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
+ {
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$",
+ });
+ RequestParameters.Add("timeout", new Google.Apis.Discovery.Parameter
+ {
+ Name = "timeout",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ }
+ }
}
}
- /// Perform an online prediction.
- /// The body of the request.
- ///
- /// Required. The name of the Endpoint requested to serve the prediction. Format:
- /// `projects/{project}/locations/{location}/endpoints/{endpoint}`
- ///
- public virtual PredictRequest Predict(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1PredictRequest body, string endpoint)
- {
- return new PredictRequest(this.service, body, endpoint);
- }
+ /// Gets the DataItems resource.
+ public virtual DataItemsResource DataItems { get; }
- /// Perform an online prediction.
- public class PredictRequest : AiplatformBaseServiceRequest
+ /// The "dataItems" collection of methods.
+ public class DataItemsResource
{
- /// Constructs a new Predict request.
- public PredictRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1PredictRequest body, string endpoint) : base(service)
- {
- Endpoint = endpoint;
- Body = body;
- InitParameters();
- }
-
- ///
- /// Required. The name of the Endpoint requested to serve the prediction. Format:
- /// `projects/{project}/locations/{location}/endpoints/{endpoint}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("endpoint", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Endpoint { get; private set; }
+ private const string Resource = "dataItems";
- /// Gets or sets the body of this request.
- Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1PredictRequest Body { get; set; }
+ /// The service which this resource belongs to.
+ private readonly Google.Apis.Services.IClientService service;
- /// Returns the body of the request.
- protected override object GetBody() => Body;
+ /// Constructs a new resource.
+ public DataItemsResource(Google.Apis.Services.IClientService service)
+ {
+ this.service = service;
+ Annotations = new AnnotationsResource(service);
+ Operations = new OperationsResource(service);
+ }
- /// Gets the method name.
- public override string MethodName => "predict";
+ /// Gets the Annotations resource.
+ public virtual AnnotationsResource Annotations { get; }
- /// Gets the HTTP method.
- public override string HttpMethod => "POST";
+ /// The "annotations" collection of methods.
+ public class AnnotationsResource
+ {
+ private const string Resource = "annotations";
- /// Gets the REST path.
- public override string RestPath => "v1/{+endpoint}:predict";
+ /// The service which this resource belongs to.
+ private readonly Google.Apis.Services.IClientService service;
- /// Initializes Predict parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("endpoint", new Google.Apis.Discovery.Parameter
+ /// Constructs a new resource.
+ public AnnotationsResource(Google.Apis.Services.IClientService service)
{
- Name = "endpoint",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^endpoints/[^/]+$",
- });
- }
- }
+ this.service = service;
+ Operations = new OperationsResource(service);
+ }
- ///
- /// The body of the request.
- ///
- /// 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}`
- ///
- public virtual PredictLongRunningRequest PredictLongRunning(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1PredictLongRunningRequest body, string endpoint)
- {
- return new PredictLongRunningRequest(this.service, body, endpoint);
- }
+ /// Gets the Operations resource.
+ public virtual OperationsResource Operations { get; }
- ///
- public class PredictLongRunningRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new PredictLongRunning request.
- public PredictLongRunningRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1PredictLongRunningRequest body, string endpoint) : base(service)
- {
- Endpoint = endpoint;
- Body = body;
- InitParameters();
- }
+ /// The "operations" collection of methods.
+ public class OperationsResource
+ {
+ private const string Resource = "operations";
- ///
- /// 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}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("endpoint", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Endpoint { get; private set; }
+ /// The service which this resource belongs to.
+ private readonly Google.Apis.Services.IClientService service;
- /// Gets or sets the body of this request.
- Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1PredictLongRunningRequest Body { get; set; }
+ /// Constructs a new resource.
+ public OperationsResource(Google.Apis.Services.IClientService service)
+ {
+ this.service = service;
+ }
- /// Returns the body of the request.
- protected override object GetBody() => Body;
+ ///
+ /// Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
+ /// cancel the operation, but success is not guaranteed. If the server doesn't support this method,
+ /// it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other
+ /// methods to check whether the cancellation succeeded or whether the operation completed despite
+ /// cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
+ /// operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to
+ /// `Code.CANCELLED`.
+ ///
+ /// The name of the operation resource to be cancelled.
+ public virtual CancelRequest Cancel(string name)
+ {
+ return new CancelRequest(this.service, name);
+ }
- /// Gets the method name.
- public override string MethodName => "predictLongRunning";
+ ///
+ /// Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
+ /// cancel the operation, but success is not guaranteed. If the server doesn't support this method,
+ /// it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other
+ /// methods to check whether the cancellation succeeded or whether the operation completed despite
+ /// cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
+ /// operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to
+ /// `Code.CANCELLED`.
+ ///
+ public class CancelRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Cancel request.
+ public CancelRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// Gets the HTTP method.
- public override string HttpMethod => "POST";
+ /// The name of the operation resource to be cancelled.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Gets the REST path.
- public override string RestPath => "v1/{+endpoint}:predictLongRunning";
+ /// Gets the method name.
+ public override string MethodName => "cancel";
- /// Initializes PredictLongRunning parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("endpoint", new Google.Apis.Discovery.Parameter
- {
- Name = "endpoint",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^endpoints/[^/]+$",
- });
- }
- }
+ /// Gets the HTTP method.
+ public override string HttpMethod => "POST";
- /// Generate content with multimodal inputs with streaming support.
- /// The body of the request.
- ///
- /// 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}`
- ///
- public virtual StreamGenerateContentRequest StreamGenerateContent(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1GenerateContentRequest body, string model)
- {
- return new StreamGenerateContentRequest(this.service, body, model);
- }
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}:cancel";
- /// Generate content with multimodal inputs with streaming support.
- public class StreamGenerateContentRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new StreamGenerateContent request.
- public StreamGenerateContentRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1GenerateContentRequest body, string model) : base(service)
- {
- Model = model;
- Body = body;
- InitParameters();
- }
+ /// Initializes Cancel parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
+ {
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$",
+ });
+ }
+ }
- ///
- /// 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}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("model", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Model { get; private 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`.
+ ///
+ /// The name of the operation resource to be deleted.
+ public virtual DeleteRequest Delete(string name)
+ {
+ return new DeleteRequest(this.service, name);
+ }
- /// Gets or sets the body of this request.
- Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1GenerateContentRequest Body { get; 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`.
+ ///
+ public class DeleteRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Delete request.
+ public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// Returns the body of the request.
- protected override object GetBody() => Body;
+ /// The name of the operation resource to be deleted.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Gets the method name.
- public override string MethodName => "streamGenerateContent";
+ /// Gets the method name.
+ public override string MethodName => "delete";
- /// Gets the HTTP method.
- public override string HttpMethod => "POST";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "DELETE";
- /// Gets the REST path.
- public override string RestPath => "v1/{+model}:streamGenerateContent";
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}";
- /// Initializes StreamGenerateContent parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("model", new Google.Apis.Discovery.Parameter
- {
- Name = "model",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^endpoints/[^/]+$",
- });
- }
- }
- }
-
- /// The "media" collection of methods.
- public class MediaResource
- {
- private const string Resource = "media";
-
- /// The service which this resource belongs to.
- private readonly Google.Apis.Services.IClientService service;
-
- /// Constructs a new resource.
- public MediaResource(Google.Apis.Services.IClientService service)
- {
- this.service = service;
- }
-
- /// Upload a file into a RagCorpus.
- /// The body of the request.
- ///
- /// Required. The name of the RagCorpus resource into which to upload the file. Format:
- /// `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
- ///
- public virtual UploadRequest Upload(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1UploadRagFileRequest body, string parent)
- {
- return new UploadRequest(this.service, body, parent);
- }
-
- /// Upload a file into a RagCorpus.
- public class UploadRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Upload request.
- public UploadRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1UploadRagFileRequest body, string parent) : base(service)
- {
- Parent = parent;
- Body = body;
- InitParameters();
- }
-
- ///
- /// Required. The name of the RagCorpus resource into which to upload the file. Format:
- /// `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Parent { get; private set; }
-
- /// Gets or sets the body of this request.
- Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1UploadRagFileRequest Body { get; set; }
-
- /// Returns the body of the request.
- protected override object GetBody() => Body;
-
- /// Gets the method name.
- public override string MethodName => "upload";
-
- /// Gets the HTTP method.
- public override string HttpMethod => "POST";
-
- /// Gets the REST path.
- public override string RestPath => "v1/{+parent}/ragFiles:upload";
-
- /// Initializes Upload parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
- {
- Name = "parent",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$",
- });
- }
- }
+ /// Initializes Delete parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
+ {
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$",
+ });
+ }
+ }
- /// Upload a file into a RagCorpus.
- ///
- /// Considerations regarding :
- ///
- /// -
- ///
- /// If is seekable, then the stream position will be reset to 0 before reading
- /// commences. If is not seekable, then it will be read from its current position
- ///
- ///
- /// -
- ///
- /// Caller is responsible for maintaining the open until the upload is completed
- ///
- ///
- /// - Caller is responsible for closing the
- ///
- ///
- /// The body of the request.
- ///
- /// Required. The name of the RagCorpus resource into which to upload the file. Format:
- /// `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
- ///
- /// The stream to upload. See remarks for further information.
- /// The content type of the stream to upload.
- public virtual UploadMediaUpload Upload(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1UploadRagFileRequest body, string parent, System.IO.Stream stream, string contentType)
- {
- return new UploadMediaUpload(service, body, parent, stream, contentType);
- }
+ ///
+ /// Gets the latest 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.
+ public virtual GetRequest Get(string name)
+ {
+ return new GetRequest(this.service, name);
+ }
- /// Upload media upload which supports resumable upload.
- public class UploadMediaUpload : Google.Apis.Upload.ResumableUpload
- {
- /// V1 error format.
- [Google.Apis.Util.RequestParameterAttribute("$.xgafv", Google.Apis.Util.RequestParameterType.Query)]
- public virtual System.Nullable Xgafv { get; 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.
+ ///
+ public class GetRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Get request.
+ public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// V1 error format.
- public enum XgafvEnum
- {
- /// v1 error format
- [Google.Apis.Util.StringValueAttribute("1")]
- Value1 = 0,
+ /// The name of the operation resource.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// v2 error format
- [Google.Apis.Util.StringValueAttribute("2")]
- Value2 = 1,
- }
+ /// Gets the method name.
+ public override string MethodName => "get";
- /// OAuth access token.
- [Google.Apis.Util.RequestParameterAttribute("access_token", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string AccessToken { get; set; }
+ /// Gets the HTTP method.
+ public override string HttpMethod => "GET";
- /// Data format for response.
- [Google.Apis.Util.RequestParameterAttribute("alt", Google.Apis.Util.RequestParameterType.Query)]
- public virtual System.Nullable Alt { get; set; }
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}";
- /// Data format for response.
- public enum AltEnum
- {
- /// Responses with Content-Type of application/json
- [Google.Apis.Util.StringValueAttribute("json")]
- Json = 0,
+ /// Initializes Get parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
+ {
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$",
+ });
+ }
+ }
- /// Media download with context-dependent Content-Type
- [Google.Apis.Util.StringValueAttribute("media")]
- Media = 1,
+ ///
+ /// Lists operations that match the specified filter in the request. If the server doesn't support
+ /// this method, it returns `UNIMPLEMENTED`.
+ ///
+ /// The name of the operation's parent resource.
+ public virtual ListRequest List(string name)
+ {
+ return new ListRequest(this.service, name);
+ }
- /// Responses with Content-Type of application/x-protobuf
- [Google.Apis.Util.StringValueAttribute("proto")]
- Proto = 2,
- }
+ ///
+ /// Lists operations that match the specified filter in the request. If the server doesn't support
+ /// this method, it returns `UNIMPLEMENTED`.
+ ///
+ public class ListRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new List request.
+ public ListRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// JSONP
- [Google.Apis.Util.RequestParameterAttribute("callback", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string Callback { get; set; }
+ /// The name of the operation's parent resource.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Selector specifying which fields to include in a partial response.
- [Google.Apis.Util.RequestParameterAttribute("fields", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string Fields { get; set; }
+ /// The standard list filter.
+ [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string Filter { get; set; }
- ///
- /// 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.
- ///
- [Google.Apis.Util.RequestParameterAttribute("key", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string Key { get; set; }
+ /// The standard list page size.
+ [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual System.Nullable PageSize { get; set; }
- /// OAuth 2.0 token for the current user.
- [Google.Apis.Util.RequestParameterAttribute("oauth_token", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string OauthToken { get; set; }
+ /// The standard list page token.
+ [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string PageToken { get; set; }
- /// Returns response with indentations and line breaks.
- [Google.Apis.Util.RequestParameterAttribute("prettyPrint", Google.Apis.Util.RequestParameterType.Query)]
- public virtual System.Nullable PrettyPrint { get; set; }
+ ///
+ /// When set to `true`, operations that are reachable are returned as normal, and those that are
+ /// unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be
+ /// `true` when reading across collections e.g. when `parent` is set to
+ /// `"projects/example/locations/-"`. This field is not by default supported and will result in
+ /// an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product
+ /// specific documentation.
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("returnPartialSuccess", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual System.Nullable ReturnPartialSuccess { get; set; }
- ///
- /// 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.
- ///
- [Google.Apis.Util.RequestParameterAttribute("quotaUser", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string QuotaUser { get; set; }
+ /// Gets the method name.
+ public override string MethodName => "list";
- /// Legacy upload protocol for media (e.g. "media", "multipart").
- [Google.Apis.Util.RequestParameterAttribute("uploadType", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string UploadType { get; set; }
+ /// Gets the HTTP method.
+ public override string HttpMethod => "GET";
- /// Upload protocol for media (e.g. "raw", "multipart").
- [Google.Apis.Util.RequestParameterAttribute("upload_protocol", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string UploadProtocol { get; set; }
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}/operations";
- ///
- /// Required. The name of the RagCorpus resource into which to upload the file. Format:
- /// `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Parent { get; private set; }
+ /// Initializes List parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
+ {
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+$",
+ });
+ RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
+ {
+ Name = "filter",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
+ {
+ Name = "pageSize",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
+ {
+ Name = "pageToken",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("returnPartialSuccess", new Google.Apis.Discovery.Parameter
+ {
+ Name = "returnPartialSuccess",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ }
+ }
- /// Constructs a new Upload media upload instance.
- ///
- /// Considerations regarding :
- ///
- /// -
- ///
- /// If is seekable, then the stream position will be reset to 0 before
- /// reading commences. If is not seekable, then it will be read from its current
- /// position
- ///
- ///
- /// -
- ///
- /// Caller is responsible for maintaining the open until the upload is completed
- ///
- ///
- /// - Caller is responsible for closing the
- ///
- ///
- public UploadMediaUpload(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1UploadRagFileRequest body, string parent, System.IO.Stream stream, string contentType)
- : base(service, string.Format("/{0}/{1}{2}", "upload", service.BasePath, "v1/{+parent}/ragFiles:upload"), "POST", stream, contentType)
- {
- Parent = parent;
- Body = body;
- }
- }
- }
+ ///
+ /// Waits until the specified long-running operation is done or reaches at most a specified timeout,
+ /// returning the latest state. If the operation is already done, the latest state is immediately
+ /// returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
+ /// timeout is used. If the server does not support this method, it returns
+ /// `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return
+ /// the latest state before the specified timeout (including immediately), meaning even an immediate
+ /// response is no guarantee that the operation is done.
+ ///
+ /// The name of the operation resource to wait on.
+ public virtual WaitRequest Wait(string name)
+ {
+ return new WaitRequest(this.service, name);
+ }
- /// The "projects" collection of methods.
- public class ProjectsResource
- {
- private const string Resource = "projects";
+ ///
+ /// Waits until the specified long-running operation is done or reaches at most a specified timeout,
+ /// returning the latest state. If the operation is already done, the latest state is immediately
+ /// returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
+ /// timeout is used. If the server does not support this method, it returns
+ /// `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return
+ /// the latest state before the specified timeout (including immediately), meaning even an immediate
+ /// response is no guarantee that the operation is done.
+ ///
+ public class WaitRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Wait request.
+ public WaitRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// The service which this resource belongs to.
- private readonly Google.Apis.Services.IClientService service;
+ /// The name of the operation resource to wait on.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Constructs a new resource.
- public ProjectsResource(Google.Apis.Services.IClientService service)
- {
- this.service = service;
- Locations = new LocationsResource(service);
- }
+ ///
+ /// The maximum duration to wait before timing out. If left blank, the wait will be at most the
+ /// time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also
+ /// specified, the shorter one will be used.
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("timeout", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual object Timeout { get; set; }
- /// Gets the Locations resource.
- public virtual LocationsResource Locations { get; }
+ /// Gets the method name.
+ public override string MethodName => "wait";
- /// The "locations" collection of methods.
- public class LocationsResource
- {
- private const string Resource = "locations";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "POST";
- /// The service which this resource belongs to.
- private readonly Google.Apis.Services.IClientService service;
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}:wait";
- /// Constructs a new resource.
- public LocationsResource(Google.Apis.Services.IClientService service)
- {
- this.service = service;
- BatchPredictionJobs = new BatchPredictionJobsResource(service);
- CachedContents = new CachedContentsResource(service);
- CustomJobs = new CustomJobsResource(service);
- DataLabelingJobs = new DataLabelingJobsResource(service);
- Datasets = new DatasetsResource(service);
- DeploymentResourcePools = new DeploymentResourcePoolsResource(service);
- Endpoints = new EndpointsResource(service);
- EvaluationItems = new EvaluationItemsResource(service);
- EvaluationRuns = new EvaluationRunsResource(service);
- EvaluationSets = new EvaluationSetsResource(service);
- FeatureGroups = new FeatureGroupsResource(service);
- FeatureOnlineStores = new FeatureOnlineStoresResource(service);
- Featurestores = new FeaturestoresResource(service);
- HyperparameterTuningJobs = new HyperparameterTuningJobsResource(service);
- IndexEndpoints = new IndexEndpointsResource(service);
- Indexes = new IndexesResource(service);
- MetadataStores = new MetadataStoresResource(service);
- MigratableResources = new MigratableResourcesResource(service);
- ModelDeploymentMonitoringJobs = new ModelDeploymentMonitoringJobsResource(service);
- Models = new ModelsResource(service);
- NasJobs = new NasJobsResource(service);
- NotebookExecutionJobs = new NotebookExecutionJobsResource(service);
- NotebookRuntimeTemplates = new NotebookRuntimeTemplatesResource(service);
- NotebookRuntimes = new NotebookRuntimesResource(service);
- Operations = new OperationsResource(service);
- PersistentResources = new PersistentResourcesResource(service);
- PipelineJobs = new PipelineJobsResource(service);
- Publishers = new PublishersResource(service);
- RagCorpora = new RagCorporaResource(service);
- RagEngineConfig = new RagEngineConfigResource(service);
- ReasoningEngines = new ReasoningEnginesResource(service);
- Schedules = new SchedulesResource(service);
- SpecialistPools = new SpecialistPoolsResource(service);
- Studies = new StudiesResource(service);
- Tensorboards = new TensorboardsResource(service);
- TrainingPipelines = new TrainingPipelinesResource(service);
- TuningJobs = new TuningJobsResource(service);
+ /// Initializes Wait parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
+ {
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$",
+ });
+ RequestParameters.Add("timeout", new Google.Apis.Discovery.Parameter
+ {
+ Name = "timeout",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ }
+ }
+ }
}
- /// Gets the BatchPredictionJobs resource.
- public virtual BatchPredictionJobsResource BatchPredictionJobs { get; }
+ /// Gets the Operations resource.
+ public virtual OperationsResource Operations { get; }
- /// The "batchPredictionJobs" collection of methods.
- public class BatchPredictionJobsResource
+ /// The "operations" collection of methods.
+ public class OperationsResource
{
- private const string Resource = "batchPredictionJobs";
+ private const string Resource = "operations";
/// The service which this resource belongs to.
private readonly Google.Apis.Services.IClientService service;
/// Constructs a new resource.
- public BatchPredictionJobsResource(Google.Apis.Services.IClientService service)
+ public OperationsResource(Google.Apis.Services.IClientService service)
{
this.service = service;
}
///
- /// 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`.
///
- /// The body of the request.
- ///
- /// Required. The name of the BatchPredictionJob to cancel. Format:
- /// `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
- ///
- public virtual CancelRequest Cancel(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1CancelBatchPredictionJobRequest body, string name)
+ /// The name of the operation resource to be cancelled.
+ public virtual CancelRequest Cancel(string name)
{
- return new CancelRequest(this.service, body, name);
+ return new CancelRequest(this.service, name);
}
///
- /// 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`.
///
public class CancelRequest : AiplatformBaseServiceRequest
{
/// Constructs a new Cancel request.
- public CancelRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1CancelBatchPredictionJobRequest body, string name) : base(service)
+ public CancelRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
Name = name;
- Body = body;
InitParameters();
}
- ///
- /// 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.
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
- /// Gets or sets the body of this request.
- Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1CancelBatchPredictionJobRequest Body { get; set; }
-
- /// Returns the body of the request.
- protected override object GetBody() => Body;
-
/// Gets the method name.
public override string MethodName => "cancel";
@@ -2205,88 +2265,28 @@ protected override void InitParameters()
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$",
+ Pattern = @"^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$",
});
}
}
///
- /// Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to
- /// start.
- ///
- /// The body of the request.
- ///
- /// Required. The resource name of the Location to create the BatchPredictionJob in. Format:
- /// `projects/{project}/locations/{location}`
- ///
- public virtual CreateRequest Create(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1BatchPredictionJob body, string parent)
- {
- return new CreateRequest(this.service, body, parent);
- }
-
- ///
- /// 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`.
///
- public class CreateRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Create request.
- public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1BatchPredictionJob body, string parent) : base(service)
- {
- Parent = parent;
- Body = body;
- InitParameters();
- }
-
- ///
- /// Required. The resource name of the Location to create the BatchPredictionJob in. Format:
- /// `projects/{project}/locations/{location}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Parent { get; private set; }
-
- /// Gets or sets the body of this request.
- Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1BatchPredictionJob Body { get; set; }
-
- /// Returns the body of the request.
- protected override object GetBody() => Body;
-
- /// Gets the method name.
- public override string MethodName => "create";
-
- /// Gets the HTTP method.
- public override string HttpMethod => "POST";
-
- /// Gets the REST path.
- public override string RestPath => "v1/{+parent}/batchPredictionJobs";
-
- /// Initializes Create parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
- {
- Name = "parent",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+$",
- });
- }
- }
-
- /// Deletes a BatchPredictionJob. Can only be called on jobs that already finished.
- ///
- /// 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.
public virtual DeleteRequest Delete(string name)
{
return new DeleteRequest(this.service, name);
}
- /// Deletes a BatchPredictionJob. Can only be called on jobs that already finished.
- public class DeleteRequest : AiplatformBaseServiceRequest
+ ///
+ /// Deletes a long-running operation. This method indicates that the client is no longer interested in
+ /// the operation result. It does not cancel the operation. If the server doesn't support this method,
+ /// it returns `google.rpc.Code.UNIMPLEMENTED`.
+ ///
+ public class DeleteRequest : AiplatformBaseServiceRequest
{
/// Constructs a new Delete request.
public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
@@ -2295,10 +2295,7 @@ public DeleteRequest(Google.Apis.Services.IClientService service, string name) :
InitParameters();
}
- ///
- /// 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.
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
@@ -2321,23 +2318,26 @@ protected override void InitParameters()
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$",
+ Pattern = @"^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$",
});
}
}
- /// Gets a BatchPredictionJob
- ///
- /// Required. The name of the BatchPredictionJob resource. Format:
- /// `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
- ///
+ ///
+ /// Gets the latest 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.
public virtual GetRequest Get(string name)
{
return new GetRequest(this.service, name);
}
- /// Gets a BatchPredictionJob
- public class GetRequest : AiplatformBaseServiceRequest
+ ///
+ /// Gets the latest state of a long-running operation. Clients can use this method to poll the operation
+ /// result at intervals as recommended by the API service.
+ ///
+ public class GetRequest : AiplatformBaseServiceRequest
{
/// Constructs a new Get request.
public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
@@ -2346,10 +2346,7 @@ public GetRequest(Google.Apis.Services.IClientService service, string name) : ba
InitParameters();
}
- ///
- /// Required. The name of the BatchPredictionJob resource. Format:
- /// `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
- ///
+ /// The name of the operation resource.
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
@@ -2372,49 +2369,39 @@ protected override void InitParameters()
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$",
+ Pattern = @"^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$",
});
}
}
- /// Lists BatchPredictionJobs in a Location.
- ///
- /// Required. The resource name of the Location to list the BatchPredictionJobs from. Format:
- /// `projects/{project}/locations/{location}`
- ///
- public virtual ListRequest List(string parent)
+ ///
+ /// Lists operations that match the specified filter in the request. If the server doesn't support this
+ /// method, it returns `UNIMPLEMENTED`.
+ ///
+ /// The name of the operation's parent resource.
+ public virtual ListRequest List(string name)
{
- return new ListRequest(this.service, parent);
+ return new ListRequest(this.service, name);
}
- /// Lists BatchPredictionJobs in a Location.
- public class ListRequest : AiplatformBaseServiceRequest
+ ///
+ /// Lists operations that match the specified filter in the request. If the server doesn't support this
+ /// method, it returns `UNIMPLEMENTED`.
+ ///
+ public class ListRequest : AiplatformBaseServiceRequest
{
/// Constructs a new List request.
- public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service)
+ public ListRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
- Parent = parent;
+ Name = name;
InitParameters();
}
- ///
- /// Required. The resource name of the Location to list the BatchPredictionJobs from. Format:
- /// `projects/{project}/locations/{location}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Parent { get; private set; }
+ /// The name of the operation's parent resource.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- ///
- /// 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.
[Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
public virtual string Filter { get; set; }
@@ -2422,17 +2409,20 @@ public ListRequest(Google.Apis.Services.IClientService service, string parent) :
[Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
public virtual System.Nullable PageSize { get; set; }
- ///
- /// The standard list page token. Typically obtained via
- /// ListBatchPredictionJobsResponse.next_page_token of the previous
- /// JobService.ListBatchPredictionJobs call.
- ///
+ /// The standard list page token.
[Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
public virtual string PageToken { get; set; }
- /// Mask specifying which fields to read.
- [Google.Apis.Util.RequestParameterAttribute("readMask", Google.Apis.Util.RequestParameterType.Query)]
- public virtual object ReadMask { get; set; }
+ ///
+ /// When set to `true`, operations that are reachable are returned as normal, and those that are
+ /// unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be
+ /// `true` when reading across collections e.g. when `parent` is set to
+ /// `"projects/example/locations/-"`. This field is not by default supported and will result in an
+ /// `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product
+ /// specific documentation.
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("returnPartialSuccess", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual System.Nullable ReturnPartialSuccess { get; set; }
/// Gets the method name.
public override string MethodName => "list";
@@ -2441,19 +2431,19 @@ public ListRequest(Google.Apis.Services.IClientService service, string parent) :
public override string HttpMethod => "GET";
/// Gets the REST path.
- public override string RestPath => "v1/{+parent}/batchPredictionJobs";
+ public override string RestPath => "v1/{+name}/operations";
/// Initializes List parameter list.
protected override void InitParameters()
{
base.InitParameters();
- RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- Name = "parent",
+ Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+$",
+ Pattern = @"^datasets/[^/]+/dataItems/[^/]+$",
});
RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
{
@@ -2479,9 +2469,9 @@ protected override void InitParameters()
DefaultValue = null,
Pattern = null,
});
- RequestParameters.Add("readMask", new Google.Apis.Discovery.Parameter
+ RequestParameters.Add("returnPartialSuccess", new Google.Apis.Discovery.Parameter
{
- Name = "readMask",
+ Name = "returnPartialSuccess",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
@@ -2489,756 +2479,947 @@ protected override void InitParameters()
});
}
}
- }
-
- /// Gets the CachedContents resource.
- public virtual CachedContentsResource CachedContents { get; }
-
- /// The "cachedContents" collection of methods.
- public class CachedContentsResource
- {
- private const string Resource = "cachedContents";
-
- /// The service which this resource belongs to.
- private readonly Google.Apis.Services.IClientService service;
-
- /// Constructs a new resource.
- public CachedContentsResource(Google.Apis.Services.IClientService service)
- {
- this.service = service;
- }
///
- /// Creates cached content, this call will initialize the cached content in the data storage, and users
- /// need to pay for the cache data storage.
+ /// Waits until the specified long-running operation is done or reaches at most a specified timeout,
+ /// returning the latest state. If the operation is already done, the latest state is immediately
+ /// returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
+ /// timeout is used. If the server does not support this method, it returns
+ /// `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the
+ /// latest state before the specified timeout (including immediately), meaning even an immediate
+ /// response is no guarantee that the operation is done.
///
- /// The body of the request.
- /// Required. The parent resource where the cached content will be created
- public virtual CreateRequest Create(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1CachedContent body, string parent)
+ /// The name of the operation resource to wait on.
+ public virtual WaitRequest Wait(string name)
{
- return new CreateRequest(this.service, body, parent);
+ return new WaitRequest(this.service, name);
}
///
- /// Creates cached content, this call will initialize the cached content in the data storage, and users
- /// need to pay for the cache data storage.
+ /// Waits until the specified long-running operation is done or reaches at most a specified timeout,
+ /// returning the latest state. If the operation is already done, the latest state is immediately
+ /// returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
+ /// timeout is used. If the server does not support this method, it returns
+ /// `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the
+ /// latest state before the specified timeout (including immediately), meaning even an immediate
+ /// response is no guarantee that the operation is done.
///
- public class CreateRequest : AiplatformBaseServiceRequest
+ public class WaitRequest : AiplatformBaseServiceRequest
{
- /// Constructs a new Create request.
- public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1CachedContent body, string parent) : base(service)
+ /// Constructs a new Wait request.
+ public WaitRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
- Parent = parent;
- Body = body;
+ Name = name;
InitParameters();
}
- /// Required. The parent resource where the cached content will be created
- [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Parent { get; private set; }
-
- /// Gets or sets the body of this request.
- Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1CachedContent Body { get; set; }
+ /// The name of the operation resource to wait on.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Returns the body of the request.
- protected override object GetBody() => Body;
+ ///
+ /// The maximum duration to wait before timing out. If left blank, the wait will be at most the time
+ /// permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the
+ /// shorter one will be used.
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("timeout", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual object Timeout { get; set; }
/// Gets the method name.
- public override string MethodName => "create";
+ public override string MethodName => "wait";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
- public override string RestPath => "v1/{+parent}/cachedContents";
+ public override string RestPath => "v1/{+name}:wait";
- /// Initializes Create parameter list.
+ /// Initializes Wait parameter list.
protected override void InitParameters()
{
base.InitParameters();
- RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- Name = "parent",
+ Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+$",
+ Pattern = @"^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$",
+ });
+ RequestParameters.Add("timeout", new Google.Apis.Discovery.Parameter
+ {
+ Name = "timeout",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
});
}
}
+ }
+ }
- /// Deletes cached content
- /// Required. The resource name referring to the cached content
- public virtual DeleteRequest Delete(string name)
- {
- return new DeleteRequest(this.service, name);
- }
-
- /// Deletes cached content
- public class DeleteRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Delete request.
- public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
-
- /// Required. The resource name referring to the cached content
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ /// Gets the DatasetVersions resource.
+ public virtual DatasetVersionsResource DatasetVersions { get; }
- /// Gets the method name.
- public override string MethodName => "delete";
+ /// The "datasetVersions" collection of methods.
+ public class DatasetVersionsResource
+ {
+ private const string Resource = "datasetVersions";
- /// Gets the HTTP method.
- public override string HttpMethod => "DELETE";
+ /// The service which this resource belongs to.
+ private readonly Google.Apis.Services.IClientService service;
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}";
+ /// Constructs a new resource.
+ public DatasetVersionsResource(Google.Apis.Services.IClientService service)
+ {
+ this.service = service;
+ }
- /// Initializes Delete parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$",
- });
- }
- }
+ /// Create a version from a Dataset.
+ /// The body of the request.
+ ///
+ /// Required. The name of the Dataset resource. Format:
+ /// `projects/{project}/locations/{location}/datasets/{dataset}`
+ ///
+ public virtual CreateRequest Create(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1DatasetVersion body, string parent)
+ {
+ return new CreateRequest(this.service, body, parent);
+ }
- /// Gets cached content configurations
- /// Required. The resource name referring to the cached content
- public virtual GetRequest Get(string name)
+ /// Create a version from a Dataset.
+ public class CreateRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Create request.
+ public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1DatasetVersion body, string parent) : base(service)
{
- return new GetRequest(this.service, name);
+ Parent = parent;
+ Body = body;
+ InitParameters();
}
- /// Gets cached content configurations
- public class GetRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Get request.
- public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ ///
+ /// Required. The name of the Dataset resource. Format:
+ /// `projects/{project}/locations/{location}/datasets/{dataset}`
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Parent { get; private set; }
- /// Required. The resource name referring to the cached content
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ /// Gets or sets the body of this request.
+ Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1DatasetVersion Body { get; set; }
- /// Gets the method name.
- public override string MethodName => "get";
+ /// Returns the body of the request.
+ protected override object GetBody() => Body;
- /// Gets the HTTP method.
- public override string HttpMethod => "GET";
+ /// Gets the method name.
+ public override string MethodName => "create";
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "POST";
- /// Initializes Get parameter list.
- protected override void InitParameters()
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+parent}/datasetVersions";
+
+ /// Initializes Create parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
{
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$",
- });
- }
+ Name = "parent",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^datasets/[^/]+$",
+ });
}
+ }
- /// Lists cached contents in a project
- /// Required. The parent, which owns this collection of cached contents.
- public virtual ListRequest List(string parent)
+ /// Deletes a Dataset version.
+ ///
+ /// Required. The resource name of the Dataset version to delete. Format:
+ /// `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
+ ///
+ public virtual DeleteRequest Delete(string name)
+ {
+ return new DeleteRequest(this.service, name);
+ }
+
+ /// Deletes a Dataset version.
+ public class DeleteRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Delete request.
+ public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
- return new ListRequest(this.service, parent);
+ Name = name;
+ InitParameters();
}
- /// Lists cached contents in a project
- public class ListRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new List request.
- public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service)
- {
- Parent = parent;
- InitParameters();
- }
+ ///
+ /// Required. The resource name of the Dataset version to delete. Format:
+ /// `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Required. The parent, which owns this collection of cached contents.
- [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Parent { get; private set; }
+ /// Gets the method name.
+ public override string MethodName => "delete";
- ///
- /// 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.
- ///
- [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
- public virtual System.Nullable PageSize { get; set; }
+ /// Gets the HTTP method.
+ public override string HttpMethod => "DELETE";
- ///
- /// 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.
- ///
- [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string PageToken { get; set; }
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}";
- /// Gets the method name.
- public override string MethodName => "list";
+ /// Initializes Delete parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
+ {
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^datasets/[^/]+/datasetVersions/[^/]+$",
+ });
+ }
+ }
- /// Gets the HTTP method.
- public override string HttpMethod => "GET";
+ /// Gets a Dataset version.
+ ///
+ /// Required. The resource name of the Dataset version to delete. Format:
+ /// `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
+ ///
+ public virtual GetRequest Get(string name)
+ {
+ return new GetRequest(this.service, name);
+ }
- /// Gets the REST path.
- public override string RestPath => "v1/{+parent}/cachedContents";
+ /// Gets a Dataset version.
+ public class GetRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Get request.
+ public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// Initializes List parameter list.
- protected override void InitParameters()
+ ///
+ /// Required. The resource name of the Dataset version to delete. Format:
+ /// `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
+
+ /// Mask specifying which fields to read.
+ [Google.Apis.Util.RequestParameterAttribute("readMask", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual object ReadMask { get; set; }
+
+ /// Gets the method name.
+ public override string MethodName => "get";
+
+ /// Gets the HTTP method.
+ public override string HttpMethod => "GET";
+
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}";
+
+ /// Initializes Get parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- base.InitParameters();
- RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
- {
- Name = "parent",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+$",
- });
- RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
- {
- Name = "pageSize",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
- {
- Name = "pageToken",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- }
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^datasets/[^/]+/datasetVersions/[^/]+$",
+ });
+ RequestParameters.Add("readMask", new Google.Apis.Discovery.Parameter
+ {
+ Name = "readMask",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
}
+ }
- /// Updates cached content configurations
- /// The body of the request.
- ///
- /// Immutable. Identifier. The server-generated resource name of the cached content Format:
- /// projects/{project}/locations/{location}/cachedContents/{cached_content}
- ///
- public virtual PatchRequest Patch(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1CachedContent body, string name)
+ /// Lists DatasetVersions in a Dataset.
+ ///
+ /// Required. The resource name of the Dataset to list DatasetVersions from. Format:
+ /// `projects/{project}/locations/{location}/datasets/{dataset}`
+ ///
+ public virtual ListRequest List(string parent)
+ {
+ return new ListRequest(this.service, parent);
+ }
+
+ /// Lists DatasetVersions in a Dataset.
+ public class ListRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new List request.
+ public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service)
{
- return new PatchRequest(this.service, body, name);
+ Parent = parent;
+ InitParameters();
}
- /// Updates cached content configurations
- public class PatchRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Patch request.
- public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1CachedContent body, string name) : base(service)
- {
- Name = name;
- Body = body;
- InitParameters();
- }
+ ///
+ /// Required. The resource name of the Dataset to list DatasetVersions from. Format:
+ /// `projects/{project}/locations/{location}/datasets/{dataset}`
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Parent { get; private set; }
- ///
- /// Immutable. Identifier. The server-generated resource name of the cached content Format:
- /// projects/{project}/locations/{location}/cachedContents/{cached_content}
- ///
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ /// Optional. The standard list filter.
+ [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string Filter { get; set; }
- /// Required. The list of fields to update.
- [Google.Apis.Util.RequestParameterAttribute("updateMask", Google.Apis.Util.RequestParameterType.Query)]
- public virtual object UpdateMask { get; set; }
+ ///
+ /// Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after
+ /// a field name for descending.
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("orderBy", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string OrderBy { get; set; }
- /// Gets or sets the body of this request.
- Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1CachedContent Body { get; set; }
+ /// Optional. The standard list page size.
+ [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual System.Nullable PageSize { get; set; }
- /// Returns the body of the request.
- protected override object GetBody() => Body;
+ /// Optional. The standard list page token.
+ [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string PageToken { get; set; }
- /// Gets the method name.
- public override string MethodName => "patch";
+ /// Optional. Mask specifying which fields to read.
+ [Google.Apis.Util.RequestParameterAttribute("readMask", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual object ReadMask { get; set; }
- /// Gets the HTTP method.
- public override string HttpMethod => "PATCH";
+ /// Gets the method name.
+ public override string MethodName => "list";
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "GET";
- /// Initializes Patch parameter list.
- protected override void InitParameters()
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+parent}/datasetVersions";
+
+ /// Initializes List parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
{
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$",
- });
- RequestParameters.Add("updateMask", new Google.Apis.Discovery.Parameter
- {
- Name = "updateMask",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- }
+ Name = "parent",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^datasets/[^/]+$",
+ });
+ RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
+ {
+ Name = "filter",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("orderBy", new Google.Apis.Discovery.Parameter
+ {
+ Name = "orderBy",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
+ {
+ Name = "pageSize",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
+ {
+ Name = "pageToken",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("readMask", new Google.Apis.Discovery.Parameter
+ {
+ Name = "readMask",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
}
}
- /// Gets the CustomJobs resource.
- public virtual CustomJobsResource CustomJobs { get; }
-
- /// The "customJobs" collection of methods.
- public class CustomJobsResource
+ /// Updates a DatasetVersion.
+ /// The body of the request.
+ ///
+ /// Output only. Identifier. The resource name of the DatasetVersion. Format:
+ /// `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
+ ///
+ public virtual PatchRequest Patch(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1DatasetVersion body, string name)
{
- private const string Resource = "customJobs";
-
- /// The service which this resource belongs to.
- private readonly Google.Apis.Services.IClientService service;
+ return new PatchRequest(this.service, body, name);
+ }
- /// Constructs a new resource.
- public CustomJobsResource(Google.Apis.Services.IClientService service)
+ /// Updates a DatasetVersion.
+ public class PatchRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Patch request.
+ public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1DatasetVersion body, string name) : base(service)
{
- this.service = service;
- Operations = new OperationsResource(service);
+ Name = name;
+ Body = body;
+ InitParameters();
}
- /// Gets the Operations resource.
- public virtual OperationsResource Operations { get; }
+ ///
+ /// Output only. Identifier. The resource name of the DatasetVersion. Format:
+ /// `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// The "operations" collection of methods.
- public class OperationsResource
- {
- private const string Resource = "operations";
+ ///
+ /// Required. The update mask applies to the resource. For the `FieldMask` definition, see
+ /// google.protobuf.FieldMask. Updatable fields: * `display_name`
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("updateMask", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual object UpdateMask { get; set; }
- /// The service which this resource belongs to.
- private readonly Google.Apis.Services.IClientService service;
+ /// Gets or sets the body of this request.
+ Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1DatasetVersion Body { get; set; }
- /// Constructs a new resource.
- public OperationsResource(Google.Apis.Services.IClientService service)
- {
- this.service = service;
- }
+ /// Returns the body of the request.
+ protected override object GetBody() => Body;
- ///
- /// Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
- /// cancel the operation, but success is not guaranteed. If the server doesn't support this method,
- /// it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other
- /// methods to check whether the cancellation succeeded or whether the operation completed despite
- /// cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
- /// operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to
- /// `Code.CANCELLED`.
- ///
- /// The name of the operation resource to be cancelled.
- public virtual CancelRequest Cancel(string name)
- {
- return new CancelRequest(this.service, name);
- }
+ /// Gets the method name.
+ public override string MethodName => "patch";
- ///
- /// Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
- /// cancel the operation, but success is not guaranteed. If the server doesn't support this method,
- /// it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other
- /// methods to check whether the cancellation succeeded or whether the operation completed despite
- /// cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
- /// operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to
- /// `Code.CANCELLED`.
- ///
- public class CancelRequest : AiplatformBaseServiceRequest
+ /// Gets the HTTP method.
+ public override string HttpMethod => "PATCH";
+
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}";
+
+ /// Initializes Patch parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- /// Constructs a new Cancel request.
- public CancelRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^datasets/[^/]+/datasetVersions/[^/]+$",
+ });
+ RequestParameters.Add("updateMask", new Google.Apis.Discovery.Parameter
+ {
+ Name = "updateMask",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ }
+ }
- /// The name of the operation resource to be cancelled.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ /// Restores a dataset version.
+ ///
+ /// Required. The name of the DatasetVersion resource. Format:
+ /// `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
+ ///
+ public virtual RestoreRequest Restore(string name)
+ {
+ return new RestoreRequest(this.service, name);
+ }
- /// Gets the method name.
- public override string MethodName => "cancel";
+ /// Restores a dataset version.
+ public class RestoreRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Restore request.
+ public RestoreRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// Gets the HTTP method.
- public override string HttpMethod => "POST";
+ ///
+ /// Required. The name of the DatasetVersion resource. Format:
+ /// `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}:cancel";
+ /// Gets the method name.
+ public override string MethodName => "restore";
- /// Initializes Cancel parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$",
- });
- }
- }
+ /// Gets the HTTP method.
+ public override string HttpMethod => "GET";
- ///
- /// Deletes a long-running operation. This method indicates that the client is no longer interested
- /// in the operation result. It does not cancel the operation. If the server doesn't support this
- /// method, it returns `google.rpc.Code.UNIMPLEMENTED`.
- ///
- /// The name of the operation resource to be deleted.
- public virtual DeleteRequest Delete(string name)
- {
- return new DeleteRequest(this.service, name);
- }
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}:restore";
- ///
- /// Deletes a long-running operation. This method indicates that the client is no longer interested
- /// in the operation result. It does not cancel the operation. If the server doesn't support this
- /// method, it returns `google.rpc.Code.UNIMPLEMENTED`.
- ///
- public class DeleteRequest : AiplatformBaseServiceRequest
+ /// Initializes Restore parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- /// Constructs a new Delete request.
- public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^datasets/[^/]+/datasetVersions/[^/]+$",
+ });
+ }
+ }
+ }
- /// The name of the operation resource to be deleted.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ /// Gets the Operations resource.
+ public virtual OperationsResource Operations { get; }
- /// Gets the method name.
- public override string MethodName => "delete";
+ /// The "operations" collection of methods.
+ public class OperationsResource
+ {
+ private const string Resource = "operations";
- /// Gets the HTTP method.
- public override string HttpMethod => "DELETE";
+ /// The service which this resource belongs to.
+ private readonly Google.Apis.Services.IClientService service;
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}";
+ /// Constructs a new resource.
+ public OperationsResource(Google.Apis.Services.IClientService service)
+ {
+ this.service = service;
+ }
- /// Initializes Delete parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$",
- });
- }
- }
+ ///
+ /// Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel
+ /// the operation, but success is not guaranteed. If the server doesn't support this method, it returns
+ /// `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check
+ /// whether the cancellation succeeded or whether the operation completed despite cancellation. On
+ /// successful cancellation, the operation is not deleted; instead, it becomes an operation with an
+ /// Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+ ///
+ /// The name of the operation resource to be cancelled.
+ public virtual CancelRequest Cancel(string name)
+ {
+ return new CancelRequest(this.service, 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.
- ///
- /// The name of the operation resource.
- public virtual GetRequest Get(string name)
- {
- return new GetRequest(this.service, name);
- }
+ ///
+ /// Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel
+ /// the operation, but success is not guaranteed. If the server doesn't support this method, it returns
+ /// `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check
+ /// whether the cancellation succeeded or whether the operation completed despite cancellation. On
+ /// successful cancellation, the operation is not deleted; instead, it becomes an operation with an
+ /// Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+ ///
+ public class CancelRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Cancel request.
+ public CancelRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- ///
- /// Gets the latest state of a long-running operation. Clients can use this method to poll the
- /// operation result at intervals as recommended by the API service.
- ///
- public class GetRequest : AiplatformBaseServiceRequest
+ /// The name of the operation resource to be cancelled.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
+
+ /// Gets the method name.
+ public override string MethodName => "cancel";
+
+ /// Gets the HTTP method.
+ public override string HttpMethod => "POST";
+
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}:cancel";
+
+ /// Initializes Cancel parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- /// Constructs a new Get request.
- public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^datasets/[^/]+/operations/[^/]+$",
+ });
+ }
+ }
- /// The name of the operation resource.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private 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`.
+ ///
+ /// The name of the operation resource to be deleted.
+ public virtual DeleteRequest Delete(string name)
+ {
+ return new DeleteRequest(this.service, name);
+ }
- /// Gets the method name.
- public override string MethodName => "get";
+ ///
+ /// Deletes a long-running operation. This method indicates that the client is no longer interested in the
+ /// operation result. It does not cancel the operation. If the server doesn't support this method, it
+ /// returns `google.rpc.Code.UNIMPLEMENTED`.
+ ///
+ public class DeleteRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Delete request.
+ public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// Gets the HTTP method.
- public override string HttpMethod => "GET";
+ /// The name of the operation resource to be deleted.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}";
+ /// Gets the method name.
+ public override string MethodName => "delete";
- /// Initializes Get parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$",
- });
- }
- }
+ /// Gets the HTTP method.
+ public override string HttpMethod => "DELETE";
- ///
- /// Lists operations that match the specified filter in the request. If the server doesn't support
- /// this method, it returns `UNIMPLEMENTED`.
- ///
- /// The name of the operation's parent resource.
- public virtual ListRequest List(string name)
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}";
+
+ /// Initializes Delete parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- return new ListRequest(this.service, name);
- }
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^datasets/[^/]+/operations/[^/]+$",
+ });
+ }
+ }
- ///
- /// Lists operations that match the specified filter in the request. If the server doesn't support
- /// this method, it returns `UNIMPLEMENTED`.
- ///
- public class ListRequest : AiplatformBaseServiceRequest
+ ///
+ /// Gets the latest 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.
+ public virtual GetRequest Get(string name)
+ {
+ return new GetRequest(this.service, 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.
+ ///
+ public class GetRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Get request.
+ public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
+
+ /// The name of the operation resource.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
+
+ /// Gets the method name.
+ public override string MethodName => "get";
+
+ /// Gets the HTTP method.
+ public override string HttpMethod => "GET";
+
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}";
+
+ /// Initializes Get parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- /// Constructs a new List request.
- public ListRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^datasets/[^/]+/operations/[^/]+$",
+ });
+ }
+ }
- /// The name of the operation's parent resource.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ ///
+ /// Lists operations that match the specified filter in the request. If the server doesn't support this
+ /// method, it returns `UNIMPLEMENTED`.
+ ///
+ /// The name of the operation's parent resource.
+ public virtual ListRequest List(string name)
+ {
+ return new ListRequest(this.service, name);
+ }
- /// The standard list filter.
- [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string Filter { get; set; }
+ ///
+ /// Lists operations that match the specified filter in the request. If the server doesn't support this
+ /// method, it returns `UNIMPLEMENTED`.
+ ///
+ public class ListRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new List request.
+ public ListRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// The standard list page size.
- [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
- public virtual System.Nullable PageSize { get; set; }
+ /// The name of the operation's parent resource.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// The standard list page token.
- [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string PageToken { get; set; }
+ /// The standard list filter.
+ [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string Filter { get; set; }
- ///
- /// When set to `true`, operations that are reachable are returned as normal, and those that are
- /// unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be
- /// `true` when reading across collections e.g. when `parent` is set to
- /// `"projects/example/locations/-"`. This field is not by default supported and will result in
- /// an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product
- /// specific documentation.
- ///
- [Google.Apis.Util.RequestParameterAttribute("returnPartialSuccess", Google.Apis.Util.RequestParameterType.Query)]
- public virtual System.Nullable ReturnPartialSuccess { get; set; }
+ /// The standard list page size.
+ [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual System.Nullable PageSize { get; set; }
- /// Gets the method name.
- public override string MethodName => "list";
+ /// The standard list page token.
+ [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string PageToken { get; set; }
- /// Gets the HTTP method.
- public override string HttpMethod => "GET";
+ ///
+ /// When set to `true`, operations that are reachable are returned as normal, and those that are
+ /// unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true`
+ /// when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This
+ /// field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless
+ /// explicitly documented otherwise in service or product specific documentation.
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("returnPartialSuccess", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual System.Nullable ReturnPartialSuccess { get; set; }
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}/operations";
+ /// Gets the method name.
+ public override string MethodName => "list";
- /// Initializes List parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$",
- });
- RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
- {
- Name = "filter",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
- {
- Name = "pageSize",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
- {
- Name = "pageToken",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("returnPartialSuccess", new Google.Apis.Discovery.Parameter
- {
- Name = "returnPartialSuccess",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- }
- }
+ /// Gets the HTTP method.
+ public override string HttpMethod => "GET";
- ///
- /// Waits until the specified long-running operation is done or reaches at most a specified timeout,
- /// returning the latest state. If the operation is already done, the latest state is immediately
- /// returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
- /// timeout is used. If the server does not support this method, it returns
- /// `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return
- /// the latest state before the specified timeout (including immediately), meaning even an immediate
- /// response is no guarantee that the operation is done.
- ///
- /// The name of the operation resource to wait on.
- public virtual WaitRequest Wait(string name)
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}/operations";
+
+ /// Initializes List parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- return new WaitRequest(this.service, name);
- }
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^datasets/[^/]+$",
+ });
+ RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
+ {
+ Name = "filter",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
+ {
+ Name = "pageSize",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
+ {
+ Name = "pageToken",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("returnPartialSuccess", new Google.Apis.Discovery.Parameter
+ {
+ Name = "returnPartialSuccess",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ }
+ }
- ///
- /// Waits until the specified long-running operation is done or reaches at most a specified timeout,
- /// returning the latest state. If the operation is already done, the latest state is immediately
- /// returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
- /// timeout is used. If the server does not support this method, it returns
- /// `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return
- /// the latest state before the specified timeout (including immediately), meaning even an immediate
- /// response is no guarantee that the operation is done.
- ///
- public class WaitRequest : AiplatformBaseServiceRequest
+ ///
+ /// Waits until the specified long-running operation is done or reaches at most a specified timeout,
+ /// returning the latest state. If the operation is already done, the latest state is immediately returned.
+ /// If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If
+ /// the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this
+ /// method is on a best-effort basis. It may return the latest state before the specified timeout (including
+ /// immediately), meaning even an immediate response is no guarantee that the operation is done.
+ ///
+ /// The name of the operation resource to wait on.
+ public virtual WaitRequest Wait(string name)
+ {
+ return new WaitRequest(this.service, 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.
+ ///
+ public class WaitRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Wait request.
+ public WaitRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
+
+ /// The name of the operation resource to wait on.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
+
+ ///
+ /// The maximum duration to wait before timing out. If left blank, the wait will be at most the time
+ /// permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the
+ /// shorter one will be used.
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("timeout", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual object Timeout { get; set; }
+
+ /// Gets the method name.
+ public override string MethodName => "wait";
+
+ /// Gets the HTTP method.
+ public override string HttpMethod => "POST";
+
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}:wait";
+
+ /// Initializes Wait parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- /// Constructs a new Wait request.
- public WaitRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^datasets/[^/]+/operations/[^/]+$",
+ });
+ RequestParameters.Add("timeout", new Google.Apis.Discovery.Parameter
+ {
+ Name = "timeout",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ }
+ }
+ }
- /// The name of the operation resource to wait on.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ /// Gets the SavedQueries resource.
+ public virtual SavedQueriesResource SavedQueries { get; }
- ///
- /// The maximum duration to wait before timing out. If left blank, the wait will be at most the
- /// time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also
- /// specified, the shorter one will be used.
- ///
- [Google.Apis.Util.RequestParameterAttribute("timeout", Google.Apis.Util.RequestParameterType.Query)]
- public virtual object Timeout { get; set; }
+ /// The "savedQueries" collection of methods.
+ public class SavedQueriesResource
+ {
+ private const string Resource = "savedQueries";
- /// Gets the method name.
- public override string MethodName => "wait";
+ /// The service which this resource belongs to.
+ private readonly Google.Apis.Services.IClientService service;
- /// Gets the HTTP method.
- public override string HttpMethod => "POST";
+ /// Constructs a new resource.
+ public SavedQueriesResource(Google.Apis.Services.IClientService service)
+ {
+ this.service = service;
+ Operations = new OperationsResource(service);
+ }
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}:wait";
+ /// Gets the Operations resource.
+ public virtual OperationsResource Operations { get; }
- /// Initializes Wait parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$",
- });
- RequestParameters.Add("timeout", new Google.Apis.Discovery.Parameter
- {
- Name = "timeout",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- }
- }
+ /// The "operations" collection of methods.
+ public class OperationsResource
+ {
+ private const string Resource = "operations";
+
+ /// The service which this resource belongs to.
+ private readonly Google.Apis.Services.IClientService service;
+
+ /// Constructs a new resource.
+ public OperationsResource(Google.Apis.Services.IClientService service)
+ {
+ this.service = service;
}
///
- /// 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`.
///
- /// The body of the request.
- ///
- /// Required. The name of the CustomJob to cancel. Format:
- /// `projects/{project}/locations/{location}/customJobs/{custom_job}`
- ///
- public virtual CancelRequest Cancel(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1CancelCustomJobRequest body, string name)
+ /// The name of the operation resource to be cancelled.
+ public virtual CancelRequest Cancel(string name)
{
- return new CancelRequest(this.service, body, name);
+ return new CancelRequest(this.service, name);
}
///
- /// 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`.
///
public class CancelRequest : AiplatformBaseServiceRequest
{
/// Constructs a new Cancel request.
- public CancelRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1CancelCustomJobRequest body, string name) : base(service)
+ public CancelRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
Name = name;
- Body = body;
InitParameters();
}
- ///
- /// 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.
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
- /// Gets or sets the body of this request.
- Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1CancelCustomJobRequest Body { get; set; }
-
- /// Returns the body of the request.
- protected override object GetBody() => Body;
-
/// Gets the method name.
public override string MethodName => "cancel";
@@ -3258,82 +3439,28 @@ protected override void InitParameters()
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$",
+ Pattern = @"^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$",
});
}
}
- /// Creates a CustomJob. A created CustomJob right away will be attempted to be run.
- /// The body of the request.
- ///
- /// Required. The resource name of the Location to create the CustomJob in. Format:
- /// `projects/{project}/locations/{location}`
- ///
- public virtual CreateRequest Create(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1CustomJob body, string parent)
+ ///
+ /// Deletes a long-running operation. This method indicates that the client is no longer interested in
+ /// the operation result. It does not cancel the operation. If the server doesn't support this method,
+ /// it returns `google.rpc.Code.UNIMPLEMENTED`.
+ ///
+ /// The name of the operation resource to be deleted.
+ public virtual DeleteRequest Delete(string name)
{
- return new CreateRequest(this.service, body, parent);
+ return new DeleteRequest(this.service, name);
}
- /// Creates a CustomJob. A created CustomJob right away will be attempted to be run.
- public class CreateRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Create request.
- public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1CustomJob body, string parent) : base(service)
- {
- Parent = parent;
- Body = body;
- InitParameters();
- }
-
- ///
- /// Required. The resource name of the Location to create the CustomJob in. Format:
- /// `projects/{project}/locations/{location}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Parent { get; private set; }
-
- /// Gets or sets the body of this request.
- Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1CustomJob Body { get; set; }
-
- /// Returns the body of the request.
- protected override object GetBody() => Body;
-
- /// Gets the method name.
- public override string MethodName => "create";
-
- /// Gets the HTTP method.
- public override string HttpMethod => "POST";
-
- /// Gets the REST path.
- public override string RestPath => "v1/{+parent}/customJobs";
-
- /// Initializes Create parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
- {
- Name = "parent",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+$",
- });
- }
- }
-
- /// Deletes a CustomJob.
- ///
- /// Required. The name of the CustomJob resource to be deleted. Format:
- /// `projects/{project}/locations/{location}/customJobs/{custom_job}`
- ///
- public virtual DeleteRequest Delete(string name)
- {
- return new DeleteRequest(this.service, name);
- }
-
- /// Deletes a CustomJob.
- public class DeleteRequest : AiplatformBaseServiceRequest
+ ///
+ /// Deletes a long-running operation. This method indicates that the client is no longer interested in
+ /// the operation result. It does not cancel the operation. If the server doesn't support this method,
+ /// it returns `google.rpc.Code.UNIMPLEMENTED`.
+ ///
+ public class DeleteRequest : AiplatformBaseServiceRequest
{
/// Constructs a new Delete request.
public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
@@ -3342,10 +3469,7 @@ public DeleteRequest(Google.Apis.Services.IClientService service, string name) :
InitParameters();
}
- ///
- /// 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.
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
@@ -3368,23 +3492,26 @@ protected override void InitParameters()
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$",
+ Pattern = @"^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$",
});
}
}
- /// Gets a CustomJob.
- ///
- /// Required. The name of the CustomJob resource. Format:
- /// `projects/{project}/locations/{location}/customJobs/{custom_job}`
- ///
+ ///
+ /// Gets the latest 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.
public virtual GetRequest Get(string name)
{
return new GetRequest(this.service, name);
}
- /// Gets a CustomJob.
- public class GetRequest : AiplatformBaseServiceRequest
+ ///
+ /// Gets the latest state of a long-running operation. Clients can use this method to poll the operation
+ /// result at intervals as recommended by the API service.
+ ///
+ public class GetRequest : AiplatformBaseServiceRequest
{
/// Constructs a new Get request.
public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
@@ -3393,10 +3520,7 @@ public GetRequest(Google.Apis.Services.IClientService service, string name) : ba
InitParameters();
}
- ///
- /// Required. The name of the CustomJob resource. Format:
- /// `projects/{project}/locations/{location}/customJobs/{custom_job}`
- ///
+ /// The name of the operation resource.
[Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
public virtual string Name { get; private set; }
@@ -3419,48 +3543,39 @@ protected override void InitParameters()
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$",
+ Pattern = @"^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$",
});
}
}
- /// Lists CustomJobs in a Location.
- ///
- /// Required. The resource name of the Location to list the CustomJobs from. Format:
- /// `projects/{project}/locations/{location}`
- ///
- public virtual ListRequest List(string parent)
+ ///
+ /// Lists operations that match the specified filter in the request. If the server doesn't support this
+ /// method, it returns `UNIMPLEMENTED`.
+ ///
+ /// The name of the operation's parent resource.
+ public virtual ListRequest List(string name)
{
- return new ListRequest(this.service, parent);
+ return new ListRequest(this.service, name);
}
- /// Lists CustomJobs in a Location.
- public class ListRequest : AiplatformBaseServiceRequest
+ ///
+ /// Lists operations that match the specified filter in the request. If the server doesn't support this
+ /// method, it returns `UNIMPLEMENTED`.
+ ///
+ public class ListRequest : AiplatformBaseServiceRequest
{
/// Constructs a new List request.
- public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service)
+ public ListRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
- Parent = parent;
+ Name = name;
InitParameters();
}
- ///
- /// Required. The resource name of the Location to list the CustomJobs from. Format:
- /// `projects/{project}/locations/{location}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Parent { get; private set; }
+ /// The name of the operation's parent resource.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- ///
- /// 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.
[Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
public virtual string Filter { get; set; }
@@ -3468,16 +3583,20 @@ public ListRequest(Google.Apis.Services.IClientService service, string parent) :
[Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
public virtual System.Nullable PageSize { get; set; }
- ///
- /// The standard list page token. Typically obtained via ListCustomJobsResponse.next_page_token of
- /// the previous JobService.ListCustomJobs call.
- ///
+ /// The standard list page token.
[Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
public virtual string PageToken { get; set; }
- /// Mask specifying which fields to read.
- [Google.Apis.Util.RequestParameterAttribute("readMask", Google.Apis.Util.RequestParameterType.Query)]
- public virtual object ReadMask { get; set; }
+ ///
+ /// When set to `true`, operations that are reachable are returned as normal, and those that are
+ /// unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be
+ /// `true` when reading across collections e.g. when `parent` is set to
+ /// `"projects/example/locations/-"`. This field is not by default supported and will result in an
+ /// `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product
+ /// specific documentation.
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("returnPartialSuccess", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual System.Nullable ReturnPartialSuccess { get; set; }
/// Gets the method name.
public override string MethodName => "list";
@@ -3486,19 +3605,19 @@ public ListRequest(Google.Apis.Services.IClientService service, string parent) :
public override string HttpMethod => "GET";
/// Gets the REST path.
- public override string RestPath => "v1/{+parent}/customJobs";
+ public override string RestPath => "v1/{+name}/operations";
/// Initializes List parameter list.
protected override void InitParameters()
{
base.InitParameters();
- RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- Name = "parent",
+ Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+$",
+ Pattern = @"^datasets/[^/]+/savedQueries/[^/]+$",
});
RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
{
@@ -3524,9 +3643,9 @@ protected override void InitParameters()
DefaultValue = null,
Pattern = null,
});
- RequestParameters.Add("readMask", new Google.Apis.Discovery.Parameter
+ RequestParameters.Add("returnPartialSuccess", new Google.Apis.Discovery.Parameter
{
- Name = "readMask",
+ Name = "returnPartialSuccess",
IsRequired = false,
ParameterType = "query",
DefaultValue = null,
@@ -3534,2889 +3653,3277 @@ protected override void InitParameters()
});
}
}
- }
-
- /// Gets the DataLabelingJobs resource.
- public virtual DataLabelingJobsResource DataLabelingJobs { get; }
-
- /// The "dataLabelingJobs" collection of methods.
- public class DataLabelingJobsResource
- {
- private const string Resource = "dataLabelingJobs";
-
- /// The service which this resource belongs to.
- private readonly Google.Apis.Services.IClientService service;
- /// Constructs a new resource.
- public DataLabelingJobsResource(Google.Apis.Services.IClientService service)
+ ///
+ /// Waits until the specified long-running operation is done or reaches at most a specified timeout,
+ /// returning the latest state. If the operation is already done, the latest state is immediately
+ /// returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
+ /// timeout is used. If the server does not support this method, it returns
+ /// `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the
+ /// latest state before the specified timeout (including immediately), meaning even an immediate
+ /// response is no guarantee that the operation is done.
+ ///
+ /// The name of the operation resource to wait on.
+ public virtual WaitRequest Wait(string name)
{
- this.service = service;
- Operations = new OperationsResource(service);
+ return new WaitRequest(this.service, name);
}
- /// Gets the Operations resource.
- public virtual OperationsResource Operations { get; }
-
- /// The "operations" collection of methods.
- public class OperationsResource
+ ///
+ /// Waits until the specified long-running operation is done or reaches at most a specified timeout,
+ /// returning the latest state. If the operation is already done, the latest state is immediately
+ /// returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
+ /// timeout is used. If the server does not support this method, it returns
+ /// `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the
+ /// latest state before the specified timeout (including immediately), meaning even an immediate
+ /// response is no guarantee that the operation is done.
+ ///
+ public class WaitRequest : AiplatformBaseServiceRequest
{
- private const string Resource = "operations";
-
- /// The service which this resource belongs to.
- private readonly Google.Apis.Services.IClientService service;
-
- /// Constructs a new resource.
- public OperationsResource(Google.Apis.Services.IClientService service)
+ /// Constructs a new Wait request.
+ public WaitRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
- this.service = service;
+ Name = name;
+ InitParameters();
}
- ///
- /// Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
- /// cancel the operation, but success is not guaranteed. If the server doesn't support this method,
- /// it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other
- /// methods to check whether the cancellation succeeded or whether the operation completed despite
- /// cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
- /// operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to
- /// `Code.CANCELLED`.
- ///
- /// The name of the operation resource to be cancelled.
- public virtual CancelRequest Cancel(string name)
- {
- return new CancelRequest(this.service, name);
- }
+ /// The name of the operation resource to wait on.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private 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`.
+ /// The maximum duration to wait before timing out. If left blank, the wait will be at most the time
+ /// permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the
+ /// shorter one will be used.
///
- public class CancelRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Cancel request.
- public CancelRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
-
- /// The name of the operation resource to be cancelled.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ [Google.Apis.Util.RequestParameterAttribute("timeout", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual object Timeout { get; set; }
- /// Gets the method name.
- public override string MethodName => "cancel";
+ /// Gets the method name.
+ public override string MethodName => "wait";
- /// Gets the HTTP method.
- public override string HttpMethod => "POST";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "POST";
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}:cancel";
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}:wait";
- /// Initializes Cancel parameter list.
- protected override void InitParameters()
+ /// Initializes Wait parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$",
- });
- }
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$",
+ });
+ RequestParameters.Add("timeout", new Google.Apis.Discovery.Parameter
+ {
+ Name = "timeout",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
}
+ }
+ }
+ }
- ///
- /// Deletes a long-running operation. This method indicates that the client is no longer interested
- /// in the operation result. It does not cancel the operation. If the server doesn't support this
- /// method, it returns `google.rpc.Code.UNIMPLEMENTED`.
- ///
- /// The name of the operation resource to be deleted.
- public virtual DeleteRequest Delete(string name)
- {
- return new DeleteRequest(this.service, name);
- }
+ /// Creates a Dataset.
+ /// The body of the request.
+ public virtual CreateRequest Create(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1Dataset body)
+ {
+ return new CreateRequest(this.service, body);
+ }
- ///
- /// Deletes a long-running operation. This method indicates that the client is no longer interested
- /// in the operation result. It does not cancel the operation. If the server doesn't support this
- /// method, it returns `google.rpc.Code.UNIMPLEMENTED`.
- ///
- public class DeleteRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Delete request.
- public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ /// Creates a Dataset.
+ public class CreateRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Create request.
+ public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1Dataset body) : base(service)
+ {
+ Body = body;
+ InitParameters();
+ }
- /// The name of the operation resource to be deleted.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ ///
+ /// Required. The resource name of the Location to create the Dataset in. Format:
+ /// `projects/{project}/locations/{location}`
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string Parent { get; set; }
- /// Gets the method name.
- public override string MethodName => "delete";
+ /// Gets or sets the body of this request.
+ Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1Dataset Body { get; set; }
- /// Gets the HTTP method.
- public override string HttpMethod => "DELETE";
+ /// Returns the body of the request.
+ protected override object GetBody() => Body;
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}";
+ /// Gets the method name.
+ public override string MethodName => "create";
- /// Initializes Delete parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$",
- });
- }
- }
+ /// Gets the HTTP method.
+ public override string HttpMethod => "POST";
- ///
- /// Gets the latest 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.
- public virtual GetRequest Get(string name)
- {
- return new GetRequest(this.service, name);
- }
+ /// Gets the REST path.
+ public override string RestPath => "v1/datasets";
- ///
- /// Gets the latest state of a long-running operation. Clients can use this method to poll the
- /// operation result at intervals as recommended by the API service.
- ///
- public class GetRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Get request.
- public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ /// Initializes Create parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
+ {
+ Name = "parent",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ }
+ }
- /// The name of the operation resource.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ /// Deletes a Dataset.
+ ///
+ /// Required. The resource name of the Dataset to delete. Format:
+ /// `projects/{project}/locations/{location}/datasets/{dataset}`
+ ///
+ public virtual DeleteRequest Delete(string name)
+ {
+ return new DeleteRequest(this.service, name);
+ }
- /// Gets the method name.
- public override string MethodName => "get";
+ /// Deletes a Dataset.
+ public class DeleteRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Delete request.
+ public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// Gets the HTTP method.
- public override string HttpMethod => "GET";
+ ///
+ /// Required. The resource name of the Dataset to delete. Format:
+ /// `projects/{project}/locations/{location}/datasets/{dataset}`
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}";
+ /// Gets the method name.
+ public override string MethodName => "delete";
- /// Initializes Get parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$",
- });
- }
- }
+ /// Gets the HTTP method.
+ public override string HttpMethod => "DELETE";
- ///
- /// Lists operations that match the specified filter in the request. If the server doesn't support
- /// this method, it returns `UNIMPLEMENTED`.
- ///
- /// The name of the operation's parent resource.
- public virtual ListRequest List(string name)
- {
- return new ListRequest(this.service, name);
- }
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}";
- ///
- /// Lists operations that match the specified filter in the request. If the server doesn't support
- /// this method, it returns `UNIMPLEMENTED`.
- ///
- public class ListRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new List request.
- public ListRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ /// Initializes Delete parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
+ {
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^datasets/[^/]+$",
+ });
+ }
+ }
- /// The name of the operation's parent resource.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ /// Gets a Dataset.
+ /// Required. The name of the Dataset resource.
+ public virtual GetRequest Get(string name)
+ {
+ return new GetRequest(this.service, name);
+ }
- /// The standard list filter.
- [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string Filter { get; set; }
+ /// Gets a Dataset.
+ public class GetRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Get request.
+ public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// The standard list page size.
- [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
- public virtual System.Nullable PageSize { get; set; }
+ /// Required. The name of the Dataset resource.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// The standard list page token.
- [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string PageToken { get; set; }
+ /// Mask specifying which fields to read.
+ [Google.Apis.Util.RequestParameterAttribute("readMask", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual object ReadMask { get; set; }
- ///
- /// When set to `true`, operations that are reachable are returned as normal, and those that are
- /// unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be
- /// `true` when reading across collections e.g. when `parent` is set to
- /// `"projects/example/locations/-"`. This field is not by default supported and will result in
- /// an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product
- /// specific documentation.
- ///
- [Google.Apis.Util.RequestParameterAttribute("returnPartialSuccess", Google.Apis.Util.RequestParameterType.Query)]
- public virtual System.Nullable ReturnPartialSuccess { get; set; }
+ /// Gets the method name.
+ public override string MethodName => "get";
- /// Gets the method name.
- public override string MethodName => "list";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "GET";
- /// Gets the HTTP method.
- public override string HttpMethod => "GET";
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}";
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}/operations";
+ /// Initializes Get parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
+ {
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^datasets/[^/]+$",
+ });
+ RequestParameters.Add("readMask", new Google.Apis.Discovery.Parameter
+ {
+ Name = "readMask",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ }
+ }
- /// Initializes List parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$",
- });
- RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
- {
- Name = "filter",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
- {
- Name = "pageSize",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
- {
- Name = "pageToken",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("returnPartialSuccess", new Google.Apis.Discovery.Parameter
- {
- Name = "returnPartialSuccess",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- }
- }
+ /// Lists Datasets in a Location.
+ public virtual ListRequest List()
+ {
+ return new ListRequest(this.service);
+ }
- ///
- /// Waits until the specified long-running operation is done or reaches at most a specified timeout,
- /// returning the latest state. If the operation is already done, the latest state is immediately
- /// returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
- /// timeout is used. If the server does not support this method, it returns
- /// `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return
- /// the latest state before the specified timeout (including immediately), meaning even an immediate
- /// response is no guarantee that the operation is done.
- ///
- /// The name of the operation resource to wait on.
- public virtual WaitRequest Wait(string name)
- {
- return new WaitRequest(this.service, name);
- }
+ /// Lists Datasets in a Location.
+ public class ListRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new List request.
+ public ListRequest(Google.Apis.Services.IClientService service) : base(service)
+ {
+ InitParameters();
+ }
- ///
- /// Waits until the specified long-running operation is done or reaches at most a specified timeout,
- /// returning the latest state. If the operation is already done, the latest state is immediately
- /// returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
- /// timeout is used. If the server does not support this method, it returns
- /// `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return
- /// the latest state before the specified timeout (including immediately), meaning even an immediate
- /// response is no guarantee that the operation is done.
- ///
- public class WaitRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Wait request.
- public WaitRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ ///
+ /// 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"`
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string Filter { get; set; }
- /// The name of the operation resource to wait on.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ ///
+ /// 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`
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("orderBy", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string OrderBy { get; set; }
- ///
- /// The maximum duration to wait before timing out. If left blank, the wait will be at most the
- /// time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also
- /// specified, the shorter one will be used.
- ///
- [Google.Apis.Util.RequestParameterAttribute("timeout", Google.Apis.Util.RequestParameterType.Query)]
- public virtual object Timeout { get; set; }
+ /// The standard list page size.
+ [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual System.Nullable PageSize { get; set; }
- /// Gets the method name.
- public override string MethodName => "wait";
+ /// The standard list page token.
+ [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string PageToken { get; set; }
- /// Gets the HTTP method.
- public override string HttpMethod => "POST";
+ ///
+ /// Required. The name of the Dataset's parent resource. Format: `projects/{project}/locations/{location}`
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string Parent { get; set; }
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}:wait";
+ /// Mask specifying which fields to read.
+ [Google.Apis.Util.RequestParameterAttribute("readMask", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual object ReadMask { get; set; }
- /// Initializes Wait parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$",
- });
- RequestParameters.Add("timeout", new Google.Apis.Discovery.Parameter
- {
- Name = "timeout",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- }
- }
- }
+ /// Gets the method name.
+ public override string MethodName => "list";
- /// Cancels a DataLabelingJob. Success of cancellation is not guaranteed.
- /// The body of the request.
- ///
- /// Required. The name of the DataLabelingJob. Format:
- /// `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
- ///
- public virtual CancelRequest Cancel(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1CancelDataLabelingJobRequest body, string name)
- {
- return new CancelRequest(this.service, body, name);
- }
+ /// Gets the HTTP method.
+ public override string HttpMethod => "GET";
- /// Cancels a DataLabelingJob. Success of cancellation is not guaranteed.
- public class CancelRequest : AiplatformBaseServiceRequest
+ /// Gets the REST path.
+ public override string RestPath => "v1/datasets";
+
+ /// Initializes List parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
{
- /// Constructs a new Cancel request.
- public CancelRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1CancelDataLabelingJobRequest body, string name) : base(service)
- {
- Name = name;
- Body = body;
- InitParameters();
- }
+ Name = "filter",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("orderBy", new Google.Apis.Discovery.Parameter
+ {
+ Name = "orderBy",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
+ {
+ Name = "pageSize",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
+ {
+ Name = "pageToken",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
+ {
+ Name = "parent",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("readMask", new Google.Apis.Discovery.Parameter
+ {
+ Name = "readMask",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ }
+ }
- ///
- /// Required. The name of the DataLabelingJob. Format:
- /// `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ /// Updates a Dataset.
+ /// The body of the request.
+ ///
+ /// Output only. Identifier. The resource name of the Dataset. Format:
+ /// `projects/{project}/locations/{location}/datasets/{dataset}`
+ ///
+ public virtual PatchRequest Patch(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1Dataset body, string name)
+ {
+ return new PatchRequest(this.service, body, name);
+ }
- /// Gets or sets the body of this request.
- Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1CancelDataLabelingJobRequest Body { get; set; }
+ /// Updates a Dataset.
+ public class PatchRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Patch request.
+ public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1Dataset body, string name) : base(service)
+ {
+ Name = name;
+ Body = body;
+ InitParameters();
+ }
- /// Returns the body of the request.
- protected override object GetBody() => Body;
+ ///
+ /// Output only. Identifier. The resource name of the Dataset. Format:
+ /// `projects/{project}/locations/{location}/datasets/{dataset}`
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Gets the method name.
- public override string MethodName => "cancel";
+ ///
+ /// Required. The update mask applies to the resource. For the `FieldMask` definition, see
+ /// google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels`
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("updateMask", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual object UpdateMask { get; set; }
- /// Gets the HTTP method.
- public override string HttpMethod => "POST";
+ /// Gets or sets the body of this request.
+ Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1Dataset Body { get; set; }
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}:cancel";
+ /// Returns the body of the request.
+ protected override object GetBody() => Body;
- /// Initializes Cancel parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$",
- });
- }
- }
+ /// Gets the method name.
+ public override string MethodName => "patch";
- /// Creates a DataLabelingJob.
- /// The body of the request.
- ///
- /// Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`
- ///
- public virtual CreateRequest Create(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1DataLabelingJob body, string parent)
- {
- return new CreateRequest(this.service, body, parent);
- }
+ /// Gets the HTTP method.
+ public override string HttpMethod => "PATCH";
- /// Creates a DataLabelingJob.
- public class CreateRequest : AiplatformBaseServiceRequest
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}";
+
+ /// Initializes Patch parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- /// Constructs a new Create request.
- public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1DataLabelingJob body, string parent) : base(service)
- {
- Parent = parent;
- Body = body;
- InitParameters();
- }
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^datasets/[^/]+$",
+ });
+ RequestParameters.Add("updateMask", new Google.Apis.Discovery.Parameter
+ {
+ Name = "updateMask",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ }
+ }
+ }
- ///
- /// Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Parent { get; private set; }
+ /// The "deploymentResourcePools" collection of methods.
+ public class DeploymentResourcePoolsResource
+ {
+ private const string Resource = "deploymentResourcePools";
- /// Gets or sets the body of this request.
- Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1DataLabelingJob Body { get; set; }
+ /// The service which this resource belongs to.
+ private readonly Google.Apis.Services.IClientService service;
- /// Returns the body of the request.
- protected override object GetBody() => Body;
+ /// Constructs a new resource.
+ public DeploymentResourcePoolsResource(Google.Apis.Services.IClientService service)
+ {
+ this.service = service;
+ Operations = new OperationsResource(service);
+ }
- /// Gets the method name.
- public override string MethodName => "create";
+ /// Gets the Operations resource.
+ public virtual OperationsResource Operations { get; }
- /// Gets the HTTP method.
- public override string HttpMethod => "POST";
+ /// The "operations" collection of methods.
+ public class OperationsResource
+ {
+ private const string Resource = "operations";
- /// Gets the REST path.
- public override string RestPath => "v1/{+parent}/dataLabelingJobs";
+ /// The service which this resource belongs to.
+ private readonly Google.Apis.Services.IClientService service;
- /// Initializes Create parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
- {
- Name = "parent",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+$",
- });
- }
- }
+ /// Constructs a new resource.
+ public OperationsResource(Google.Apis.Services.IClientService service)
+ {
+ this.service = service;
+ }
- /// Deletes a DataLabelingJob.
- ///
- /// Required. The name of the DataLabelingJob to be deleted. Format:
- /// `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
- ///
- public virtual DeleteRequest Delete(string name)
- {
- return new DeleteRequest(this.service, name);
- }
+ ///
+ /// Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel
+ /// the operation, but success is not guaranteed. If the server doesn't support this method, it returns
+ /// `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check
+ /// whether the cancellation succeeded or whether the operation completed despite cancellation. On
+ /// successful cancellation, the operation is not deleted; instead, it becomes an operation with an
+ /// Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+ ///
+ /// The name of the operation resource to be cancelled.
+ public virtual CancelRequest Cancel(string name)
+ {
+ return new CancelRequest(this.service, name);
+ }
- /// Deletes a DataLabelingJob.
- public class DeleteRequest : AiplatformBaseServiceRequest
+ ///
+ /// Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel
+ /// the operation, but success is not guaranteed. If the server doesn't support this method, it returns
+ /// `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check
+ /// whether the cancellation succeeded or whether the operation completed despite cancellation. On
+ /// successful cancellation, the operation is not deleted; instead, it becomes an operation with an
+ /// Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+ ///
+ public class CancelRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Cancel request.
+ public CancelRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
- /// Constructs a new Delete request.
- public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ Name = name;
+ InitParameters();
+ }
- ///
- /// Required. The name of the DataLabelingJob to be deleted. Format:
- /// `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ /// The name of the operation resource to be cancelled.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Gets the method name.
- public override string MethodName => "delete";
+ /// Gets the method name.
+ public override string MethodName => "cancel";
- /// Gets the HTTP method.
- public override string HttpMethod => "DELETE";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "POST";
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}";
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}:cancel";
- /// Initializes Delete parameter list.
- protected override void InitParameters()
+ /// Initializes Cancel parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$",
- });
- }
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^deploymentResourcePools/[^/]+/operations/[^/]+$",
+ });
}
+ }
- /// Gets a DataLabelingJob.
- ///
- /// Required. The name of the DataLabelingJob. Format:
- /// `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
- ///
- public virtual GetRequest Get(string name)
- {
- return new GetRequest(this.service, name);
- }
+ ///
+ /// Deletes a long-running operation. This method indicates that the client is no longer interested in the
+ /// operation result. It does not cancel the operation. If the server doesn't support this method, it
+ /// returns `google.rpc.Code.UNIMPLEMENTED`.
+ ///
+ /// The name of the operation resource to be deleted.
+ public virtual DeleteRequest Delete(string name)
+ {
+ return new DeleteRequest(this.service, name);
+ }
- /// Gets a DataLabelingJob.
- public class GetRequest : AiplatformBaseServiceRequest
+ ///
+ /// Deletes a long-running operation. This method indicates that the client is no longer interested in the
+ /// operation result. It does not cancel the operation. If the server doesn't support this method, it
+ /// returns `google.rpc.Code.UNIMPLEMENTED`.
+ ///
+ public class DeleteRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Delete request.
+ public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
- /// Constructs a new Get request.
- public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ Name = name;
+ InitParameters();
+ }
- ///
- /// Required. The name of the DataLabelingJob. Format:
- /// `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ /// The name of the operation resource to be deleted.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Gets the method name.
- public override string MethodName => "get";
+ /// Gets the method name.
+ public override string MethodName => "delete";
- /// Gets the HTTP method.
- public override string HttpMethod => "GET";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "DELETE";
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}";
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}";
- /// Initializes Get parameter list.
- protected override void InitParameters()
+ /// Initializes Delete parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$",
- });
- }
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^deploymentResourcePools/[^/]+/operations/[^/]+$",
+ });
}
+ }
- /// Lists DataLabelingJobs in a Location.
- ///
- /// Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`
- ///
- public virtual ListRequest List(string parent)
+ ///
+ /// Gets the latest 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.
+ public virtual GetRequest Get(string name)
+ {
+ return new GetRequest(this.service, 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.
+ ///
+ public class GetRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Get request.
+ public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
- return new ListRequest(this.service, parent);
+ Name = name;
+ InitParameters();
}
- /// Lists DataLabelingJobs in a Location.
- public class ListRequest : AiplatformBaseServiceRequest
+ /// The name of the operation resource.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
+
+ /// Gets the method name.
+ public override string MethodName => "get";
+
+ /// Gets the HTTP method.
+ public override string HttpMethod => "GET";
+
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}";
+
+ /// Initializes Get parameter list.
+ protected override void InitParameters()
{
- /// Constructs a new List request.
- public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service)
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- Parent = parent;
- InitParameters();
- }
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^deploymentResourcePools/[^/]+/operations/[^/]+$",
+ });
+ }
+ }
- ///
- /// Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Parent { get; private set; }
+ ///
+ /// Lists operations that match the specified filter in the request. If the server doesn't support this
+ /// method, it returns `UNIMPLEMENTED`.
+ ///
+ /// The name of the operation's parent resource.
+ public virtual ListRequest List(string name)
+ {
+ return new ListRequest(this.service, name);
+ }
- ///
- /// 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:*`
- ///
- [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string Filter { get; set; }
+ ///
+ /// Lists operations that match the specified filter in the request. If the server doesn't support this
+ /// method, it returns `UNIMPLEMENTED`.
+ ///
+ public class ListRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new List request.
+ public ListRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- ///
- /// A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc`
- /// after a field name for descending.
- ///
- [Google.Apis.Util.RequestParameterAttribute("orderBy", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string OrderBy { get; set; }
+ /// The name of the operation's parent resource.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// The standard list page size.
- [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
- public virtual System.Nullable PageSize { get; set; }
+ /// The standard list filter.
+ [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string Filter { get; set; }
- /// The standard list page token.
- [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string PageToken { get; set; }
+ /// The standard list page size.
+ [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual System.Nullable PageSize { get; set; }
- ///
- /// 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.
- ///
- [Google.Apis.Util.RequestParameterAttribute("readMask", Google.Apis.Util.RequestParameterType.Query)]
- public virtual object ReadMask { get; set; }
+ /// The standard list page token.
+ [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string PageToken { get; set; }
- /// Gets the method name.
- public override string MethodName => "list";
+ ///
+ /// When set to `true`, operations that are reachable are returned as normal, and those that are
+ /// unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true`
+ /// when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This
+ /// field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless
+ /// explicitly documented otherwise in service or product specific documentation.
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("returnPartialSuccess", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual System.Nullable ReturnPartialSuccess { get; set; }
- /// Gets the HTTP method.
- public override string HttpMethod => "GET";
+ /// Gets the method name.
+ public override string MethodName => "list";
- /// Gets the REST path.
- public override string RestPath => "v1/{+parent}/dataLabelingJobs";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "GET";
- /// Initializes List parameter list.
- protected override void InitParameters()
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}/operations";
+
+ /// Initializes List parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- base.InitParameters();
- RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
- {
- Name = "parent",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+$",
- });
- RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
- {
- Name = "filter",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("orderBy", new Google.Apis.Discovery.Parameter
- {
- Name = "orderBy",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
- {
- Name = "pageSize",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
- {
- Name = "pageToken",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("readMask", new Google.Apis.Discovery.Parameter
- {
- Name = "readMask",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- }
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^deploymentResourcePools/[^/]+$",
+ });
+ RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
+ {
+ Name = "filter",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
+ {
+ Name = "pageSize",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
+ {
+ Name = "pageToken",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("returnPartialSuccess", new Google.Apis.Discovery.Parameter
+ {
+ Name = "returnPartialSuccess",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
}
}
- /// Gets the Datasets resource.
- public virtual DatasetsResource Datasets { get; }
-
- /// The "datasets" collection of methods.
- public class DatasetsResource
+ ///
+ /// Waits until the specified long-running operation is done or reaches at most a specified timeout,
+ /// returning the latest state. If the operation is already done, the latest state is immediately returned.
+ /// If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If
+ /// the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this
+ /// method is on a best-effort basis. It may return the latest state before the specified timeout (including
+ /// immediately), meaning even an immediate response is no guarantee that the operation is done.
+ ///
+ /// The name of the operation resource to wait on.
+ public virtual WaitRequest Wait(string name)
{
- private const string Resource = "datasets";
-
- /// The service which this resource belongs to.
- private readonly Google.Apis.Services.IClientService service;
+ return new WaitRequest(this.service, name);
+ }
- /// Constructs a new resource.
- public DatasetsResource(Google.Apis.Services.IClientService service)
+ ///
+ /// Waits until the specified long-running operation is done or reaches at most a specified timeout,
+ /// returning the latest state. If the operation is already done, the latest state is immediately returned.
+ /// If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If
+ /// the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this
+ /// method is on a best-effort basis. It may return the latest state before the specified timeout (including
+ /// immediately), meaning even an immediate response is no guarantee that the operation is done.
+ ///
+ public class WaitRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Wait request.
+ public WaitRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
- this.service = service;
- AnnotationSpecs = new AnnotationSpecsResource(service);
- DataItems = new DataItemsResource(service);
- DatasetVersions = new DatasetVersionsResource(service);
- Operations = new OperationsResource(service);
- SavedQueries = new SavedQueriesResource(service);
+ Name = name;
+ InitParameters();
}
- /// Gets the AnnotationSpecs resource.
- public virtual AnnotationSpecsResource AnnotationSpecs { get; }
+ /// The name of the operation resource to wait on.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// The "annotationSpecs" collection of methods.
- public class AnnotationSpecsResource
- {
- private const string Resource = "annotationSpecs";
+ ///
+ /// The maximum duration to wait before timing out. If left blank, the wait will be at most the time
+ /// permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the
+ /// shorter one will be used.
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("timeout", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual object Timeout { get; set; }
- /// The service which this resource belongs to.
- private readonly Google.Apis.Services.IClientService service;
+ /// Gets the method name.
+ public override string MethodName => "wait";
- /// Constructs a new resource.
- public AnnotationSpecsResource(Google.Apis.Services.IClientService service)
- {
- this.service = service;
- Operations = new OperationsResource(service);
- }
+ /// Gets the HTTP method.
+ public override string HttpMethod => "POST";
- /// Gets the Operations resource.
- public virtual OperationsResource Operations { get; }
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}:wait";
- /// The "operations" collection of methods.
- public class OperationsResource
+ /// Initializes Wait parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- private const string Resource = "operations";
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^deploymentResourcePools/[^/]+/operations/[^/]+$",
+ });
+ RequestParameters.Add("timeout", new Google.Apis.Discovery.Parameter
+ {
+ Name = "timeout",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ }
+ }
+ }
+ }
- /// The service which this resource belongs to.
- private readonly Google.Apis.Services.IClientService service;
+ /// The "endpoints" collection of methods.
+ public class EndpointsResource
+ {
+ private const string Resource = "endpoints";
- /// Constructs a new resource.
- public OperationsResource(Google.Apis.Services.IClientService service)
- {
- this.service = service;
- }
+ /// The service which this resource belongs to.
+ private readonly Google.Apis.Services.IClientService service;
- ///
- /// Starts asynchronous cancellation on a long-running operation. The server makes a best effort
- /// to cancel the operation, but success is not guaranteed. If the server doesn't support this
- /// method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation
- /// or other methods to check whether the cancellation succeeded or whether the operation
- /// completed despite cancellation. On successful cancellation, the operation is not deleted;
- /// instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code
- /// of `1`, corresponding to `Code.CANCELLED`.
- ///
- /// The name of the operation resource to be cancelled.
- public virtual CancelRequest Cancel(string name)
- {
- return new CancelRequest(this.service, name);
- }
+ /// Constructs a new resource.
+ public EndpointsResource(Google.Apis.Services.IClientService service)
+ {
+ this.service = service;
+ Chat = new ChatResource(service);
+ Operations = new OperationsResource(service);
+ }
- ///
- /// Starts asynchronous cancellation on a long-running operation. The server makes a best effort
- /// to cancel the operation, but success is not guaranteed. If the server doesn't support this
- /// method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation
- /// or other methods to check whether the cancellation succeeded or whether the operation
- /// completed despite cancellation. On successful cancellation, the operation is not deleted;
- /// instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code
- /// of `1`, corresponding to `Code.CANCELLED`.
- ///
- public class CancelRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Cancel request.
- public CancelRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ /// Gets the Chat resource.
+ public virtual ChatResource Chat { get; }
- /// The name of the operation resource to be cancelled.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ /// The "chat" collection of methods.
+ public class ChatResource
+ {
+ private const string Resource = "chat";
- /// Gets the method name.
- public override string MethodName => "cancel";
+ /// The service which this resource belongs to.
+ private readonly Google.Apis.Services.IClientService service;
- /// Gets the HTTP method.
- public override string HttpMethod => "POST";
+ /// Constructs a new resource.
+ public ChatResource(Google.Apis.Services.IClientService service)
+ {
+ this.service = service;
+ }
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}:cancel";
+ /// Exposes an OpenAI-compatible endpoint for chat completions.
+ /// The body of the request.
+ ///
+ /// Required. The name of the endpoint requested to serve the prediction. Format:
+ /// `projects/{project}/locations/{location}/endpoints/{endpoint}`
+ ///
+ public virtual CompletionsRequest Completions(Google.Apis.Aiplatform.v1.Data.GoogleApiHttpBody body, string endpoint)
+ {
+ return new CompletionsRequest(this.service, body, endpoint);
+ }
- /// Initializes Cancel parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$",
- });
- }
- }
+ /// Exposes an OpenAI-compatible endpoint for chat completions.
+ public class CompletionsRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Completions request.
+ public CompletionsRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleApiHttpBody body, string endpoint) : base(service)
+ {
+ Endpoint = endpoint;
+ Body = body;
+ InitParameters();
+ }
- ///
- /// Deletes a long-running operation. This method indicates that the client is no longer
- /// interested in the operation result. It does not cancel the operation. If the server doesn't
- /// support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
- ///
- /// The name of the operation resource to be deleted.
- public virtual DeleteRequest Delete(string name)
- {
- return new DeleteRequest(this.service, name);
- }
+ ///
+ /// Required. The name of the endpoint requested to serve the prediction. Format:
+ /// `projects/{project}/locations/{location}/endpoints/{endpoint}`
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("endpoint", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Endpoint { get; private 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`.
- ///
- public class DeleteRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Delete request.
- public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ /// Gets or sets the body of this request.
+ Google.Apis.Aiplatform.v1.Data.GoogleApiHttpBody Body { get; set; }
- /// The name of the operation resource to be deleted.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
-
- /// Gets the method name.
- public override string MethodName => "delete";
-
- /// Gets the HTTP method.
- public override string HttpMethod => "DELETE";
+ /// Returns the body of the request.
+ protected override object GetBody() => Body;
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}";
+ /// Gets the method name.
+ public override string MethodName => "completions";
- /// Initializes Delete parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$",
- });
- }
- }
+ /// Gets the HTTP method.
+ public override string HttpMethod => "POST";
- ///
- /// Gets the latest 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.
- public virtual GetRequest Get(string name)
- {
- return new GetRequest(this.service, name);
- }
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+endpoint}/chat/completions";
- ///
- /// Gets the latest state of a long-running operation. Clients can use this method to poll the
- /// operation result at intervals as recommended by the API service.
- ///
- public class GetRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Get request.
- public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ /// Initializes Completions parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("endpoint", new Google.Apis.Discovery.Parameter
+ {
+ Name = "endpoint",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^endpoints/[^/]+$",
+ });
+ }
+ }
+ }
- /// The name of the operation resource.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ /// Gets the Operations resource.
+ public virtual OperationsResource Operations { get; }
- /// Gets the method name.
- public override string MethodName => "get";
+ /// The "operations" collection of methods.
+ public class OperationsResource
+ {
+ private const string Resource = "operations";
- /// Gets the HTTP method.
- public override string HttpMethod => "GET";
+ /// The service which this resource belongs to.
+ private readonly Google.Apis.Services.IClientService service;
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}";
+ /// Constructs a new resource.
+ public OperationsResource(Google.Apis.Services.IClientService service)
+ {
+ this.service = service;
+ }
- /// Initializes Get parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$",
- });
- }
- }
+ ///
+ /// Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel
+ /// the operation, but success is not guaranteed. If the server doesn't support this method, it returns
+ /// `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check
+ /// whether the cancellation succeeded or whether the operation completed despite cancellation. On
+ /// successful cancellation, the operation is not deleted; instead, it becomes an operation with an
+ /// Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+ ///
+ /// The name of the operation resource to be cancelled.
+ public virtual CancelRequest Cancel(string name)
+ {
+ return new CancelRequest(this.service, name);
+ }
- ///
- /// Lists operations that match the specified filter in the request. If the server doesn't
- /// support this method, it returns `UNIMPLEMENTED`.
- ///
- /// The name of the operation's parent resource.
- public virtual ListRequest List(string name)
- {
- return new ListRequest(this.service, name);
- }
+ ///
+ /// Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel
+ /// the operation, but success is not guaranteed. If the server doesn't support this method, it returns
+ /// `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check
+ /// whether the cancellation succeeded or whether the operation completed despite cancellation. On
+ /// successful cancellation, the operation is not deleted; instead, it becomes an operation with an
+ /// Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+ ///
+ public class CancelRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Cancel request.
+ public CancelRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- ///
- /// Lists operations that match the specified filter in the request. If the server doesn't
- /// support this method, it returns `UNIMPLEMENTED`.
- ///
- public class ListRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new List request.
- public ListRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ /// The name of the operation resource to be cancelled.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// The name of the operation's parent resource.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ /// Gets the method name.
+ public override string MethodName => "cancel";
- /// The standard list filter.
- [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string Filter { get; set; }
+ /// Gets the HTTP method.
+ public override string HttpMethod => "POST";
- /// The standard list page size.
- [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
- public virtual System.Nullable PageSize { get; set; }
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}:cancel";
- /// The standard list page token.
- [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string PageToken { get; set; }
+ /// Initializes Cancel parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
+ {
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^endpoints/[^/]+/operations/[^/]+$",
+ });
+ }
+ }
- ///
- /// When set to `true`, operations that are reachable are returned as normal, and those that
- /// are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can
- /// only be `true` when reading across collections e.g. when `parent` is set to
- /// `"projects/example/locations/-"`. This field is not by default supported and will result
- /// in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or
- /// product specific documentation.
- ///
- [Google.Apis.Util.RequestParameterAttribute("returnPartialSuccess", Google.Apis.Util.RequestParameterType.Query)]
- public virtual System.Nullable ReturnPartialSuccess { get; 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`.
+ ///
+ /// The name of the operation resource to be deleted.
+ public virtual DeleteRequest Delete(string name)
+ {
+ return new DeleteRequest(this.service, name);
+ }
- /// Gets the method name.
- public override string MethodName => "list";
+ ///
+ /// Deletes a long-running operation. This method indicates that the client is no longer interested in the
+ /// operation result. It does not cancel the operation. If the server doesn't support this method, it
+ /// returns `google.rpc.Code.UNIMPLEMENTED`.
+ ///
+ public class DeleteRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Delete request.
+ public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// Gets the HTTP method.
- public override string HttpMethod => "GET";
+ /// The name of the operation resource to be deleted.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}/operations";
+ /// Gets the method name.
+ public override string MethodName => "delete";
- /// Initializes List parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+$",
- });
- RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
- {
- Name = "filter",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
- {
- Name = "pageSize",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
- {
- Name = "pageToken",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("returnPartialSuccess", new Google.Apis.Discovery.Parameter
- {
- Name = "returnPartialSuccess",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- }
- }
+ /// Gets the HTTP method.
+ public override string HttpMethod => "DELETE";
- ///
- /// Waits until the specified long-running operation is done or reaches at most a specified
- /// timeout, returning the latest state. If the operation is already done, the latest state is
- /// immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout,
- /// the HTTP/RPC timeout is used. If the server does not support this method, it returns
- /// `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may
- /// return the latest state before the specified timeout (including immediately), meaning even
- /// an immediate response is no guarantee that the operation is done.
- ///
- /// The name of the operation resource to wait on.
- public virtual WaitRequest Wait(string name)
- {
- return new WaitRequest(this.service, name);
- }
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+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.
- ///
- public class WaitRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Wait request.
- public WaitRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ /// Initializes Delete parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
+ {
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^endpoints/[^/]+/operations/[^/]+$",
+ });
+ }
+ }
- /// The name of the operation resource to wait on.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private 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.
+ ///
+ /// The name of the operation resource.
+ public virtual GetRequest Get(string name)
+ {
+ return new GetRequest(this.service, name);
+ }
- ///
- /// The maximum duration to wait before timing out. If left blank, the wait will be at most
- /// the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also
- /// specified, the shorter one will be used.
- ///
- [Google.Apis.Util.RequestParameterAttribute("timeout", Google.Apis.Util.RequestParameterType.Query)]
- public virtual object Timeout { get; 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.
+ ///
+ public class GetRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Get request.
+ public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// Gets the method name.
- public override string MethodName => "wait";
+ /// The name of the operation resource.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Gets the HTTP method.
- public override string HttpMethod => "POST";
+ /// Gets the method name.
+ public override string MethodName => "get";
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}:wait";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "GET";
- /// Initializes Wait parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$",
- });
- RequestParameters.Add("timeout", new Google.Apis.Discovery.Parameter
- {
- Name = "timeout",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- }
- }
- }
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}";
- /// Gets an AnnotationSpec.
- ///
- /// Required. The name of the AnnotationSpec resource. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}`
- ///
- public virtual GetRequest Get(string name)
+ /// Initializes Get parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- return new GetRequest(this.service, name);
- }
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^endpoints/[^/]+/operations/[^/]+$",
+ });
+ }
+ }
- /// Gets an AnnotationSpec.
- public class GetRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Get request.
- public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ ///
+ /// Lists operations that match the specified filter in the request. If the server doesn't support this
+ /// method, it returns `UNIMPLEMENTED`.
+ ///
+ /// The name of the operation's parent resource.
+ public virtual ListRequest List(string name)
+ {
+ return new ListRequest(this.service, name);
+ }
- ///
- /// Required. The name of the AnnotationSpec resource. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ ///
+ /// Lists operations that match the specified filter in the request. If the server doesn't support this
+ /// method, it returns `UNIMPLEMENTED`.
+ ///
+ public class ListRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new List request.
+ public ListRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// Mask specifying which fields to read.
- [Google.Apis.Util.RequestParameterAttribute("readMask", Google.Apis.Util.RequestParameterType.Query)]
- public virtual object ReadMask { get; set; }
+ /// The name of the operation's parent resource.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Gets the method name.
- public override string MethodName => "get";
+ /// The standard list filter.
+ [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string Filter { get; set; }
- /// Gets the HTTP method.
- public override string HttpMethod => "GET";
+ /// The standard list page size.
+ [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual System.Nullable PageSize { get; set; }
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}";
+ /// The standard list page token.
+ [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string PageToken { get; set; }
- /// Initializes Get parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+$",
- });
- RequestParameters.Add("readMask", new Google.Apis.Discovery.Parameter
- {
- Name = "readMask",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- }
- }
- }
+ ///
+ /// When set to `true`, operations that are reachable are returned as normal, and those that are
+ /// unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true`
+ /// when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This
+ /// field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless
+ /// explicitly documented otherwise in service or product specific documentation.
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("returnPartialSuccess", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual System.Nullable ReturnPartialSuccess { get; set; }
- /// Gets the DataItems resource.
- public virtual DataItemsResource DataItems { get; }
+ /// Gets the method name.
+ public override string MethodName => "list";
- /// The "dataItems" collection of methods.
- public class DataItemsResource
- {
- private const string Resource = "dataItems";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "GET";
- /// The service which this resource belongs to.
- private readonly Google.Apis.Services.IClientService service;
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}/operations";
- /// Constructs a new resource.
- public DataItemsResource(Google.Apis.Services.IClientService service)
+ /// Initializes List parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- this.service = service;
- Annotations = new AnnotationsResource(service);
- Operations = new OperationsResource(service);
- }
-
- /// Gets the Annotations resource.
- public virtual AnnotationsResource Annotations { get; }
-
- /// The "annotations" collection of methods.
- public class AnnotationsResource
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^endpoints/[^/]+$",
+ });
+ RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
{
- private const string Resource = "annotations";
+ Name = "filter",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
+ {
+ Name = "pageSize",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
+ {
+ Name = "pageToken",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("returnPartialSuccess", new Google.Apis.Discovery.Parameter
+ {
+ Name = "returnPartialSuccess",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ }
+ }
- /// The service which this resource belongs to.
- private readonly Google.Apis.Services.IClientService service;
+ ///
+ /// Waits until the specified long-running operation is done or reaches at most a specified timeout,
+ /// returning the latest state. If the operation is already done, the latest state is immediately returned.
+ /// If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If
+ /// the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this
+ /// method is on a best-effort basis. It may return the latest state before the specified timeout (including
+ /// immediately), meaning even an immediate response is no guarantee that the operation is done.
+ ///
+ /// The name of the operation resource to wait on.
+ public virtual WaitRequest Wait(string name)
+ {
+ return new WaitRequest(this.service, name);
+ }
- /// Constructs a new resource.
- public AnnotationsResource(Google.Apis.Services.IClientService service)
- {
- this.service = service;
- Operations = new OperationsResource(service);
- }
+ ///
+ /// Waits until the specified long-running operation is done or reaches at most a specified timeout,
+ /// returning the latest state. If the operation is already done, the latest state is immediately returned.
+ /// If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If
+ /// the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this
+ /// method is on a best-effort basis. It may return the latest state before the specified timeout (including
+ /// immediately), meaning even an immediate response is no guarantee that the operation is done.
+ ///
+ public class WaitRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Wait request.
+ public WaitRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// Gets the Operations resource.
- public virtual OperationsResource Operations { get; }
+ /// The name of the operation resource to wait on.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// The "operations" collection of methods.
- public class OperationsResource
- {
- private const string Resource = "operations";
+ ///
+ /// The maximum duration to wait before timing out. If left blank, the wait will be at most the time
+ /// permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the
+ /// shorter one will be used.
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("timeout", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual object Timeout { get; set; }
- /// The service which this resource belongs to.
- private readonly Google.Apis.Services.IClientService service;
+ /// Gets the method name.
+ public override string MethodName => "wait";
- /// Constructs a new resource.
- public OperationsResource(Google.Apis.Services.IClientService service)
- {
- this.service = service;
- }
+ /// Gets the HTTP method.
+ public override string HttpMethod => "POST";
- ///
- /// Starts asynchronous cancellation on a long-running operation. The server makes a best
- /// effort to cancel the operation, but success is not guaranteed. If the server doesn't
- /// support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use
- /// Operations.GetOperation or other methods to check whether the cancellation succeeded or
- /// whether the operation completed despite cancellation. On successful cancellation, the
- /// operation is not deleted; instead, it becomes an operation with an Operation.error value
- /// with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
- ///
- /// The name of the operation resource to be cancelled.
- public virtual CancelRequest Cancel(string name)
- {
- return new CancelRequest(this.service, name);
- }
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}:wait";
- ///
- /// Starts asynchronous cancellation on a long-running operation. The server makes a best
- /// effort to cancel the operation, but success is not guaranteed. If the server doesn't
- /// support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use
- /// Operations.GetOperation or other methods to check whether the cancellation succeeded or
- /// whether the operation completed despite cancellation. On successful cancellation, the
- /// operation is not deleted; instead, it becomes an operation with an Operation.error value
- /// with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
- ///
- public class CancelRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Cancel request.
- public CancelRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ /// Initializes Wait parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
+ {
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^endpoints/[^/]+/operations/[^/]+$",
+ });
+ RequestParameters.Add("timeout", new Google.Apis.Discovery.Parameter
+ {
+ Name = "timeout",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ }
+ }
+ }
- /// The name of the operation resource to be cancelled.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ /// Return a list of tokens based on the input text.
+ /// The body of the request.
+ ///
+ /// Required. The name of the Endpoint requested to get lists of tokens and token ids.
+ ///
+ public virtual ComputeTokensRequest ComputeTokens(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1ComputeTokensRequest body, string endpoint)
+ {
+ return new ComputeTokensRequest(this.service, body, endpoint);
+ }
- /// Gets the method name.
- public override string MethodName => "cancel";
+ /// Return a list of tokens based on the input text.
+ public class ComputeTokensRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new ComputeTokens request.
+ public ComputeTokensRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1ComputeTokensRequest body, string endpoint) : base(service)
+ {
+ Endpoint = endpoint;
+ Body = body;
+ InitParameters();
+ }
- /// Gets the HTTP method.
- public override string HttpMethod => "POST";
+ /// Required. The name of the Endpoint requested to get lists of tokens and token ids.
+ [Google.Apis.Util.RequestParameterAttribute("endpoint", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Endpoint { get; private set; }
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}:cancel";
+ /// Gets or sets the body of this request.
+ Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1ComputeTokensRequest Body { get; set; }
- /// Initializes Cancel parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$",
- });
- }
- }
+ /// Returns the body of the request.
+ protected override object GetBody() => Body;
- ///
- /// Deletes a long-running operation. This method indicates that the client is no longer
- /// interested in the operation result. It does not cancel the operation. If the server
- /// doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
- ///
- /// The name of the operation resource to be deleted.
- public virtual DeleteRequest Delete(string name)
- {
- return new DeleteRequest(this.service, name);
- }
+ /// Gets the method name.
+ public override string MethodName => "computeTokens";
- ///
- /// Deletes a long-running operation. This method indicates that the client is no longer
- /// interested in the operation result. It does not cancel the operation. If the server
- /// doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
- ///
- public class DeleteRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Delete request.
- public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ /// Gets the HTTP method.
+ public override string HttpMethod => "POST";
- /// The name of the operation resource to be deleted.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+endpoint}:computeTokens";
- /// Gets the method name.
- public override string MethodName => "delete";
+ /// Initializes ComputeTokens parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("endpoint", new Google.Apis.Discovery.Parameter
+ {
+ Name = "endpoint",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^endpoints/[^/]+$",
+ });
+ }
+ }
- /// Gets the HTTP method.
- public override string HttpMethod => "DELETE";
+ /// Perform a token counting.
+ /// The body of the request.
+ ///
+ /// Required. The name of the Endpoint requested to perform token counting. Format:
+ /// `projects/{project}/locations/{location}/endpoints/{endpoint}`
+ ///
+ public virtual CountTokensRequest CountTokens(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1CountTokensRequest body, string endpoint)
+ {
+ return new CountTokensRequest(this.service, body, endpoint);
+ }
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}";
+ /// Perform a token counting.
+ public class CountTokensRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new CountTokens request.
+ public CountTokensRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1CountTokensRequest body, string endpoint) : base(service)
+ {
+ Endpoint = endpoint;
+ Body = body;
+ InitParameters();
+ }
- /// Initializes Delete parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$",
- });
- }
- }
+ ///
+ /// Required. The name of the Endpoint requested to perform token counting. Format:
+ /// `projects/{project}/locations/{location}/endpoints/{endpoint}`
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("endpoint", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Endpoint { get; private 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.
- ///
- /// The name of the operation resource.
- public virtual GetRequest Get(string name)
- {
- return new GetRequest(this.service, name);
- }
+ /// Gets or sets the body of this request.
+ Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1CountTokensRequest Body { get; 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.
- ///
- public class GetRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Get request.
- public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ /// Returns the body of the request.
+ protected override object GetBody() => Body;
- /// The name of the operation resource.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ /// Gets the method name.
+ public override string MethodName => "countTokens";
- /// Gets the method name.
- public override string MethodName => "get";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "POST";
- /// Gets the HTTP method.
- public override string HttpMethod => "GET";
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+endpoint}:countTokens";
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}";
+ /// Initializes CountTokens parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("endpoint", new Google.Apis.Discovery.Parameter
+ {
+ Name = "endpoint",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^endpoints/[^/]+$",
+ });
+ }
+ }
- /// Initializes Get parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$",
- });
- }
- }
+ /// Fetch an asynchronous online prediction operation.
+ /// The body of the request.
+ ///
+ /// 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}`
+ ///
+ public virtual FetchPredictOperationRequest FetchPredictOperation(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1FetchPredictOperationRequest body, string endpoint)
+ {
+ return new FetchPredictOperationRequest(this.service, body, endpoint);
+ }
- ///
- /// Lists operations that match the specified filter in the request. If the server doesn't
- /// support this method, it returns `UNIMPLEMENTED`.
- ///
- /// The name of the operation's parent resource.
- public virtual ListRequest List(string name)
- {
- return new ListRequest(this.service, name);
- }
+ /// Fetch an asynchronous online prediction operation.
+ public class FetchPredictOperationRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new FetchPredictOperation request.
+ public FetchPredictOperationRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1FetchPredictOperationRequest body, string endpoint) : base(service)
+ {
+ Endpoint = endpoint;
+ Body = body;
+ InitParameters();
+ }
- ///
- /// Lists operations that match the specified filter in the request. If the server doesn't
- /// support this method, it returns `UNIMPLEMENTED`.
- ///
- public class ListRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new List request.
- public ListRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ ///
+ /// 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}`
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("endpoint", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Endpoint { get; private set; }
- /// The name of the operation's parent resource.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ /// Gets or sets the body of this request.
+ Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1FetchPredictOperationRequest Body { get; set; }
- /// The standard list filter.
- [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string Filter { get; set; }
+ /// Returns the body of the request.
+ protected override object GetBody() => Body;
- /// The standard list page size.
- [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
- public virtual System.Nullable PageSize { get; set; }
+ /// Gets the method name.
+ public override string MethodName => "fetchPredictOperation";
- /// The standard list page token.
- [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string PageToken { get; set; }
+ /// Gets the HTTP method.
+ public override string HttpMethod => "POST";
- ///
- /// When set to `true`, operations that are reachable are returned as normal, and those
- /// that are unreachable are returned in the [ListOperationsResponse.unreachable] field.
- /// This can only be `true` when reading across collections e.g. when `parent` is set to
- /// `"projects/example/locations/-"`. This field is not by default supported and will
- /// result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
- /// service or product specific documentation.
- ///
- [Google.Apis.Util.RequestParameterAttribute("returnPartialSuccess", Google.Apis.Util.RequestParameterType.Query)]
- public virtual System.Nullable ReturnPartialSuccess { get; set; }
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+endpoint}:fetchPredictOperation";
- /// Gets the method name.
- public override string MethodName => "list";
+ /// Initializes FetchPredictOperation parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("endpoint", new Google.Apis.Discovery.Parameter
+ {
+ Name = "endpoint",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^endpoints/[^/]+$",
+ });
+ }
+ }
- /// Gets the HTTP method.
- public override string HttpMethod => "GET";
+ /// Generate content with multimodal inputs.
+ /// The body of the request.
+ ///
+ /// 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}`
+ ///
+ public virtual GenerateContentRequest GenerateContent(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1GenerateContentRequest body, string model)
+ {
+ return new GenerateContentRequest(this.service, body, model);
+ }
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}/operations";
+ /// Generate content with multimodal inputs.
+ public class GenerateContentRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new GenerateContent request.
+ public GenerateContentRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1GenerateContentRequest body, string model) : base(service)
+ {
+ Model = model;
+ Body = body;
+ InitParameters();
+ }
- /// Initializes List parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+$",
- });
- RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
- {
- Name = "filter",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
- {
- Name = "pageSize",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
- {
- Name = "pageToken",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("returnPartialSuccess", new Google.Apis.Discovery.Parameter
- {
- Name = "returnPartialSuccess",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- }
- }
+ ///
+ /// 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}`
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("model", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Model { get; private 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.
- ///
- /// The name of the operation resource to wait on.
- public virtual WaitRequest Wait(string name)
- {
- return new WaitRequest(this.service, name);
- }
+ /// Gets or sets the body of this request.
+ Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1GenerateContentRequest Body { get; 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.
- ///
- public class WaitRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Wait request.
- public WaitRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ /// Returns the body of the request.
+ protected override object GetBody() => Body;
- /// The name of the operation resource to wait on.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ /// Gets the method name.
+ public override string MethodName => "generateContent";
- ///
- /// The maximum duration to wait before timing out. If left blank, the wait will be at
- /// most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline
- /// is also specified, the shorter one will be used.
- ///
- [Google.Apis.Util.RequestParameterAttribute("timeout", Google.Apis.Util.RequestParameterType.Query)]
- public virtual object Timeout { get; set; }
+ /// Gets the HTTP method.
+ public override string HttpMethod => "POST";
- /// Gets the method name.
- public override string MethodName => "wait";
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+model}:generateContent";
- /// Gets the HTTP method.
- public override string HttpMethod => "POST";
+ /// Initializes GenerateContent parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("model", new Google.Apis.Discovery.Parameter
+ {
+ Name = "model",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^endpoints/[^/]+$",
+ });
+ }
+ }
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}:wait";
+ /// Perform an online prediction.
+ /// The body of the request.
+ ///
+ /// Required. The name of the Endpoint requested to serve the prediction. Format:
+ /// `projects/{project}/locations/{location}/endpoints/{endpoint}`
+ ///
+ public virtual PredictRequest Predict(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1PredictRequest body, string endpoint)
+ {
+ return new PredictRequest(this.service, body, endpoint);
+ }
- /// Initializes Wait parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$",
- });
- RequestParameters.Add("timeout", new Google.Apis.Discovery.Parameter
- {
- Name = "timeout",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- }
- }
- }
+ /// Perform an online prediction.
+ public class PredictRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Predict request.
+ public PredictRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1PredictRequest body, string endpoint) : base(service)
+ {
+ Endpoint = endpoint;
+ Body = body;
+ InitParameters();
+ }
- /// Lists Annotations belongs to a dataitem.
- ///
- /// Required. The resource name of the DataItem to list Annotations from. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}`
- ///
- public virtual ListRequest List(string parent)
- {
- return new ListRequest(this.service, parent);
- }
+ ///
+ /// Required. The name of the Endpoint requested to serve the prediction. Format:
+ /// `projects/{project}/locations/{location}/endpoints/{endpoint}`
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("endpoint", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Endpoint { get; private set; }
- /// Lists Annotations belongs to a dataitem.
- public class ListRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new List request.
- public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service)
- {
- Parent = parent;
- InitParameters();
- }
+ /// Gets or sets the body of this request.
+ Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1PredictRequest Body { get; set; }
- ///
- /// Required. The resource name of the DataItem to list Annotations from. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Parent { get; private set; }
+ /// Returns the body of the request.
+ protected override object GetBody() => Body;
- /// The standard list filter.
- [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string Filter { get; set; }
+ /// Gets the method name.
+ public override string MethodName => "predict";
- ///
- /// A comma-separated list of fields to order by, sorted in ascending order. Use "desc"
- /// after a field name for descending.
- ///
- [Google.Apis.Util.RequestParameterAttribute("orderBy", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string OrderBy { get; set; }
+ /// Gets the HTTP method.
+ public override string HttpMethod => "POST";
- /// The standard list page size.
- [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
- public virtual System.Nullable PageSize { get; set; }
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+endpoint}:predict";
- /// The standard list page token.
- [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string PageToken { get; set; }
+ /// Initializes Predict parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("endpoint", new Google.Apis.Discovery.Parameter
+ {
+ Name = "endpoint",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^endpoints/[^/]+$",
+ });
+ }
+ }
- /// Mask specifying which fields to read.
- [Google.Apis.Util.RequestParameterAttribute("readMask", Google.Apis.Util.RequestParameterType.Query)]
- public virtual object ReadMask { get; set; }
+ ///
+ /// The body of the request.
+ ///
+ /// 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}`
+ ///
+ public virtual PredictLongRunningRequest PredictLongRunning(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1PredictLongRunningRequest body, string endpoint)
+ {
+ return new PredictLongRunningRequest(this.service, body, endpoint);
+ }
- /// Gets the method name.
- public override string MethodName => "list";
+ ///
+ public class PredictLongRunningRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new PredictLongRunning request.
+ public PredictLongRunningRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1PredictLongRunningRequest body, string endpoint) : base(service)
+ {
+ Endpoint = endpoint;
+ Body = body;
+ InitParameters();
+ }
- /// Gets the HTTP method.
- public override string HttpMethod => "GET";
+ ///
+ /// 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}`
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("endpoint", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Endpoint { get; private set; }
- /// Gets the REST path.
- public override string RestPath => "v1/{+parent}/annotations";
+ /// Gets or sets the body of this request.
+ Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1PredictLongRunningRequest Body { get; set; }
- /// Initializes List parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
- {
- Name = "parent",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+$",
- });
- RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
- {
- Name = "filter",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("orderBy", new Google.Apis.Discovery.Parameter
- {
- Name = "orderBy",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
- {
- Name = "pageSize",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
- {
- Name = "pageToken",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("readMask", new Google.Apis.Discovery.Parameter
- {
- Name = "readMask",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- }
- }
- }
+ /// Returns the body of the request.
+ protected override object GetBody() => Body;
- /// Gets the Operations resource.
- public virtual OperationsResource Operations { get; }
+ /// Gets the method name.
+ public override string MethodName => "predictLongRunning";
- /// The "operations" collection of methods.
- public class OperationsResource
- {
- private const string Resource = "operations";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "POST";
- /// The service which this resource belongs to.
- private readonly Google.Apis.Services.IClientService service;
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+endpoint}:predictLongRunning";
- /// Constructs a new resource.
- public OperationsResource(Google.Apis.Services.IClientService service)
- {
- this.service = service;
- }
+ /// Initializes PredictLongRunning parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("endpoint", new Google.Apis.Discovery.Parameter
+ {
+ Name = "endpoint",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^endpoints/[^/]+$",
+ });
+ }
+ }
- ///
- /// Starts asynchronous cancellation on a long-running operation. The server makes a best effort
- /// to cancel the operation, but success is not guaranteed. If the server doesn't support this
- /// method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation
- /// or other methods to check whether the cancellation succeeded or whether the operation
- /// completed despite cancellation. On successful cancellation, the operation is not deleted;
- /// instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code
- /// of `1`, corresponding to `Code.CANCELLED`.
- ///
- /// The name of the operation resource to be cancelled.
- public virtual CancelRequest Cancel(string name)
- {
- return new CancelRequest(this.service, name);
- }
+ /// Generate content with multimodal inputs with streaming support.
+ /// The body of the request.
+ ///
+ /// 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}`
+ ///
+ public virtual StreamGenerateContentRequest StreamGenerateContent(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1GenerateContentRequest body, string model)
+ {
+ return new StreamGenerateContentRequest(this.service, body, model);
+ }
- ///
- /// Starts asynchronous cancellation on a long-running operation. The server makes a best effort
- /// to cancel the operation, but success is not guaranteed. If the server doesn't support this
- /// method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation
- /// or other methods to check whether the cancellation succeeded or whether the operation
- /// completed despite cancellation. On successful cancellation, the operation is not deleted;
- /// instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code
- /// of `1`, corresponding to `Code.CANCELLED`.
- ///
- public class CancelRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Cancel request.
- public CancelRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ /// Generate content with multimodal inputs with streaming support.
+ public class StreamGenerateContentRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new StreamGenerateContent request.
+ public StreamGenerateContentRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1GenerateContentRequest body, string model) : base(service)
+ {
+ Model = model;
+ Body = body;
+ InitParameters();
+ }
- /// The name of the operation resource to be cancelled.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ ///
+ /// 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}`
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("model", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Model { get; private set; }
- /// Gets the method name.
- public override string MethodName => "cancel";
+ /// Gets or sets the body of this request.
+ Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1GenerateContentRequest Body { get; set; }
- /// Gets the HTTP method.
- public override string HttpMethod => "POST";
+ /// Returns the body of the request.
+ protected override object GetBody() => Body;
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}:cancel";
+ /// Gets the method name.
+ public override string MethodName => "streamGenerateContent";
- /// Initializes Cancel parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$",
- });
- }
- }
+ /// Gets the HTTP method.
+ public override string HttpMethod => "POST";
- ///
- /// Deletes a long-running operation. This method indicates that the client is no longer
- /// interested in the operation result. It does not cancel the operation. If the server doesn't
- /// support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
- ///
- /// The name of the operation resource to be deleted.
- public virtual DeleteRequest Delete(string name)
- {
- return new DeleteRequest(this.service, name);
- }
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+model}:streamGenerateContent";
- ///
- /// Deletes a long-running operation. This method indicates that the client is no longer
- /// interested in the operation result. It does not cancel the operation. If the server doesn't
- /// support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
- ///
- public class DeleteRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Delete request.
- public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ /// Initializes StreamGenerateContent parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("model", new Google.Apis.Discovery.Parameter
+ {
+ Name = "model",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^endpoints/[^/]+$",
+ });
+ }
+ }
+ }
- /// The name of the operation resource to be deleted.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ /// The "featureGroups" collection of methods.
+ public class FeatureGroupsResource
+ {
+ private const string Resource = "featureGroups";
- /// Gets the method name.
- public override string MethodName => "delete";
+ /// The service which this resource belongs to.
+ private readonly Google.Apis.Services.IClientService service;
- /// Gets the HTTP method.
- public override string HttpMethod => "DELETE";
+ /// Constructs a new resource.
+ public FeatureGroupsResource(Google.Apis.Services.IClientService service)
+ {
+ this.service = service;
+ Features = new FeaturesResource(service);
+ Operations = new OperationsResource(service);
+ }
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}";
+ /// Gets the Features resource.
+ public virtual FeaturesResource Features { get; }
- /// Initializes Delete parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$",
- });
- }
- }
+ /// The "features" collection of methods.
+ public class FeaturesResource
+ {
+ private const string Resource = "features";
- ///
- /// Gets the latest 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.
- public virtual GetRequest Get(string name)
- {
- return new GetRequest(this.service, name);
- }
+ /// The service which this resource belongs to.
+ private readonly Google.Apis.Services.IClientService service;
- ///
- /// Gets the latest state of a long-running operation. Clients can use this method to poll the
- /// operation result at intervals as recommended by the API service.
- ///
- public class GetRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Get request.
- public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ /// Constructs a new resource.
+ public FeaturesResource(Google.Apis.Services.IClientService service)
+ {
+ this.service = service;
+ Operations = new OperationsResource(service);
+ }
- /// The name of the operation resource.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ /// Gets the Operations resource.
+ public virtual OperationsResource Operations { get; }
- /// Gets the method name.
- public override string MethodName => "get";
+ /// The "operations" collection of methods.
+ public class OperationsResource
+ {
+ private const string Resource = "operations";
- /// Gets the HTTP method.
- public override string HttpMethod => "GET";
+ /// The service which this resource belongs to.
+ private readonly Google.Apis.Services.IClientService service;
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}";
+ /// Constructs a new resource.
+ public OperationsResource(Google.Apis.Services.IClientService service)
+ {
+ this.service = service;
+ }
- /// Initializes Get parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$",
- });
- }
- }
+ ///
+ /// Deletes a long-running operation. This method indicates that the client is no longer interested in
+ /// the operation result. It does not cancel the operation. If the server doesn't support this method,
+ /// it returns `google.rpc.Code.UNIMPLEMENTED`.
+ ///
+ /// The name of the operation resource to be deleted.
+ public virtual DeleteRequest Delete(string name)
+ {
+ return new DeleteRequest(this.service, name);
+ }
- ///
- /// Lists operations that match the specified filter in the request. If the server doesn't
- /// support this method, it returns `UNIMPLEMENTED`.
- ///
- /// The name of the operation's parent resource.
- public virtual ListRequest List(string name)
- {
- return new ListRequest(this.service, name);
- }
-
- ///
- /// Lists operations that match the specified filter in the request. If the server doesn't
- /// support this method, it returns `UNIMPLEMENTED`.
- ///
- public class ListRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new List request.
- public ListRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
-
- /// The name of the operation's parent resource.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
-
- /// The standard list filter.
- [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string Filter { get; set; }
-
- /// The standard list page size.
- [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
- public virtual System.Nullable PageSize { get; set; }
-
- /// The standard list page token.
- [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string PageToken { get; set; }
-
- ///
- /// When set to `true`, operations that are reachable are returned as normal, and those that
- /// are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can
- /// only be `true` when reading across collections e.g. when `parent` is set to
- /// `"projects/example/locations/-"`. This field is not by default supported and will result
- /// in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or
- /// product specific documentation.
- ///
- [Google.Apis.Util.RequestParameterAttribute("returnPartialSuccess", Google.Apis.Util.RequestParameterType.Query)]
- public virtual System.Nullable ReturnPartialSuccess { get; set; }
-
- /// Gets the method name.
- public override string MethodName => "list";
+ ///
+ /// Deletes a long-running operation. This method indicates that the client is no longer interested in
+ /// the operation result. It does not cancel the operation. If the server doesn't support this method,
+ /// it returns `google.rpc.Code.UNIMPLEMENTED`.
+ ///
+ public class DeleteRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Delete request.
+ public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// Gets the HTTP method.
- public override string HttpMethod => "GET";
+ /// The name of the operation resource to be deleted.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}/operations";
+ /// Gets the method name.
+ public override string MethodName => "delete";
- /// Initializes List parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+$",
- });
- RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
- {
- Name = "filter",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
- {
- Name = "pageSize",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
- {
- Name = "pageToken",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("returnPartialSuccess", new Google.Apis.Discovery.Parameter
- {
- Name = "returnPartialSuccess",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- }
- }
+ /// Gets the HTTP method.
+ public override string HttpMethod => "DELETE";
- ///
- /// Waits until the specified long-running operation is done or reaches at most a specified
- /// timeout, returning the latest state. If the operation is already done, the latest state is
- /// immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout,
- /// the HTTP/RPC timeout is used. If the server does not support this method, it returns
- /// `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may
- /// return the latest state before the specified timeout (including immediately), meaning even
- /// an immediate response is no guarantee that the operation is done.
- ///
- /// The name of the operation resource to wait on.
- public virtual WaitRequest Wait(string name)
- {
- return new WaitRequest(this.service, name);
- }
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+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.
- ///
- public class WaitRequest : AiplatformBaseServiceRequest
+ /// Initializes Delete parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- /// Constructs a new Wait request.
- public WaitRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^featureGroups/[^/]+/features/[^/]+/operations/[^/]+$",
+ });
+ }
+ }
- /// The name of the operation resource to wait on.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private 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.
+ ///
+ /// The name of the operation resource.
+ public virtual GetRequest Get(string name)
+ {
+ return new GetRequest(this.service, name);
+ }
- ///
- /// The maximum duration to wait before timing out. If left blank, the wait will be at most
- /// the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also
- /// specified, the shorter one will be used.
- ///
- [Google.Apis.Util.RequestParameterAttribute("timeout", Google.Apis.Util.RequestParameterType.Query)]
- public virtual object Timeout { get; 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.
+ ///
+ public class GetRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Get request.
+ public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// Gets the method name.
- public override string MethodName => "wait";
+ /// The name of the operation resource.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Gets the HTTP method.
- public override string HttpMethod => "POST";
+ /// Gets the method name.
+ public override string MethodName => "get";
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}:wait";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "GET";
- /// Initializes Wait parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$",
- });
- RequestParameters.Add("timeout", new Google.Apis.Discovery.Parameter
- {
- Name = "timeout",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- }
- }
- }
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}";
- /// Lists DataItems in a Dataset.
- ///
- /// Required. The resource name of the Dataset to list DataItems from. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}`
- ///
- public virtual ListRequest List(string parent)
+ /// Initializes Get parameter list.
+ protected override void InitParameters()
{
- return new ListRequest(this.service, parent);
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
+ {
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^featureGroups/[^/]+/features/[^/]+/operations/[^/]+$",
+ });
}
+ }
- /// Lists DataItems in a Dataset.
- public class ListRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new List request.
- public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service)
- {
- Parent = parent;
- InitParameters();
- }
+ ///
+ /// Lists operations that match the specified filter in the request. If the server doesn't support this
+ /// method, it returns `UNIMPLEMENTED`.
+ ///
+ /// The name of the operation's parent resource.
+ public virtual ListWaitRequest ListWait(string name)
+ {
+ return new ListWaitRequest(this.service, name);
+ }
- ///
- /// Required. The resource name of the Dataset to list DataItems from. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Parent { get; private set; }
+ ///
+ /// Lists operations that match the specified filter in the request. If the server doesn't support this
+ /// method, it returns `UNIMPLEMENTED`.
+ ///
+ public class ListWaitRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new ListWait request.
+ public ListWaitRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// The standard list filter.
- [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string Filter { get; set; }
+ /// The name of the operation's parent resource.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- ///
- /// A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a
- /// field name for descending.
- ///
- [Google.Apis.Util.RequestParameterAttribute("orderBy", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string OrderBy { get; set; }
+ /// The standard list filter.
+ [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string Filter { get; set; }
- /// The standard list page size.
- [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
- public virtual System.Nullable PageSize { get; set; }
+ /// The standard list page size.
+ [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual System.Nullable PageSize { get; set; }
- /// The standard list page token.
- [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string PageToken { get; set; }
+ /// The standard list page token.
+ [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string PageToken { get; set; }
- /// Mask specifying which fields to read.
- [Google.Apis.Util.RequestParameterAttribute("readMask", Google.Apis.Util.RequestParameterType.Query)]
- public virtual object ReadMask { get; set; }
+ ///
+ /// When set to `true`, operations that are reachable are returned as normal, and those that are
+ /// unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be
+ /// `true` when reading across collections e.g. when `parent` is set to
+ /// `"projects/example/locations/-"`. This field is not by default supported and will result in an
+ /// `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product
+ /// specific documentation.
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("returnPartialSuccess", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual System.Nullable ReturnPartialSuccess { get; set; }
- /// Gets the method name.
- public override string MethodName => "list";
+ /// Gets the method name.
+ public override string MethodName => "listWait";
- /// Gets the HTTP method.
- public override string HttpMethod => "GET";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "GET";
- /// Gets the REST path.
- public override string RestPath => "v1/{+parent}/dataItems";
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}:wait";
- /// Initializes List parameter list.
- protected override void InitParameters()
+ /// Initializes ListWait parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- base.InitParameters();
- RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
- {
- Name = "parent",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
- });
- RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
- {
- Name = "filter",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("orderBy", new Google.Apis.Discovery.Parameter
- {
- Name = "orderBy",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
- {
- Name = "pageSize",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
- {
- Name = "pageToken",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("readMask", new Google.Apis.Discovery.Parameter
- {
- Name = "readMask",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- }
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^featureGroups/[^/]+/features/[^/]+/operations/[^/]+$",
+ });
+ RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
+ {
+ Name = "filter",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
+ {
+ Name = "pageSize",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
+ {
+ Name = "pageToken",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("returnPartialSuccess", new Google.Apis.Discovery.Parameter
+ {
+ Name = "returnPartialSuccess",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
}
}
- /// Gets the DatasetVersions resource.
- public virtual DatasetVersionsResource DatasetVersions { get; }
-
- /// The "datasetVersions" collection of methods.
- public class DatasetVersionsResource
+ ///
+ /// Waits until the specified long-running operation is done or reaches at most a specified timeout,
+ /// returning the latest state. If the operation is already done, the latest state is immediately
+ /// returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
+ /// timeout is used. If the server does not support this method, it returns
+ /// `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the
+ /// latest state before the specified timeout (including immediately), meaning even an immediate
+ /// response is no guarantee that the operation is done.
+ ///
+ /// The name of the operation resource to wait on.
+ public virtual WaitRequest Wait(string name)
{
- private const string Resource = "datasetVersions";
-
- /// The service which this resource belongs to.
- private readonly Google.Apis.Services.IClientService service;
-
- /// Constructs a new resource.
- public DatasetVersionsResource(Google.Apis.Services.IClientService service)
- {
- this.service = service;
- }
+ return new WaitRequest(this.service, name);
+ }
- /// Create a version from a Dataset.
- /// The body of the request.
- ///
- /// Required. The name of the Dataset resource. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}`
- ///
- public virtual CreateRequest Create(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1DatasetVersion body, string parent)
+ ///
+ /// Waits until the specified long-running operation is done or reaches at most a specified timeout,
+ /// returning the latest state. If the operation is already done, the latest state is immediately
+ /// returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
+ /// timeout is used. If the server does not support this method, it returns
+ /// `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the
+ /// latest state before the specified timeout (including immediately), meaning even an immediate
+ /// response is no guarantee that the operation is done.
+ ///
+ public class WaitRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Wait request.
+ public WaitRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
- return new CreateRequest(this.service, body, parent);
+ Name = name;
+ InitParameters();
}
- /// Create a version from a Dataset.
- public class CreateRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Create request.
- public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1DatasetVersion body, string parent) : base(service)
- {
- Parent = parent;
- Body = body;
- InitParameters();
- }
+ /// The name of the operation resource to wait on.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- ///
- /// Required. The name of the Dataset resource. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Parent { get; private set; }
+ ///
+ /// The maximum duration to wait before timing out. If left blank, the wait will be at most the time
+ /// permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the
+ /// shorter one will be used.
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("timeout", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual object Timeout { get; set; }
- /// Gets or sets the body of this request.
- Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1DatasetVersion Body { get; set; }
+ /// Gets the method name.
+ public override string MethodName => "wait";
- /// Returns the body of the request.
- protected override object GetBody() => Body;
+ /// Gets the HTTP method.
+ public override string HttpMethod => "POST";
- /// Gets the method name.
- public override string MethodName => "create";
-
- /// Gets the HTTP method.
- public override string HttpMethod => "POST";
-
- /// Gets the REST path.
- public override string RestPath => "v1/{+parent}/datasetVersions";
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}:wait";
- /// Initializes Create parameter list.
- protected override void InitParameters()
+ /// Initializes Wait parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- base.InitParameters();
- RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
- {
- Name = "parent",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
- });
- }
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^featureGroups/[^/]+/features/[^/]+/operations/[^/]+$",
+ });
+ RequestParameters.Add("timeout", new Google.Apis.Discovery.Parameter
+ {
+ Name = "timeout",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
}
+ }
+ }
+ }
- /// Deletes a Dataset version.
- ///
- /// Required. The resource name of the Dataset version to delete. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
- ///
- public virtual DeleteRequest Delete(string name)
- {
- return new DeleteRequest(this.service, name);
- }
+ /// Gets the Operations resource.
+ public virtual OperationsResource Operations { get; }
- /// Deletes a Dataset version.
- public class DeleteRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Delete request.
- public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ /// The "operations" collection of methods.
+ public class OperationsResource
+ {
+ private const string Resource = "operations";
- ///
- /// Required. The resource name of the Dataset version to delete. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ /// The service which this resource belongs to.
+ private readonly Google.Apis.Services.IClientService service;
- /// Gets the method name.
- public override string MethodName => "delete";
+ /// Constructs a new resource.
+ public OperationsResource(Google.Apis.Services.IClientService service)
+ {
+ this.service = service;
+ }
- /// Gets the HTTP method.
- public override string HttpMethod => "DELETE";
+ ///
+ /// Deletes a long-running operation. This method indicates that the client is no longer interested in the
+ /// operation result. It does not cancel the operation. If the server doesn't support this method, it
+ /// returns `google.rpc.Code.UNIMPLEMENTED`.
+ ///
+ /// The name of the operation resource to be deleted.
+ public virtual DeleteRequest Delete(string name)
+ {
+ return new DeleteRequest(this.service, name);
+ }
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}";
+ ///
+ /// Deletes a long-running operation. This method indicates that the client is no longer interested in the
+ /// operation result. It does not cancel the operation. If the server doesn't support this method, it
+ /// returns `google.rpc.Code.UNIMPLEMENTED`.
+ ///
+ public class DeleteRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Delete request.
+ public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// Initializes Delete parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$",
- });
- }
- }
+ /// The name of the operation resource to be deleted.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Gets a Dataset version.
- ///
- /// Required. The resource name of the Dataset version to delete. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
- ///
- public virtual GetRequest Get(string name)
- {
- return new GetRequest(this.service, name);
- }
+ /// Gets the method name.
+ public override string MethodName => "delete";
- /// Gets a Dataset version.
- public class GetRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Get request.
- public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ /// Gets the HTTP method.
+ public override string HttpMethod => "DELETE";
- ///
- /// Required. The resource name of the Dataset version to delete. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}";
- /// Mask specifying which fields to read.
- [Google.Apis.Util.RequestParameterAttribute("readMask", Google.Apis.Util.RequestParameterType.Query)]
- public virtual object ReadMask { get; set; }
+ /// Initializes Delete parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
+ {
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^featureGroups/[^/]+/operations/[^/]+$",
+ });
+ }
+ }
- /// Gets the method name.
- public override string MethodName => "get";
+ ///
+ /// Gets the latest 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.
+ public virtual GetRequest Get(string name)
+ {
+ return new GetRequest(this.service, name);
+ }
- /// Gets the HTTP method.
- public override string HttpMethod => "GET";
+ ///
+ /// Gets the latest state of a long-running operation. Clients can use this method to poll the operation
+ /// result at intervals as recommended by the API service.
+ ///
+ public class GetRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Get request.
+ public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}";
+ /// The name of the operation resource.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Initializes Get parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$",
- });
- RequestParameters.Add("readMask", new Google.Apis.Discovery.Parameter
- {
- Name = "readMask",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- }
- }
+ /// Gets the method name.
+ public override string MethodName => "get";
- /// Lists DatasetVersions in a Dataset.
- ///
- /// Required. The resource name of the Dataset to list DatasetVersions from. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}`
- ///
- public virtual ListRequest List(string parent)
- {
- return new ListRequest(this.service, parent);
- }
+ /// Gets the HTTP method.
+ public override string HttpMethod => "GET";
- /// Lists DatasetVersions in a Dataset.
- public class ListRequest : AiplatformBaseServiceRequest
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}";
+
+ /// Initializes Get parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- /// Constructs a new List request.
- public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service)
- {
- Parent = parent;
- InitParameters();
- }
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^featureGroups/[^/]+/operations/[^/]+$",
+ });
+ }
+ }
- ///
- /// Required. The resource name of the Dataset to list DatasetVersions from. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Parent { get; private set; }
+ ///
+ /// Lists operations that match the specified filter in the request. If the server doesn't support this
+ /// method, it returns `UNIMPLEMENTED`.
+ ///
+ /// The name of the operation's parent resource.
+ public virtual ListWaitRequest ListWait(string name)
+ {
+ return new ListWaitRequest(this.service, name);
+ }
- /// Optional. The standard list filter.
- [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string Filter { get; set; }
+ ///
+ /// Lists operations that match the specified filter in the request. If the server doesn't support this
+ /// method, it returns `UNIMPLEMENTED`.
+ ///
+ public class ListWaitRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new ListWait request.
+ public ListWaitRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- ///
- /// Optional. A comma-separated list of fields to order by, sorted in ascending order. Use
- /// "desc" after a field name for descending.
- ///
- [Google.Apis.Util.RequestParameterAttribute("orderBy", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string OrderBy { get; set; }
+ /// The name of the operation's parent resource.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Optional. The standard list page size.
- [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
- public virtual System.Nullable PageSize { get; set; }
+ /// The standard list filter.
+ [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string Filter { get; set; }
- /// Optional. The standard list page token.
- [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string PageToken { get; set; }
+ /// The standard list page size.
+ [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual System.Nullable PageSize { get; set; }
- /// Optional. Mask specifying which fields to read.
- [Google.Apis.Util.RequestParameterAttribute("readMask", Google.Apis.Util.RequestParameterType.Query)]
- public virtual object ReadMask { get; set; }
+ /// The standard list page token.
+ [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string PageToken { get; set; }
- /// Gets the method name.
- public override string MethodName => "list";
+ ///
+ /// When set to `true`, operations that are reachable are returned as normal, and those that are
+ /// unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true`
+ /// when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This
+ /// field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless
+ /// explicitly documented otherwise in service or product specific documentation.
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("returnPartialSuccess", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual System.Nullable ReturnPartialSuccess { get; set; }
- /// Gets the HTTP method.
- public override string HttpMethod => "GET";
+ /// Gets the method name.
+ public override string MethodName => "listWait";
- /// Gets the REST path.
- public override string RestPath => "v1/{+parent}/datasetVersions";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "GET";
- /// Initializes List parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
- {
- Name = "parent",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
- });
- RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
- {
- Name = "filter",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("orderBy", new Google.Apis.Discovery.Parameter
- {
- Name = "orderBy",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
- {
- Name = "pageSize",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
- {
- Name = "pageToken",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("readMask", new Google.Apis.Discovery.Parameter
- {
- Name = "readMask",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- }
- }
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}:wait";
- /// Updates a DatasetVersion.
- /// The body of the request.
- ///
- /// Output only. Identifier. The resource name of the DatasetVersion. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
- ///
- public virtual PatchRequest Patch(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1DatasetVersion body, string name)
+ /// Initializes ListWait parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- return new PatchRequest(this.service, body, name);
- }
-
- /// Updates a DatasetVersion.
- public class PatchRequest : AiplatformBaseServiceRequest
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^featureGroups/[^/]+/operations/[^/]+$",
+ });
+ RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
{
- /// Constructs a new Patch request.
- public PatchRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1DatasetVersion body, string name) : base(service)
- {
- Name = name;
- Body = body;
- InitParameters();
- }
-
- ///
- /// Output only. Identifier. The resource name of the DatasetVersion. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ Name = "filter",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
+ {
+ Name = "pageSize",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
+ {
+ Name = "pageToken",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("returnPartialSuccess", new Google.Apis.Discovery.Parameter
+ {
+ Name = "returnPartialSuccess",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ }
+ }
- ///
- /// Required. The update mask applies to the resource. For the `FieldMask` definition, see
- /// google.protobuf.FieldMask. Updatable fields: * `display_name`
- ///
- [Google.Apis.Util.RequestParameterAttribute("updateMask", Google.Apis.Util.RequestParameterType.Query)]
- public virtual object UpdateMask { get; 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.
+ ///
+ /// The name of the operation resource to wait on.
+ public virtual WaitRequest Wait(string name)
+ {
+ return new WaitRequest(this.service, name);
+ }
- /// Gets or sets the body of this request.
- Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1DatasetVersion Body { get; 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.
+ ///
+ public class WaitRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Wait request.
+ public WaitRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// Returns the body of the request.
- protected override object GetBody() => Body;
+ /// The name of the operation resource to wait on.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Gets the method name.
- public override string MethodName => "patch";
+ ///
+ /// The maximum duration to wait before timing out. If left blank, the wait will be at most the time
+ /// permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the
+ /// shorter one will be used.
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("timeout", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual object Timeout { get; set; }
- /// Gets the HTTP method.
- public override string HttpMethod => "PATCH";
+ /// Gets the method name.
+ public override string MethodName => "wait";
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "POST";
- /// Initializes Patch parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$",
- });
- RequestParameters.Add("updateMask", new Google.Apis.Discovery.Parameter
- {
- Name = "updateMask",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- }
- }
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}:wait";
- /// Restores a dataset version.
- ///
- /// Required. The name of the DatasetVersion resource. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
- ///
- public virtual RestoreRequest Restore(string name)
+ /// Initializes Wait parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- return new RestoreRequest(this.service, name);
- }
-
- /// Restores a dataset version.
- public class RestoreRequest : AiplatformBaseServiceRequest
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^featureGroups/[^/]+/operations/[^/]+$",
+ });
+ RequestParameters.Add("timeout", new Google.Apis.Discovery.Parameter
{
- /// Constructs a new Restore request.
- public RestoreRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ Name = "timeout",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ }
+ }
+ }
+ }
- ///
- /// Required. The name of the DatasetVersion resource. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ /// The "featureOnlineStores" collection of methods.
+ public class FeatureOnlineStoresResource
+ {
+ private const string Resource = "featureOnlineStores";
- /// Gets the method name.
- public override string MethodName => "restore";
+ /// The service which this resource belongs to.
+ private readonly Google.Apis.Services.IClientService service;
- /// Gets the HTTP method.
- public override string HttpMethod => "GET";
+ /// Constructs a new resource.
+ public FeatureOnlineStoresResource(Google.Apis.Services.IClientService service)
+ {
+ this.service = service;
+ FeatureViews = new FeatureViewsResource(service);
+ Operations = new OperationsResource(service);
+ }
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}:restore";
+ /// Gets the FeatureViews resource.
+ public virtual FeatureViewsResource FeatureViews { get; }
- /// Initializes Restore parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$",
- });
- }
- }
- }
+ /// The "featureViews" collection of methods.
+ public class FeatureViewsResource
+ {
+ private const string Resource = "featureViews";
- /// Gets the Operations resource.
- public virtual OperationsResource Operations { get; }
+ /// The service which this resource belongs to.
+ private readonly Google.Apis.Services.IClientService service;
- /// The "operations" collection of methods.
- public class OperationsResource
+ /// Constructs a new resource.
+ public FeatureViewsResource(Google.Apis.Services.IClientService service)
+ {
+ this.service = service;
+ Operations = new OperationsResource(service);
+ }
+
+ /// Gets the Operations resource.
+ public virtual OperationsResource Operations { get; }
+
+ /// The "operations" collection of methods.
+ public class OperationsResource
+ {
+ private const string Resource = "operations";
+
+ /// The service which this resource belongs to.
+ private readonly Google.Apis.Services.IClientService service;
+
+ /// Constructs a new resource.
+ public OperationsResource(Google.Apis.Services.IClientService service)
{
- private const string Resource = "operations";
+ this.service = service;
+ }
- /// The service which this resource belongs to.
- private readonly Google.Apis.Services.IClientService service;
+ ///
+ /// Deletes a long-running operation. This method indicates that the client is no longer interested in
+ /// the operation result. It does not cancel the operation. If the server doesn't support this method,
+ /// it returns `google.rpc.Code.UNIMPLEMENTED`.
+ ///
+ /// The name of the operation resource to be deleted.
+ public virtual DeleteRequest Delete(string name)
+ {
+ return new DeleteRequest(this.service, name);
+ }
- /// Constructs a new resource.
- public OperationsResource(Google.Apis.Services.IClientService service)
+ ///
+ /// Deletes a long-running operation. This method indicates that the client is no longer interested in
+ /// the operation result. It does not cancel the operation. If the server doesn't support this method,
+ /// it returns `google.rpc.Code.UNIMPLEMENTED`.
+ ///
+ public class DeleteRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Delete request.
+ public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
- this.service = service;
+ Name = name;
+ InitParameters();
}
- ///
- /// Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
- /// cancel the operation, but success is not guaranteed. If the server doesn't support this method,
- /// it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other
- /// methods to check whether the cancellation succeeded or whether the operation completed despite
- /// cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
- /// operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to
- /// `Code.CANCELLED`.
- ///
- /// The name of the operation resource to be cancelled.
- public virtual CancelRequest Cancel(string name)
+ /// The name of the operation resource to be deleted.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
+
+ /// Gets the method name.
+ public override string MethodName => "delete";
+
+ /// Gets the HTTP method.
+ public override string HttpMethod => "DELETE";
+
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}";
+
+ /// Initializes Delete parameter list.
+ protected override void InitParameters()
{
- return new CancelRequest(this.service, name);
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
+ {
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$",
+ });
}
+ }
- ///
- /// Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
- /// cancel the operation, but success is not guaranteed. If the server doesn't support this method,
- /// it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other
- /// methods to check whether the cancellation succeeded or whether the operation completed despite
- /// cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
- /// operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to
- /// `Code.CANCELLED`.
- ///
- public class CancelRequest : AiplatformBaseServiceRequest
+ ///
+ /// Gets the latest 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.
+ public virtual GetRequest Get(string name)
+ {
+ return new GetRequest(this.service, 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.
+ ///
+ public class GetRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Get request.
+ public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
- /// Constructs a new Cancel request.
- public CancelRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ Name = name;
+ InitParameters();
+ }
- /// The name of the operation resource to be cancelled.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ /// The name of the operation resource.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Gets the method name.
- public override string MethodName => "cancel";
+ /// Gets the method name.
+ public override string MethodName => "get";
- /// Gets the HTTP method.
- public override string HttpMethod => "POST";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "GET";
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}:cancel";
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}";
- /// Initializes Cancel parameter list.
- protected override void InitParameters()
+ /// Initializes Get parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$",
- });
- }
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$",
+ });
}
+ }
- ///
- /// Deletes a long-running operation. This method indicates that the client is no longer interested
- /// in the operation result. It does not cancel the operation. If the server doesn't support this
- /// method, it returns `google.rpc.Code.UNIMPLEMENTED`.
- ///
- /// The name of the operation resource to be deleted.
- public virtual DeleteRequest Delete(string name)
+ ///
+ /// Lists operations that match the specified filter in the request. If the server doesn't support this
+ /// method, it returns `UNIMPLEMENTED`.
+ ///
+ /// The name of the operation's parent resource.
+ public virtual ListWaitRequest ListWait(string name)
+ {
+ return new ListWaitRequest(this.service, name);
+ }
+
+ ///
+ /// Lists operations that match the specified filter in the request. If the server doesn't support this
+ /// method, it returns `UNIMPLEMENTED`.
+ ///
+ public class ListWaitRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new ListWait request.
+ public ListWaitRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
- return new DeleteRequest(this.service, name);
+ Name = name;
+ InitParameters();
}
+ /// The name of the operation's parent resource.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
+
+ /// The standard list filter.
+ [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string Filter { get; set; }
+
+ /// The standard list page size.
+ [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual System.Nullable PageSize { get; set; }
+
+ /// The standard list page token.
+ [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string PageToken { get; 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`.
+ /// When set to `true`, operations that are reachable are returned as normal, and those that are
+ /// unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be
+ /// `true` when reading across collections e.g. when `parent` is set to
+ /// `"projects/example/locations/-"`. This field is not by default supported and will result in an
+ /// `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product
+ /// specific documentation.
///
- public class DeleteRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Delete request.
- public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
-
- /// The name of the operation resource to be deleted.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ [Google.Apis.Util.RequestParameterAttribute("returnPartialSuccess", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual System.Nullable ReturnPartialSuccess { get; set; }
- /// Gets the method name.
- public override string MethodName => "delete";
+ /// Gets the method name.
+ public override string MethodName => "listWait";
- /// Gets the HTTP method.
- public override string HttpMethod => "DELETE";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "GET";
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}";
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}:wait";
- /// Initializes Delete parameter list.
- protected override void InitParameters()
+ /// Initializes ListWait parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$",
- });
- }
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$",
+ });
+ RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
+ {
+ Name = "filter",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
+ {
+ Name = "pageSize",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
+ {
+ Name = "pageToken",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("returnPartialSuccess", new Google.Apis.Discovery.Parameter
+ {
+ Name = "returnPartialSuccess",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
}
+ }
- ///
- /// Gets the latest 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.
- public virtual GetRequest Get(string 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.
+ ///
+ /// The name of the operation resource to wait on.
+ public virtual WaitRequest Wait(string name)
+ {
+ return new WaitRequest(this.service, 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.
+ ///
+ public class WaitRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Wait request.
+ public WaitRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
- return new GetRequest(this.service, name);
+ Name = name;
+ InitParameters();
}
+ /// The name of the operation resource to wait on.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private 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.
+ /// The maximum duration to wait before timing out. If left blank, the wait will be at most the time
+ /// permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the
+ /// shorter one will be used.
///
- public class GetRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Get request.
- public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
-
- /// The name of the operation resource.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ [Google.Apis.Util.RequestParameterAttribute("timeout", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual object Timeout { get; set; }
- /// Gets the method name.
- public override string MethodName => "get";
+ /// Gets the method name.
+ public override string MethodName => "wait";
- /// Gets the HTTP method.
- public override string HttpMethod => "GET";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "POST";
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}";
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}:wait";
- /// Initializes Get parameter list.
- protected override void InitParameters()
+ /// Initializes Wait parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$",
- });
- }
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$",
+ });
+ RequestParameters.Add("timeout", new Google.Apis.Discovery.Parameter
+ {
+ Name = "timeout",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
}
+ }
+ }
+ }
- ///
- /// Lists operations that match the specified filter in the request. If the server doesn't support
- /// this method, it returns `UNIMPLEMENTED`.
- ///
- /// The name of the operation's parent resource.
- public virtual ListRequest List(string name)
- {
- return new ListRequest(this.service, name);
- }
+ /// Gets the Operations resource.
+ public virtual OperationsResource Operations { get; }
- ///
- /// Lists operations that match the specified filter in the request. If the server doesn't support
- /// this method, it returns `UNIMPLEMENTED`.
- ///
- public class ListRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new List request.
- public ListRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ /// The "operations" collection of methods.
+ public class OperationsResource
+ {
+ private const string Resource = "operations";
- /// The name of the operation's parent resource.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ /// The service which this resource belongs to.
+ private readonly Google.Apis.Services.IClientService service;
- /// The standard list filter.
- [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string Filter { get; set; }
+ /// Constructs a new resource.
+ public OperationsResource(Google.Apis.Services.IClientService service)
+ {
+ this.service = service;
+ }
- /// The standard list page size.
- [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
- public virtual System.Nullable PageSize { get; 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`.
+ ///
+ /// The name of the operation resource to be deleted.
+ public virtual DeleteRequest Delete(string name)
+ {
+ return new DeleteRequest(this.service, name);
+ }
- /// The standard list page token.
- [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string PageToken { get; 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`.
+ ///
+ public class DeleteRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Delete request.
+ public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- ///
- /// When set to `true`, operations that are reachable are returned as normal, and those that are
- /// unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be
- /// `true` when reading across collections e.g. when `parent` is set to
- /// `"projects/example/locations/-"`. This field is not by default supported and will result in
- /// an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product
- /// specific documentation.
- ///
- [Google.Apis.Util.RequestParameterAttribute("returnPartialSuccess", Google.Apis.Util.RequestParameterType.Query)]
- public virtual System.Nullable ReturnPartialSuccess { get; set; }
+ /// The name of the operation resource to be deleted.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Gets the method name.
- public override string MethodName => "list";
+ /// Gets the method name.
+ public override string MethodName => "delete";
- /// Gets the HTTP method.
- public override string HttpMethod => "GET";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "DELETE";
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}/operations";
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}";
- /// Initializes List parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
+ /// Initializes Delete parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
+ {
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^featureOnlineStores/[^/]+/operations/[^/]+$",
+ });
+ }
+ }
+
+ ///
+ /// Gets the latest 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.
+ public virtual GetRequest Get(string name)
+ {
+ return new GetRequest(this.service, 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.
+ ///
+ public class GetRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Get request.
+ public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
+
+ /// The name of the operation resource.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
+
+ /// Gets the method name.
+ public override string MethodName => "get";
+
+ /// Gets the HTTP method.
+ public override string HttpMethod => "GET";
+
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}";
+
+ /// Initializes Get parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
+ {
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^featureOnlineStores/[^/]+/operations/[^/]+$",
+ });
+ }
+ }
+
+ ///
+ /// Lists operations that match the specified filter in the request. If the server doesn't support this
+ /// method, it returns `UNIMPLEMENTED`.
+ ///
+ /// The name of the operation's parent resource.
+ public virtual ListWaitRequest ListWait(string name)
+ {
+ return new ListWaitRequest(this.service, name);
+ }
+
+ ///
+ /// Lists operations that match the specified filter in the request. If the server doesn't support this
+ /// method, it returns `UNIMPLEMENTED`.
+ ///
+ public class ListWaitRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new ListWait request.
+ public ListWaitRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
+
+ /// The name of the operation's parent resource.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
+
+ /// The standard list filter.
+ [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string Filter { get; set; }
+
+ /// The standard list page size.
+ [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual System.Nullable PageSize { get; set; }
+
+ /// The standard list page token.
+ [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string PageToken { get; set; }
+
+ ///
+ /// When set to `true`, operations that are reachable are returned as normal, and those that are
+ /// unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true`
+ /// when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This
+ /// field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless
+ /// explicitly documented otherwise in service or product specific documentation.
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("returnPartialSuccess", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual System.Nullable ReturnPartialSuccess { get; set; }
+
+ /// Gets the method name.
+ public override string MethodName => "listWait";
+
+ /// Gets the HTTP method.
+ public override string HttpMethod => "GET";
+
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}:wait";
+
+ /// Initializes ListWait parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
+ {
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^featureOnlineStores/[^/]+/operations/[^/]+$",
+ });
+ RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
+ {
+ Name = "filter",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
+ {
+ Name = "pageSize",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
+ {
+ Name = "pageToken",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("returnPartialSuccess", new Google.Apis.Discovery.Parameter
+ {
+ Name = "returnPartialSuccess",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ }
+ }
+
+ ///
+ /// Waits until the specified long-running operation is done or reaches at most a specified timeout,
+ /// returning the latest state. If the operation is already done, the latest state is immediately returned.
+ /// If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If
+ /// the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this
+ /// method is on a best-effort basis. It may return the latest state before the specified timeout (including
+ /// immediately), meaning even an immediate response is no guarantee that the operation is done.
+ ///
+ /// The name of the operation resource to wait on.
+ public virtual WaitRequest Wait(string name)
+ {
+ return new WaitRequest(this.service, 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.
+ ///
+ public class WaitRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Wait request.
+ public WaitRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
+
+ /// The name of the operation resource to wait on.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
+
+ ///
+ /// The maximum duration to wait before timing out. If left blank, the wait will be at most the time
+ /// permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the
+ /// shorter one will be used.
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("timeout", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual object Timeout { get; set; }
+
+ /// Gets the method name.
+ public override string MethodName => "wait";
+
+ /// Gets the HTTP method.
+ public override string HttpMethod => "POST";
+
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}:wait";
+
+ /// Initializes Wait parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
+ {
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^featureOnlineStores/[^/]+/operations/[^/]+$",
+ });
+ RequestParameters.Add("timeout", new Google.Apis.Discovery.Parameter
+ {
+ Name = "timeout",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ }
+ }
+ }
+ }
+
+ /// The "featurestores" collection of methods.
+ public class FeaturestoresResource
+ {
+ private const string Resource = "featurestores";
+
+ /// The service which this resource belongs to.
+ private readonly Google.Apis.Services.IClientService service;
+
+ /// Constructs a new resource.
+ public FeaturestoresResource(Google.Apis.Services.IClientService service)
+ {
+ this.service = service;
+ EntityTypes = new EntityTypesResource(service);
+ Operations = new OperationsResource(service);
+ }
+
+ /// Gets the EntityTypes resource.
+ public virtual EntityTypesResource EntityTypes { get; }
+
+ /// The "entityTypes" collection of methods.
+ public class EntityTypesResource
+ {
+ private const string Resource = "entityTypes";
+
+ /// The service which this resource belongs to.
+ private readonly Google.Apis.Services.IClientService service;
+
+ /// Constructs a new resource.
+ public EntityTypesResource(Google.Apis.Services.IClientService service)
+ {
+ this.service = service;
+ Features = new FeaturesResource(service);
+ Operations = new OperationsResource(service);
+ }
+
+ /// Gets the Features resource.
+ public virtual FeaturesResource Features { get; }
+
+ /// The "features" collection of methods.
+ public class FeaturesResource
+ {
+ private const string Resource = "features";
+
+ /// The service which this resource belongs to.
+ private readonly Google.Apis.Services.IClientService service;
+
+ /// Constructs a new resource.
+ public FeaturesResource(Google.Apis.Services.IClientService service)
+ {
+ this.service = service;
+ Operations = new OperationsResource(service);
+ }
+
+ /// Gets the Operations resource.
+ public virtual OperationsResource Operations { get; }
+
+ /// The "operations" collection of methods.
+ public class OperationsResource
+ {
+ private const string Resource = "operations";
+
+ /// The service which this resource belongs to.
+ private readonly Google.Apis.Services.IClientService service;
+
+ /// Constructs a new resource.
+ public OperationsResource(Google.Apis.Services.IClientService service)
+ {
+ this.service = service;
+ }
+
+ ///
+ /// Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
+ /// cancel the operation, but success is not guaranteed. If the server doesn't support this method,
+ /// it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other
+ /// methods to check whether the cancellation succeeded or whether the operation completed despite
+ /// cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
+ /// operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to
+ /// `Code.CANCELLED`.
+ ///
+ /// The name of the operation resource to be cancelled.
+ public virtual CancelRequest Cancel(string name)
+ {
+ return new CancelRequest(this.service, name);
+ }
+
+ ///
+ /// Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
+ /// cancel the operation, but success is not guaranteed. If the server doesn't support this method,
+ /// it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other
+ /// methods to check whether the cancellation succeeded or whether the operation completed despite
+ /// cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
+ /// operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to
+ /// `Code.CANCELLED`.
+ ///
+ public class CancelRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Cancel request.
+ public CancelRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
+
+ /// The name of the operation resource to be cancelled.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
+
+ /// Gets the method name.
+ public override string MethodName => "cancel";
+
+ /// Gets the HTTP method.
+ public override string HttpMethod => "POST";
+
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}:cancel";
+
+ /// Initializes Cancel parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
+ Pattern = @"^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$",
+ });
+ }
+ }
+
+ ///
+ /// Deletes a long-running operation. This method indicates that the client is no longer interested
+ /// in the operation result. It does not cancel the operation. If the server doesn't support this
+ /// method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+ ///
+ /// The name of the operation resource to be deleted.
+ public virtual DeleteRequest Delete(string name)
+ {
+ return new DeleteRequest(this.service, name);
+ }
+
+ ///
+ /// Deletes a long-running operation. This method indicates that the client is no longer interested
+ /// in the operation result. It does not cancel the operation. If the server doesn't support this
+ /// method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+ ///
+ public class DeleteRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Delete request.
+ public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
+
+ /// The name of the operation resource to be deleted.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
+
+ /// Gets the method name.
+ public override string MethodName => "delete";
+
+ /// Gets the HTTP method.
+ public override string HttpMethod => "DELETE";
+
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}";
+
+ /// Initializes Delete parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
+ {
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$",
+ });
+ }
+ }
+
+ ///
+ /// Gets the latest 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.
+ public virtual GetRequest Get(string name)
+ {
+ return new GetRequest(this.service, 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.
+ ///
+ public class GetRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Get request.
+ public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
+
+ /// The name of the operation resource.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
+
+ /// Gets the method name.
+ public override string MethodName => "get";
+
+ /// Gets the HTTP method.
+ public override string HttpMethod => "GET";
+
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}";
+
+ /// Initializes Get parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
+ {
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$",
+ });
+ }
+ }
+
+ ///
+ /// Lists operations that match the specified filter in the request. If the server doesn't support
+ /// this method, it returns `UNIMPLEMENTED`.
+ ///
+ /// The name of the operation's parent resource.
+ public virtual ListRequest List(string name)
+ {
+ return new ListRequest(this.service, name);
+ }
+
+ ///
+ /// Lists operations that match the specified filter in the request. If the server doesn't support
+ /// this method, it returns `UNIMPLEMENTED`.
+ ///
+ public class ListRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new List request.
+ public ListRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
+
+ /// The name of the operation's parent resource.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
+
+ /// The standard list filter.
+ [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string Filter { get; set; }
+
+ /// The standard list page size.
+ [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual System.Nullable PageSize { get; set; }
+
+ /// The standard list page token.
+ [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string PageToken { get; set; }
+
+ ///
+ /// When set to `true`, operations that are reachable are returned as normal, and those that are
+ /// unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be
+ /// `true` when reading across collections e.g. when `parent` is set to
+ /// `"projects/example/locations/-"`. This field is not by default supported and will result in
+ /// an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product
+ /// specific documentation.
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("returnPartialSuccess", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual System.Nullable ReturnPartialSuccess { get; set; }
+
+ /// Gets the method name.
+ public override string MethodName => "list";
+
+ /// Gets the HTTP method.
+ public override string HttpMethod => "GET";
+
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}/operations";
+
+ /// Initializes List parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
+ {
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$",
});
RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
{
@@ -6517,7 +7024,7 @@ protected override void InitParameters()
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$",
+ Pattern = @"^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$",
});
RequestParameters.Add("timeout", new Google.Apis.Discovery.Parameter
{
@@ -6530,3062 +7037,2980 @@ protected override void InitParameters()
}
}
}
+ }
- /// Gets the SavedQueries resource.
- public virtual SavedQueriesResource SavedQueries { get; }
-
- /// The "savedQueries" collection of methods.
- public class SavedQueriesResource
- {
- private const string Resource = "savedQueries";
-
- /// The service which this resource belongs to.
- private readonly Google.Apis.Services.IClientService service;
+ /// Gets the Operations resource.
+ public virtual OperationsResource Operations { get; }
- /// Constructs a new resource.
- public SavedQueriesResource(Google.Apis.Services.IClientService service)
- {
- this.service = service;
- Operations = new OperationsResource(service);
- }
+ /// The "operations" collection of methods.
+ public class OperationsResource
+ {
+ private const string Resource = "operations";
- /// Gets the Operations resource.
- public virtual OperationsResource Operations { get; }
+ /// The service which this resource belongs to.
+ private readonly Google.Apis.Services.IClientService service;
- /// The "operations" collection of methods.
- public class OperationsResource
- {
- private const string Resource = "operations";
+ /// Constructs a new resource.
+ public OperationsResource(Google.Apis.Services.IClientService service)
+ {
+ this.service = service;
+ }
- /// The service which this resource belongs to.
- private readonly Google.Apis.Services.IClientService service;
+ ///
+ /// Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
+ /// cancel the operation, but success is not guaranteed. If the server doesn't support this method, it
+ /// returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to
+ /// check whether the cancellation succeeded or whether the operation completed despite cancellation. On
+ /// successful cancellation, the operation is not deleted; instead, it becomes an operation with an
+ /// Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+ ///
+ /// The name of the operation resource to be cancelled.
+ public virtual CancelRequest Cancel(string name)
+ {
+ return new CancelRequest(this.service, name);
+ }
- /// Constructs a new resource.
- public OperationsResource(Google.Apis.Services.IClientService service)
- {
- this.service = service;
- }
-
- ///
- /// Starts asynchronous cancellation on a long-running operation. The server makes a best effort
- /// to cancel the operation, but success is not guaranteed. If the server doesn't support this
- /// method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation
- /// or other methods to check whether the cancellation succeeded or whether the operation
- /// completed despite cancellation. On successful cancellation, the operation is not deleted;
- /// instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code
- /// of `1`, corresponding to `Code.CANCELLED`.
- ///
- /// The name of the operation resource to be cancelled.
- public virtual CancelRequest Cancel(string name)
- {
- return new CancelRequest(this.service, name);
- }
-
- ///
- /// Starts asynchronous cancellation on a long-running operation. The server makes a best effort
- /// to cancel the operation, but success is not guaranteed. If the server doesn't support this
- /// method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation
- /// or other methods to check whether the cancellation succeeded or whether the operation
- /// completed despite cancellation. On successful cancellation, the operation is not deleted;
- /// instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code
- /// of `1`, corresponding to `Code.CANCELLED`.
- ///
- public class CancelRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Cancel request.
- public CancelRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
-
- /// The name of the operation resource to be cancelled.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private 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`.
+ ///
+ public class CancelRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Cancel request.
+ public CancelRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// Gets the method name.
- public override string MethodName => "cancel";
+ /// The name of the operation resource to be cancelled.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Gets the HTTP method.
- public override string HttpMethod => "POST";
+ /// Gets the method name.
+ public override string MethodName => "cancel";
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}:cancel";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "POST";
- /// Initializes Cancel parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$",
- });
- }
- }
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}:cancel";
- ///
- /// Deletes a long-running operation. This method indicates that the client is no longer
- /// interested in the operation result. It does not cancel the operation. If the server doesn't
- /// support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
- ///
- /// The name of the operation resource to be deleted.
- public virtual DeleteRequest Delete(string name)
+ /// Initializes Cancel parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- return new DeleteRequest(this.service, name);
- }
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$",
+ });
+ }
+ }
- ///
- /// Deletes a long-running operation. This method indicates that the client is no longer
- /// interested in the operation result. It does not cancel the operation. If the server doesn't
- /// support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
- ///
- public class DeleteRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Delete request.
- public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ ///
+ /// Deletes a long-running operation. This method indicates that the client is no longer interested in
+ /// the operation result. It does not cancel the operation. If the server doesn't support this method,
+ /// it returns `google.rpc.Code.UNIMPLEMENTED`.
+ ///
+ /// The name of the operation resource to be deleted.
+ public virtual DeleteRequest Delete(string name)
+ {
+ return new DeleteRequest(this.service, name);
+ }
- /// The name of the operation resource to be deleted.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private 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`.
+ ///
+ public class DeleteRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Delete request.
+ public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// Gets the method name.
- public override string MethodName => "delete";
+ /// The name of the operation resource to be deleted.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Gets the HTTP method.
- public override string HttpMethod => "DELETE";
+ /// Gets the method name.
+ public override string MethodName => "delete";
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "DELETE";
- /// Initializes Delete parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$",
- });
- }
- }
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+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.
- ///
- /// The name of the operation resource.
- public virtual GetRequest Get(string name)
+ /// Initializes Delete parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- return new GetRequest(this.service, name);
- }
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$",
+ });
+ }
+ }
- ///
- /// Gets the latest state of a long-running operation. Clients can use this method to poll the
- /// operation result at intervals as recommended by the API service.
- ///
- public class GetRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Get request.
- public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ ///
+ /// Gets the latest 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.
+ public virtual GetRequest Get(string name)
+ {
+ return new GetRequest(this.service, name);
+ }
- /// The name of the operation resource.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private 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.
+ ///
+ public class GetRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Get request.
+ public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// Gets the method name.
- public override string MethodName => "get";
+ /// The name of the operation resource.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Gets the HTTP method.
- public override string HttpMethod => "GET";
+ /// Gets the method name.
+ public override string MethodName => "get";
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "GET";
- /// Initializes Get parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$",
- });
- }
- }
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}";
- ///
- /// Lists operations that match the specified filter in the request. If the server doesn't
- /// support this method, it returns `UNIMPLEMENTED`.
- ///
- /// The name of the operation's parent resource.
- public virtual ListRequest List(string name)
+ /// Initializes Get parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- return new ListRequest(this.service, name);
- }
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$",
+ });
+ }
+ }
- ///
- /// Lists operations that match the specified filter in the request. If the server doesn't
- /// support this method, it returns `UNIMPLEMENTED`.
- ///
- public class ListRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new List request.
- public ListRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ ///
+ /// Lists operations that match the specified filter in the request. If the server doesn't support this
+ /// method, it returns `UNIMPLEMENTED`.
+ ///
+ /// The name of the operation's parent resource.
+ public virtual ListRequest List(string name)
+ {
+ return new ListRequest(this.service, name);
+ }
- /// The name of the operation's parent resource.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ ///
+ /// Lists operations that match the specified filter in the request. If the server doesn't support this
+ /// method, it returns `UNIMPLEMENTED`.
+ ///
+ public class ListRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new List request.
+ public ListRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// The standard list filter.
- [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string Filter { get; set; }
+ /// The name of the operation's parent resource.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// The standard list page size.
- [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
- public virtual System.Nullable PageSize { get; set; }
+ /// The standard list filter.
+ [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string Filter { get; set; }
- /// The standard list page token.
- [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string PageToken { get; set; }
+ /// The standard list page size.
+ [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual System.Nullable PageSize { get; set; }
- ///
- /// When set to `true`, operations that are reachable are returned as normal, and those that
- /// are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can
- /// only be `true` when reading across collections e.g. when `parent` is set to
- /// `"projects/example/locations/-"`. This field is not by default supported and will result
- /// in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or
- /// product specific documentation.
- ///
- [Google.Apis.Util.RequestParameterAttribute("returnPartialSuccess", Google.Apis.Util.RequestParameterType.Query)]
- public virtual System.Nullable ReturnPartialSuccess { get; set; }
+ /// The standard list page token.
+ [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string PageToken { get; set; }
- /// Gets the method name.
- public override string MethodName => "list";
+ ///
+ /// When set to `true`, operations that are reachable are returned as normal, and those that are
+ /// unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be
+ /// `true` when reading across collections e.g. when `parent` is set to
+ /// `"projects/example/locations/-"`. This field is not by default supported and will result in an
+ /// `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product
+ /// specific documentation.
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("returnPartialSuccess", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual System.Nullable ReturnPartialSuccess { get; set; }
- /// Gets the HTTP method.
- public override string HttpMethod => "GET";
+ /// Gets the method name.
+ public override string MethodName => "list";
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}/operations";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "GET";
- /// Initializes List parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+$",
- });
- RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
- {
- Name = "filter",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
- {
- Name = "pageSize",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
- {
- Name = "pageToken",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("returnPartialSuccess", new Google.Apis.Discovery.Parameter
- {
- Name = "returnPartialSuccess",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- }
- }
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}/operations";
- ///
- /// Waits until the specified long-running operation is done or reaches at most a specified
- /// timeout, returning the latest state. If the operation is already done, the latest state is
- /// immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout,
- /// the HTTP/RPC timeout is used. If the server does not support this method, it returns
- /// `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may
- /// return the latest state before the specified timeout (including immediately), meaning even
- /// an immediate response is no guarantee that the operation is done.
- ///
- /// The name of the operation resource to wait on.
- public virtual WaitRequest Wait(string name)
+ /// Initializes List parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- return new WaitRequest(this.service, 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.
- ///
- public class WaitRequest : AiplatformBaseServiceRequest
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^featurestores/[^/]+/entityTypes/[^/]+$",
+ });
+ RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
{
- /// Constructs a new Wait request.
- public WaitRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ Name = "filter",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
+ {
+ Name = "pageSize",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
+ {
+ Name = "pageToken",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("returnPartialSuccess", new Google.Apis.Discovery.Parameter
+ {
+ Name = "returnPartialSuccess",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ }
+ }
- /// The name of the operation resource to wait on.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private 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.
+ ///
+ /// The name of the operation resource to wait on.
+ public virtual WaitRequest Wait(string name)
+ {
+ return new WaitRequest(this.service, name);
+ }
- ///
- /// The maximum duration to wait before timing out. If left blank, the wait will be at most
- /// the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also
- /// specified, the shorter one will be used.
- ///
- [Google.Apis.Util.RequestParameterAttribute("timeout", Google.Apis.Util.RequestParameterType.Query)]
- public virtual object Timeout { get; set; }
-
- /// Gets the method name.
- public override string MethodName => "wait";
-
- /// Gets the HTTP method.
- public override string HttpMethod => "POST";
-
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}:wait";
-
- /// Initializes Wait parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$",
- });
- RequestParameters.Add("timeout", new Google.Apis.Discovery.Parameter
- {
- Name = "timeout",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- }
- }
- }
-
- /// Deletes a SavedQuery.
- ///
- /// Required. The resource name of the SavedQuery to delete. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}`
- ///
- public virtual DeleteRequest Delete(string name)
- {
- return new DeleteRequest(this.service, name);
- }
-
- /// Deletes a SavedQuery.
- public class DeleteRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Delete request.
- public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
-
- ///
- /// Required. The resource name of the SavedQuery to delete. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
-
- /// Gets the method name.
- public override string MethodName => "delete";
-
- /// Gets the HTTP method.
- public override string HttpMethod => "DELETE";
-
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}";
-
- /// Initializes Delete parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+$",
- });
- }
- }
-
- /// Lists SavedQueries in a Dataset.
- ///
- /// Required. The resource name of the Dataset to list SavedQueries from. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}`
- ///
- public virtual ListRequest List(string parent)
- {
- return new ListRequest(this.service, parent);
- }
-
- /// Lists SavedQueries in a Dataset.
- public class ListRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new List request.
- public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service)
- {
- Parent = parent;
- InitParameters();
- }
-
- ///
- /// Required. The resource name of the Dataset to list SavedQueries from. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Parent { get; private set; }
-
- /// The standard list filter.
- [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string Filter { get; set; }
-
- ///
- /// A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a
- /// field name for descending.
- ///
- [Google.Apis.Util.RequestParameterAttribute("orderBy", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string OrderBy { get; set; }
-
- /// The standard list page size.
- [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
- public virtual System.Nullable PageSize { get; set; }
-
- /// The standard list page token.
- [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string PageToken { get; set; }
-
- /// Mask specifying which fields to read.
- [Google.Apis.Util.RequestParameterAttribute("readMask", Google.Apis.Util.RequestParameterType.Query)]
- public virtual object ReadMask { get; set; }
-
- /// Gets the method name.
- public override string MethodName => "list";
-
- /// Gets the HTTP method.
- public override string HttpMethod => "GET";
-
- /// Gets the REST path.
- public override string RestPath => "v1/{+parent}/savedQueries";
-
- /// Initializes List parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
- {
- Name = "parent",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
- });
- RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
- {
- Name = "filter",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("orderBy", new Google.Apis.Discovery.Parameter
- {
- Name = "orderBy",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
- {
- Name = "pageSize",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
- {
- Name = "pageToken",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("readMask", new Google.Apis.Discovery.Parameter
- {
- Name = "readMask",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- }
- }
- }
-
- /// Creates a Dataset.
- /// The body of the request.
- ///
- /// Required. The resource name of the Location to create the Dataset in. Format:
- /// `projects/{project}/locations/{location}`
- ///
- public virtual CreateRequest Create(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1Dataset body, string parent)
- {
- return new CreateRequest(this.service, body, parent);
- }
-
- /// Creates a Dataset.
- public class CreateRequest : AiplatformBaseServiceRequest
+ ///
+ /// Waits until the specified long-running operation is done or reaches at most a specified timeout,
+ /// returning the latest state. If the operation is already done, the latest state is immediately
+ /// returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
+ /// timeout is used. If the server does not support this method, it returns
+ /// `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the
+ /// latest state before the specified timeout (including immediately), meaning even an immediate
+ /// response is no guarantee that the operation is done.
+ ///
+ public class WaitRequest : AiplatformBaseServiceRequest
{
- /// Constructs a new Create request.
- public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1Dataset body, string parent) : base(service)
+ /// Constructs a new Wait request.
+ public WaitRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
- Parent = parent;
- Body = body;
+ Name = name;
InitParameters();
}
+ /// The name of the operation resource to wait on.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
+
///
- /// Required. The resource name of the Location to create the Dataset in. Format:
- /// `projects/{project}/locations/{location}`
+ /// The maximum duration to wait before timing out. If left blank, the wait will be at most the time
+ /// permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the
+ /// shorter one will be used.
///
- [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Parent { get; private set; }
-
- /// Gets or sets the body of this request.
- Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1Dataset Body { get; set; }
-
- /// Returns the body of the request.
- protected override object GetBody() => Body;
+ [Google.Apis.Util.RequestParameterAttribute("timeout", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual object Timeout { get; set; }
/// Gets the method name.
- public override string MethodName => "create";
+ public override string MethodName => "wait";
/// Gets the HTTP method.
public override string HttpMethod => "POST";
/// Gets the REST path.
- public override string RestPath => "v1/{+parent}/datasets";
+ public override string RestPath => "v1/{+name}:wait";
- /// Initializes Create parameter list.
+ /// Initializes Wait parameter list.
protected override void InitParameters()
{
base.InitParameters();
- RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- Name = "parent",
+ Name = "name",
IsRequired = true,
ParameterType = "path",
DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+$",
+ Pattern = @"^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$",
+ });
+ RequestParameters.Add("timeout", new Google.Apis.Discovery.Parameter
+ {
+ Name = "timeout",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
});
}
}
+ }
+ }
- /// Deletes a Dataset.
- ///
- /// Required. The resource name of the Dataset to delete. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}`
- ///
- public virtual DeleteRequest Delete(string name)
- {
- return new DeleteRequest(this.service, name);
- }
+ /// Gets the Operations resource.
+ public virtual OperationsResource Operations { get; }
- /// Deletes a Dataset.
- public class DeleteRequest : AiplatformBaseServiceRequest
+ /// The "operations" collection of methods.
+ public class OperationsResource
+ {
+ private const string Resource = "operations";
+
+ /// The service which this resource belongs to.
+ private readonly Google.Apis.Services.IClientService service;
+
+ /// Constructs a new resource.
+ public OperationsResource(Google.Apis.Services.IClientService service)
+ {
+ this.service = service;
+ }
+
+ ///
+ /// Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel
+ /// the operation, but success is not guaranteed. If the server doesn't support this method, it returns
+ /// `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check
+ /// whether the cancellation succeeded or whether the operation completed despite cancellation. On
+ /// successful cancellation, the operation is not deleted; instead, it becomes an operation with an
+ /// Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+ ///
+ /// The name of the operation resource to be cancelled.
+ public virtual CancelRequest Cancel(string name)
+ {
+ return new CancelRequest(this.service, name);
+ }
+
+ ///
+ /// Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel
+ /// the operation, but success is not guaranteed. If the server doesn't support this method, it returns
+ /// `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check
+ /// whether the cancellation succeeded or whether the operation completed despite cancellation. On
+ /// successful cancellation, the operation is not deleted; instead, it becomes an operation with an
+ /// Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+ ///
+ public class CancelRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Cancel request.
+ public CancelRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
- /// Constructs a new Delete request.
- public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ Name = name;
+ InitParameters();
+ }
- ///
- /// Required. The resource name of the Dataset to delete. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ /// The name of the operation resource to be cancelled.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Gets the method name.
- public override string MethodName => "delete";
+ /// Gets the method name.
+ public override string MethodName => "cancel";
- /// Gets the HTTP method.
- public override string HttpMethod => "DELETE";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "POST";
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}";
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}:cancel";
- /// Initializes Delete parameter list.
- protected override void InitParameters()
+ /// Initializes Cancel parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
- });
- }
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^featurestores/[^/]+/operations/[^/]+$",
+ });
}
+ }
- /// Exports data from a Dataset.
- /// The body of the request.
- ///
- /// Required. The name of the Dataset resource. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}`
- ///
- public virtual ExportRequest Export(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1ExportDataRequest body, string name)
+ ///
+ /// Deletes a long-running operation. This method indicates that the client is no longer interested in the
+ /// operation result. It does not cancel the operation. If the server doesn't support this method, it
+ /// returns `google.rpc.Code.UNIMPLEMENTED`.
+ ///
+ /// The name of the operation resource to be deleted.
+ public virtual DeleteRequest Delete(string name)
+ {
+ return new DeleteRequest(this.service, name);
+ }
+
+ ///
+ /// Deletes a long-running operation. This method indicates that the client is no longer interested in the
+ /// operation result. It does not cancel the operation. If the server doesn't support this method, it
+ /// returns `google.rpc.Code.UNIMPLEMENTED`.
+ ///
+ public class DeleteRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Delete request.
+ public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
- return new ExportRequest(this.service, body, name);
+ Name = name;
+ InitParameters();
}
- /// Exports data from a Dataset.
- public class ExportRequest : AiplatformBaseServiceRequest
+ /// The name of the operation resource to be deleted.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
+
+ /// Gets the method name.
+ public override string MethodName => "delete";
+
+ /// Gets the HTTP method.
+ public override string HttpMethod => "DELETE";
+
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}";
+
+ /// Initializes Delete parameter list.
+ protected override void InitParameters()
{
- /// Constructs a new Export request.
- public ExportRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1ExportDataRequest body, string name) : base(service)
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- Name = name;
- Body = body;
- InitParameters();
- }
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^featurestores/[^/]+/operations/[^/]+$",
+ });
+ }
+ }
- ///
- /// Required. The name of the Dataset resource. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private 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.
+ ///
+ /// The name of the operation resource.
+ public virtual GetRequest Get(string name)
+ {
+ return new GetRequest(this.service, name);
+ }
- /// Gets or sets the body of this request.
- Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1ExportDataRequest Body { get; 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.
+ ///
+ public class GetRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Get request.
+ public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// Returns the body of the request.
- protected override object GetBody() => Body;
+ /// The name of the operation resource.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Gets the method name.
- public override string MethodName => "export";
+ /// Gets the method name.
+ public override string MethodName => "get";
- /// Gets the HTTP method.
- public override string HttpMethod => "POST";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "GET";
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}:export";
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}";
- /// Initializes Export parameter list.
- protected override void InitParameters()
+ /// Initializes Get parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
- });
- }
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^featurestores/[^/]+/operations/[^/]+$",
+ });
}
+ }
- /// Gets a Dataset.
- /// Required. The name of the Dataset resource.
- public virtual GetRequest Get(string name)
+ ///
+ /// Lists operations that match the specified filter in the request. If the server doesn't support this
+ /// method, it returns `UNIMPLEMENTED`.
+ ///
+ /// The name of the operation's parent resource.
+ public virtual ListRequest List(string name)
+ {
+ return new ListRequest(this.service, name);
+ }
+
+ ///
+ /// Lists operations that match the specified filter in the request. If the server doesn't support this
+ /// method, it returns `UNIMPLEMENTED`.
+ ///
+ public class ListRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new List request.
+ public ListRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
- return new GetRequest(this.service, name);
+ Name = name;
+ InitParameters();
}
- /// Gets a Dataset.
- public class GetRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new Get request.
- public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service)
- {
- Name = name;
- InitParameters();
- }
+ /// The name of the operation's parent resource.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Required. The name of the Dataset resource.
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private set; }
+ /// The standard list filter.
+ [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string Filter { get; set; }
- /// Mask specifying which fields to read.
- [Google.Apis.Util.RequestParameterAttribute("readMask", Google.Apis.Util.RequestParameterType.Query)]
- public virtual object ReadMask { get; set; }
+ /// The standard list page size.
+ [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual System.Nullable PageSize { get; set; }
- /// Gets the method name.
- public override string MethodName => "get";
+ /// The standard list page token.
+ [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual string PageToken { get; set; }
- /// Gets the HTTP method.
- public override string HttpMethod => "GET";
+ ///
+ /// When set to `true`, operations that are reachable are returned as normal, and those that are
+ /// unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true`
+ /// when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This
+ /// field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless
+ /// explicitly documented otherwise in service or product specific documentation.
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("returnPartialSuccess", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual System.Nullable ReturnPartialSuccess { get; set; }
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}";
+ /// Gets the method name.
+ public override string MethodName => "list";
- /// Initializes Get parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
- });
- RequestParameters.Add("readMask", new Google.Apis.Discovery.Parameter
- {
- Name = "readMask",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- }
- }
+ /// Gets the HTTP method.
+ public override string HttpMethod => "GET";
- /// Imports data into a Dataset.
- /// The body of the request.
- ///
- /// Required. The name of the Dataset resource. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}`
- ///
- public virtual ImportRequest Import(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1ImportDataRequest body, string name)
- {
- return new ImportRequest(this.service, body, name);
- }
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}/operations";
- /// Imports data into a Dataset.
- public class ImportRequest : AiplatformBaseServiceRequest
+ /// Initializes List parameter list.
+ protected override void InitParameters()
{
- /// Constructs a new Import request.
- public ImportRequest(Google.Apis.Services.IClientService service, Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1ImportDataRequest body, string name) : base(service)
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- Name = name;
- Body = body;
- InitParameters();
- }
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^featurestores/[^/]+$",
+ });
+ RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
+ {
+ Name = "filter",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
+ {
+ Name = "pageSize",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
+ {
+ Name = "pageToken",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ RequestParameters.Add("returnPartialSuccess", new Google.Apis.Discovery.Parameter
+ {
+ Name = "returnPartialSuccess",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
+ }
+ }
- ///
- /// Required. The name of the Dataset resource. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Name { get; private 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.
+ ///
+ /// The name of the operation resource to wait on.
+ public virtual WaitRequest Wait(string name)
+ {
+ return new WaitRequest(this.service, name);
+ }
- /// Gets or sets the body of this request.
- Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1ImportDataRequest Body { get; 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.
+ ///
+ public class WaitRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Wait request.
+ public WaitRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// Returns the body of the request.
- protected override object GetBody() => Body;
+ /// The name of the operation resource to wait on.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Gets the method name.
- public override string MethodName => "import";
+ ///
+ /// The maximum duration to wait before timing out. If left blank, the wait will be at most the time
+ /// permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the
+ /// shorter one will be used.
+ ///
+ [Google.Apis.Util.RequestParameterAttribute("timeout", Google.Apis.Util.RequestParameterType.Query)]
+ public virtual object Timeout { get; set; }
- /// Gets the HTTP method.
- public override string HttpMethod => "POST";
+ /// Gets the method name.
+ public override string MethodName => "wait";
- /// Gets the REST path.
- public override string RestPath => "v1/{+name}:import";
+ /// Gets the HTTP method.
+ public override string HttpMethod => "POST";
- /// Initializes Import parameter list.
- protected override void InitParameters()
- {
- base.InitParameters();
- RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
- {
- Name = "name",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
- });
- }
- }
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}:wait";
- /// Lists Datasets in a Location.
- ///
- /// Required. The name of the Dataset's parent resource. Format:
- /// `projects/{project}/locations/{location}`
- ///
- public virtual ListRequest List(string parent)
+ /// Initializes Wait parameter list.
+ protected override void InitParameters()
{
- return new ListRequest(this.service, parent);
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
+ {
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^featurestores/[^/]+/operations/[^/]+$",
+ });
+ RequestParameters.Add("timeout", new Google.Apis.Discovery.Parameter
+ {
+ Name = "timeout",
+ IsRequired = false,
+ ParameterType = "query",
+ DefaultValue = null,
+ Pattern = null,
+ });
}
+ }
+ }
+ }
- /// Lists Datasets in a Location.
- public class ListRequest : AiplatformBaseServiceRequest
- {
- /// Constructs a new List request.
- public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service)
- {
- Parent = parent;
- InitParameters();
- }
+ /// The "hyperparameterTuningJobs" collection of methods.
+ public class HyperparameterTuningJobsResource
+ {
+ private const string Resource = "hyperparameterTuningJobs";
- ///
- /// Required. The name of the Dataset's parent resource. Format:
- /// `projects/{project}/locations/{location}`
- ///
- [Google.Apis.Util.RequestParameterAttribute("parent", Google.Apis.Util.RequestParameterType.Path)]
- public virtual string Parent { get; private set; }
+ /// The service which this resource belongs to.
+ private readonly Google.Apis.Services.IClientService service;
- ///
- /// 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"`
- ///
- [Google.Apis.Util.RequestParameterAttribute("filter", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string Filter { get; set; }
+ /// Constructs a new resource.
+ public HyperparameterTuningJobsResource(Google.Apis.Services.IClientService service)
+ {
+ this.service = service;
+ Operations = new OperationsResource(service);
+ }
- ///
- /// 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`
- ///
- [Google.Apis.Util.RequestParameterAttribute("orderBy", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string OrderBy { get; set; }
+ /// Gets the Operations resource.
+ public virtual OperationsResource Operations { get; }
- /// The standard list page size.
- [Google.Apis.Util.RequestParameterAttribute("pageSize", Google.Apis.Util.RequestParameterType.Query)]
- public virtual System.Nullable PageSize { get; set; }
+ /// The "operations" collection of methods.
+ public class OperationsResource
+ {
+ private const string Resource = "operations";
- /// The standard list page token.
- [Google.Apis.Util.RequestParameterAttribute("pageToken", Google.Apis.Util.RequestParameterType.Query)]
- public virtual string PageToken { get; set; }
+ /// The service which this resource belongs to.
+ private readonly Google.Apis.Services.IClientService service;
- /// Mask specifying which fields to read.
- [Google.Apis.Util.RequestParameterAttribute("readMask", Google.Apis.Util.RequestParameterType.Query)]
- public virtual object ReadMask { get; set; }
+ /// Constructs a new resource.
+ public OperationsResource(Google.Apis.Services.IClientService service)
+ {
+ this.service = service;
+ }
- /// Gets the method name.
- public override string MethodName => "list";
+ ///
+ /// Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel
+ /// the operation, but success is not guaranteed. If the server doesn't support this method, it returns
+ /// `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check
+ /// whether the cancellation succeeded or whether the operation completed despite cancellation. On
+ /// successful cancellation, the operation is not deleted; instead, it becomes an operation with an
+ /// Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+ ///
+ /// The name of the operation resource to be cancelled.
+ public virtual CancelRequest Cancel(string name)
+ {
+ return new CancelRequest(this.service, name);
+ }
- /// Gets the HTTP method.
- public override string HttpMethod => "GET";
+ ///
+ /// Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel
+ /// the operation, but success is not guaranteed. If the server doesn't support this method, it returns
+ /// `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check
+ /// whether the cancellation succeeded or whether the operation completed despite cancellation. On
+ /// successful cancellation, the operation is not deleted; instead, it becomes an operation with an
+ /// Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+ ///
+ public class CancelRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Cancel request.
+ public CancelRequest(Google.Apis.Services.IClientService service, string name) : base(service)
+ {
+ Name = name;
+ InitParameters();
+ }
- /// Gets the REST path.
- public override string RestPath => "v1/{+parent}/datasets";
+ /// The name of the operation resource to be cancelled.
+ [Google.Apis.Util.RequestParameterAttribute("name", Google.Apis.Util.RequestParameterType.Path)]
+ public virtual string Name { get; private set; }
- /// Initializes List parameter list.
- protected override void InitParameters()
+ /// Gets the method name.
+ public override string MethodName => "cancel";
+
+ /// Gets the HTTP method.
+ public override string HttpMethod => "POST";
+
+ /// Gets the REST path.
+ public override string RestPath => "v1/{+name}:cancel";
+
+ /// Initializes Cancel parameter list.
+ protected override void InitParameters()
+ {
+ base.InitParameters();
+ RequestParameters.Add("name", new Google.Apis.Discovery.Parameter
{
- base.InitParameters();
- RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter
- {
- Name = "parent",
- IsRequired = true,
- ParameterType = "path",
- DefaultValue = null,
- Pattern = @"^projects/[^/]+/locations/[^/]+$",
- });
- RequestParameters.Add("filter", new Google.Apis.Discovery.Parameter
- {
- Name = "filter",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("orderBy", new Google.Apis.Discovery.Parameter
- {
- Name = "orderBy",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter
- {
- Name = "pageSize",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter
- {
- Name = "pageToken",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- RequestParameters.Add("readMask", new Google.Apis.Discovery.Parameter
- {
- Name = "readMask",
- IsRequired = false,
- ParameterType = "query",
- DefaultValue = null,
- Pattern = null,
- });
- }
+ Name = "name",
+ IsRequired = true,
+ ParameterType = "path",
+ DefaultValue = null,
+ Pattern = @"^hyperparameterTuningJobs/[^/]+/operations/[^/]+$",
+ });
}
+ }
- /// Updates a Dataset.
- /// The body of the request.
- ///
- /// Output only. Identifier. The resource name of the Dataset. Format:
- /// `projects/{project}/locations/{location}/datasets/{dataset}`
- ///
- public virtual PatchRequest Patch(Google.Apis.Aiplatform.v1.Data.GoogleCloudAiplatformV1Dataset body, string name)
+ ///
+ /// Deletes a long-running operation. This method indicates that the client is no longer interested in the
+ /// operation result. It does not cancel the operation. If the server doesn't support this method, it
+ /// returns `google.rpc.Code.UNIMPLEMENTED`.
+ ///
+ /// The name of the operation resource to be deleted.
+ public virtual DeleteRequest Delete(string name)
+ {
+ return new DeleteRequest(this.service, name);
+ }
+
+ ///
+ /// Deletes a long-running operation. This method indicates that the client is no longer interested in the
+ /// operation result. It does not cancel the operation. If the server doesn't support this method, it
+ /// returns `google.rpc.Code.UNIMPLEMENTED`.
+ ///
+ public class DeleteRequest : AiplatformBaseServiceRequest
+ {
+ /// Constructs a new Delete request.
+ public DeleteRequest(Google.Apis.Services.IClientService service, string name) : base(service)
{
- return new PatchRequest(this.service, body, name);
+ Name = name;
+ InitParameters();
}
- /// Updates a Dataset.
- public class PatchRequest : AiplatformBaseServiceRequest
+ ///