diff --git a/disclaimers.json b/disclaimers.json index 3be6b11360f..1998491b0ac 100644 --- a/disclaimers.json +++ b/disclaimers.json @@ -671,6 +671,10 @@ "api": "chronicle", "package": "@google-cloud/chronicle" }, + { + "api": "hypercomputecluster", + "package": "@google-cloud/hypercomputecluster" + }, { "api": "configdelivery", "package": "@google-cloud/configdelivery" diff --git a/discovery/aiplatform-v1.json b/discovery/aiplatform-v1.json index 58bbfdaf522..5ce3701c438 100644 --- a/discovery/aiplatform-v1.json +++ b/discovery/aiplatform-v1.json @@ -10183,7 +10183,7 @@ ], "parameters": { "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{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, @@ -10426,6 +10426,40 @@ }, "openapi": { "methods": { + "completions": { + "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/completions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.openapi.completions", + "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}/completions", + "request": { + "$ref": "GoogleApiHttpBody" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, "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", @@ -21250,7 +21284,7 @@ ], "parameters": { "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", "required": true, @@ -22083,6 +22117,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "executeCode": { + "description": "Executes code statelessly.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:executeCode", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.executeCode", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:executeCode", + "request": { + "$ref": "GoogleCloudAiplatformV1ExecuteCodeRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1ExecuteCodeResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Gets a reasoning engine.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}", @@ -22899,57 +22961,54 @@ } } }, - "sessions": { + "sandboxEnvironments": { "methods": { - "appendEvent": { - "description": "Appends an event to a given session.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}:appendEvent", + "create": { + "description": "Creates a SandboxEnvironment in a given reasoning engine.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments", "httpMethod": "POST", - "id": "aiplatform.projects.locations.reasoningEngines.sessions.appendEvent", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.create", "parameterOrder": [ - "name" + "parent" ], "parameters": { - "name": { - "description": "Required. The resource name of the session to append event to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", + "parent": { + "description": "Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+name}:appendEvent", + "path": "v1/{+parent}/sandboxEnvironments", "request": { - "$ref": "GoogleCloudAiplatformV1SessionEvent" + "$ref": "GoogleCloudAiplatformV1SandboxEnvironment" }, "response": { - "$ref": "GoogleCloudAiplatformV1AppendEventResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "create": { - "description": "Creates a new Session.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.reasoningEngines.sessions.create", + "delete": { + "description": "Deletes the specific SandboxEnvironment.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.delete", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The resource name of the location to create the session in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "name": { + "description": "Required. The resource name of the SandboxEnvironment to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}/sessions", - "request": { - "$ref": "GoogleCloudAiplatformV1Session" - }, + "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, @@ -22957,131 +23016,95 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "delete": { - "description": "Deletes details of the specific Session.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.reasoningEngines.sessions.delete", + "execute": { + "description": "Executes using a sandbox environment.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:execute", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.execute", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", + "description": "Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+name}", + "path": "v1/{+name}:execute", + "request": { + "$ref": "GoogleCloudAiplatformV1ExecuteSandboxEnvironmentRequest" + }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1ExecuteSandboxEnvironmentResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { - "description": "Gets details of the specific Session.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", + "description": "Gets details of the specific SandboxEnvironment.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.reasoningEngines.sessions.get", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", + "description": "Required. The resource name of the sandbox environment. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1Session" + "$ref": "GoogleCloudAiplatformV1SandboxEnvironment" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists Sessions in a given reasoning engine.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions", + "description": "Lists SandboxEnvironments in a given reasoning engine.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments", "httpMethod": "GET", - "id": "aiplatform.projects.locations.reasoningEngines.sessions.list", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { - "description": "Optional. The standard list filter. Supported fields: * `display_name` * `user_id` * `labels` Example: `display_name=\"abc\"`, `user_id=\"123\"`, `labels.key=\"value\"`.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`.", + "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" }, "pageSize": { - "description": "Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 100 sessions will be returned.", + "description": "Optional. The maximum number of SandboxEnvironments to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironments will be returned.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. The next_page_token value returned from a previous list SessionService.ListSessions call.", + "description": "Optional. The standard list page token, received from a previous `ListSandboxEnvironments` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the location to list sessions from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "description": "Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}/sessions", - "response": { - "$ref": "GoogleCloudAiplatformV1ListSessionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "description": "Updates the specific Session.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.reasoningEngines.sessions.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1Session" - }, + "path": "v1/{+parent}/sandboxEnvironments", "response": { - "$ref": "GoogleCloudAiplatformV1Session" + "$ref": "GoogleCloudAiplatformV1ListSandboxEnvironmentsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -23089,63 +23112,13 @@ } }, "resources": { - "events": { - "methods": { - "list": { - "description": "Lists Events in a given session.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/events", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.reasoningEngines.sessions.events.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. The standard list filter. Supported fields: * `timestamp` range (i.e. `timestamp>=\"2025-01-31T11:30:00-04:00\"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160).", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `timestamp` Example: `timestamp desc`.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. These events are ordered by timestamp in ascending order.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The next_page_token value returned from a previous list SessionService.ListEvents call.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the session to list events from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/events", - "response": { - "$ref": "GoogleCloudAiplatformV1ListEventsResponse" - }, - "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}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:cancel", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.cancel", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.cancel", "parameterOrder": [ "name" ], @@ -23153,7 +23126,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -23168,9 +23141,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.delete", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.delete", "parameterOrder": [ "name" ], @@ -23178,7 +23151,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -23193,9 +23166,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.get", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.get", "parameterOrder": [ "name" ], @@ -23203,7 +23176,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -23216,57 +23189,11 @@ "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}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default 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}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:wait", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.wait", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.wait", "parameterOrder": [ "name" ], @@ -23274,7 +23201,405 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "sessions": { + "methods": { + "appendEvent": { + "description": "Appends an event to a given session.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}:appendEvent", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.appendEvent", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the session to append event to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:appendEvent", + "request": { + "$ref": "GoogleCloudAiplatformV1SessionEvent" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1AppendEventResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a new Session.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the location to create the session in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/sessions", + "request": { + "$ref": "GoogleCloudAiplatformV1Session" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes details of the specific Session.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of the specific Session.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1Session" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Sessions in a given reasoning engine.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The standard list filter. Supported fields: * `display_name` * `user_id` * `labels` Example: `display_name=\"abc\"`, `user_id=\"123\"`, `labels.key=\"value\"`.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 100 sessions will be returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The next_page_token value returned from a previous list SessionService.ListSessions call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the location to list sessions from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/sessions", + "response": { + "$ref": "GoogleCloudAiplatformV1ListSessionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the specific Session.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1Session" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1Session" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "events": { + "methods": { + "list": { + "description": "Lists Events in a given session.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/events", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.events.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The standard list filter. Supported fields: * `timestamp` range (i.e. `timestamp>=\"2025-01-31T11:30:00-04:00\"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `timestamp` Example: `timestamp desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. These events are ordered by timestamp in ascending order.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The next_page_token value returned from a previous list SessionService.ListEvents call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the session to list events from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/events", + "response": { + "$ref": "GoogleCloudAiplatformV1ListEventsResponse" + }, + "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}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/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}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/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}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/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}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default 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}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -27763,6 +28088,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "executeCode": { + "description": "Executes code statelessly.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}:executeCode", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.executeCode", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:executeCode", + "request": { + "$ref": "GoogleCloudAiplatformV1ExecuteCodeRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1ExecuteCodeResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Gets a reasoning engine.", "flatPath": "v1/reasoningEngines/{reasoningEnginesId}", @@ -28233,6 +28586,269 @@ } } }, + "sandboxEnvironments": { + "methods": { + "create": { + "description": "Creates a SandboxEnvironment in a given reasoning engine.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.sandboxEnvironments.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/sandboxEnvironments", + "request": { + "$ref": "GoogleCloudAiplatformV1SandboxEnvironment" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes the specific SandboxEnvironment.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}", + "httpMethod": "DELETE", + "id": "aiplatform.reasoningEngines.sandboxEnvironments.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the SandboxEnvironment to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "execute": { + "description": "Executes using a sandbox environment.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:execute", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.sandboxEnvironments.execute", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:execute", + "request": { + "$ref": "GoogleCloudAiplatformV1ExecuteSandboxEnvironmentRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1ExecuteSandboxEnvironmentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of the specific SandboxEnvironment.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.sandboxEnvironments.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the sandbox environment. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1SandboxEnvironment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists SandboxEnvironments in a given reasoning engine.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.sandboxEnvironments.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of SandboxEnvironments to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironments will be returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token, received from a previous `ListSandboxEnvironments` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/sandboxEnvironments", + "response": { + "$ref": "GoogleCloudAiplatformV1ListSandboxEnvironmentsResponse" + }, + "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}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.sandboxEnvironments.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/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}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.reasoningEngines.sandboxEnvironments.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/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}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.sandboxEnvironments.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.sandboxEnvironments.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "sessions": { "resources": { "operations": { @@ -30023,7 +30639,7 @@ } } }, - "revision": "20251210", + "revision": "20251215", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -32323,6 +32939,26 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1Chunk": { + "description": "Container for bytes-encoded data such as video frame, audio sample, or a complete binary/text data.", + "id": "GoogleCloudAiplatformV1Chunk", + "properties": { + "data": { + "description": "Required. The data in the chunk.", + "format": "byte", + "type": "string" + }, + "metadata": { + "$ref": "GoogleCloudAiplatformV1Metadata", + "description": "Optional. Metadata that is associated with the data in the payload." + }, + "mimeType": { + "description": "Required. Mime type of the chunk data. See https://www.iana.org/assignments/media-types/media-types.xhtml for the full list.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1Citation": { "description": "A citation for a piece of generatedcontent.", "id": "GoogleCloudAiplatformV1Citation", @@ -35080,11 +35716,11 @@ "type": "object" }, "GoogleCloudAiplatformV1EncryptionSpec": { - "description": "Represents a customer-managed encryption key spec that can be applied to a top-level resource.", + "description": "Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource.", "id": "GoogleCloudAiplatformV1EncryptionSpec", "properties": { "kmsKeyName": { - "description": "Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.", + "description": "Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.", "type": "string" } }, @@ -36908,6 +37544,62 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1ExecuteCodeRequest": { + "description": "Request message for SandboxEnvironmentExecutionService.ExecuteCode.", + "id": "GoogleCloudAiplatformV1ExecuteCodeRequest", + "properties": { + "inputs": { + "description": "Required. The inputs used for the stateless code execution.", + "items": { + "$ref": "GoogleCloudAiplatformV1Chunk" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ExecuteCodeResponse": { + "description": "Response message for SandboxEnvironmentExecutionService.ExecuteCode.", + "id": "GoogleCloudAiplatformV1ExecuteCodeResponse", + "properties": { + "outputs": { + "description": "The outputs from the sandbox environment.", + "items": { + "$ref": "GoogleCloudAiplatformV1Chunk" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ExecuteSandboxEnvironmentRequest": { + "description": "Request message for SandboxEnvironmentExecutionService.Execute.", + "id": "GoogleCloudAiplatformV1ExecuteSandboxEnvironmentRequest", + "properties": { + "inputs": { + "description": "Required. The inputs to the sandbox environment.", + "items": { + "$ref": "GoogleCloudAiplatformV1Chunk" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ExecuteSandboxEnvironmentResponse": { + "description": "Response message for SandboxEnvironmentExecutionService.Execute.", + "id": "GoogleCloudAiplatformV1ExecuteSandboxEnvironmentResponse", + "properties": { + "outputs": { + "description": "The outputs from the sandbox environment.", + "items": { + "$ref": "GoogleCloudAiplatformV1Chunk" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1Execution": { "description": "Instance of a general execution.", "id": "GoogleCloudAiplatformV1Execution", @@ -40062,6 +40754,29 @@ "description": "Optional. If true, no revisions will be created for this request.", "type": "boolean" }, + "metadata": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1MemoryMetadataValue" + }, + "description": "Optional. User-provided metadata for the generated memories. This is not generated by Memory Bank.", + "type": "object" + }, + "metadataMergeStrategy": { + "description": "Optional. The strategy to use when applying metadata to existing memories.", + "enum": [ + "METADATA_MERGE_STRATEGY_UNSPECIFIED", + "OVERWRITE", + "MERGE", + "REQUIRE_EXACT_MATCH" + ], + "enumDescriptions": [ + "Unspecified metadata merge strategy. If unspecified, the default behavior is to overwrite existing metadata (`OVERWRITE`).", + "Replace the metadata of the updated memories with the new metadata.", + "Append new metadata to the existing metadata. If there are duplicate keys, the existing values will be overwritten.", + "Restrict consolidation to memories that have exactly the same metadata as the request. If a memory doesn't have the same metadata, it is not eligible for consolidation." + ], + "type": "string" + }, "revisionExpireTime": { "description": "Optional. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.", "format": "google-datetime", @@ -42832,6 +43547,24 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1ListSandboxEnvironmentsResponse": { + "description": "Response message for SandboxEnvironmentService.ListSandboxEnvironments.", + "id": "GoogleCloudAiplatformV1ListSandboxEnvironmentsResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as ListSandboxEnvironmentsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", + "type": "string" + }, + "sandboxEnvironments": { + "description": "The SandboxEnvironments matching the request.", + "items": { + "$ref": "GoogleCloudAiplatformV1SandboxEnvironment" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1ListSavedQueriesResponse": { "description": "Response message for DatasetService.ListSavedQueries.", "id": "GoogleCloudAiplatformV1ListSavedQueriesResponse", @@ -43321,6 +44054,13 @@ "description": "Required. Semantic knowledge extracted from the source content.", "type": "string" }, + "metadata": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1MemoryMetadataValue" + }, + "description": "Optional. User-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank.", + "type": "object" + }, "name": { "description": "Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "type": "string" @@ -43518,6 +44258,80 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1MemoryConjunctionFilter": { + "description": "A conjunction of filters that will be combined using AND logic.", + "id": "GoogleCloudAiplatformV1MemoryConjunctionFilter", + "properties": { + "filters": { + "description": "Filters that will combined using AND logic.", + "items": { + "$ref": "GoogleCloudAiplatformV1MemoryFilter" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1MemoryFilter": { + "description": "Filter to apply when retrieving memories.", + "id": "GoogleCloudAiplatformV1MemoryFilter", + "properties": { + "key": { + "description": "Key of the filter. For example, \"author\" would apply to `metadata` entries with the key \"author\".", + "type": "string" + }, + "negate": { + "description": "If true, the filter will be negated.", + "type": "boolean" + }, + "op": { + "description": "Operator to apply to the filter. If not set, then EQUAL will be used.", + "enum": [ + "OPERATOR_UNSPECIFIED", + "EQUAL", + "GREATER_THAN", + "LESS_THAN" + ], + "enumDescriptions": [ + "Unspecified operator. Defaults to EQUAL.", + "Equal to.", + "Greater than.", + "Less than." + ], + "type": "string" + }, + "value": { + "$ref": "GoogleCloudAiplatformV1MemoryMetadataValue", + "description": "Value to compare to." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1MemoryMetadataValue": { + "description": "Memory metadata.", + "id": "GoogleCloudAiplatformV1MemoryMetadataValue", + "properties": { + "boolValue": { + "description": "Boolean value.", + "type": "boolean" + }, + "doubleValue": { + "description": "Double value.", + "format": "double", + "type": "number" + }, + "stringValue": { + "description": "String value.", + "type": "string" + }, + "timestampValue": { + "description": "Timestamp value. When filtering on timestamp values, only the seconds field will be compared.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1MemoryRevision": { "description": "A revision of a Memory.", "id": "GoogleCloudAiplatformV1MemoryRevision", @@ -43605,6 +44419,21 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1Metadata": { + "description": "Metadata for a chunk.", + "id": "GoogleCloudAiplatformV1Metadata", + "properties": { + "attributes": { + "additionalProperties": { + "format": "byte", + "type": "string" + }, + "description": "Optional. Attributes attached to the data. The keys have semantic conventions and the consumers of the attributes should know how to deserialize the value bytes based on the keys.", + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1MetadataSchema": { "description": "Instance of a general MetadataSchema.", "id": "GoogleCloudAiplatformV1MetadataSchema", @@ -50685,11 +51514,11 @@ "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.", + "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. This field should not be set if the source is `agent_config_source`.", "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\".", + "description": "Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to \"root_agent\". This field should not be set if the source is `agent_config_source`.", "type": "string" }, "requirementsFile": { @@ -51082,6 +51911,13 @@ "description": "Optional. The standard list filter that will be applied to the retrieved memories. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `fact` * `create_time` * `update_time` * `topics` (i.e. `topics.custom_memory_topic_label: \"example topic\" OR topics.managed_memory_topic: USER_PREFERENCES`)", "type": "string" }, + "filterGroups": { + "description": "Optional. Metadata filters that will be applied to the retrieved memories' `metadata` using OR logic. Filters are defined using disjunctive normal form (OR of ANDs). For example: `filter_groups: [{filters: [{key: \"author\", value: {string_value: \"agent 123\"}, op: EQUAL}]}, {filters: [{key: \"label\", value: {string_value: \"travel\"}, op: EQUAL}, {key: \"author\", value: {string_value: \"agent 321\"}, op: EQUAL}]}]` would be equivalent to the logical expression: `(metadata.author = \"agent 123\" OR (metadata.label = \"travel\" AND metadata.author = \"agent 321\"))`.", + "items": { + "$ref": "GoogleCloudAiplatformV1MemoryConjunctionFilter" + }, + "type": "array" + }, "scope": { "additionalProperties": { "type": "string" @@ -51801,6 +52637,139 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1SandboxEnvironment": { + "description": "SandboxEnvironment is a containerized environment that provides a customizable secure execution runtime for AI agents.", + "id": "GoogleCloudAiplatformV1SandboxEnvironment", + "properties": { + "connectionInfo": { + "$ref": "GoogleCloudAiplatformV1SandboxEnvironmentConnectionInfo", + "description": "Output only. The connection information of the SandboxEnvironment.", + "readOnly": true + }, + "createTime": { + "description": "Output only. The timestamp when this SandboxEnvironment was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the SandboxEnvironment.", + "type": "string" + }, + "expireTime": { + "description": "Optional. Timestamp in UTC of when this SandboxEnvironment is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.", + "format": "google-datetime", + "type": "string" + }, + "name": { + "description": "Identifier. The name of the SandboxEnvironment.", + "type": "string" + }, + "spec": { + "$ref": "GoogleCloudAiplatformV1SandboxEnvironmentSpec", + "description": "Optional. The configuration of the SandboxEnvironment." + }, + "state": { + "description": "Output only. The runtime state of the SandboxEnvironment.", + "enum": [ + "STATE_UNSPECIFIED", + "STATE_PROVISIONING", + "STATE_RUNNING", + "STATE_DEPROVISIONING", + "STATE_TERMINATED", + "STATE_DELETED" + ], + "enumDescriptions": [ + "The default value. This value is unused.", + "Runtime resources are being allocated for the sandbox environment.", + "Sandbox runtime is ready for serving.", + "Sandbox runtime is halted, performing tear down tasks.", + "Sandbox has terminated with underlying runtime failure.", + "Sandbox runtime has been deleted." + ], + "readOnly": true, + "type": "string" + }, + "ttl": { + "description": "Optional. Input only. The TTL for the sandbox environment. The expiration time is computed: now + TTL.", + "format": "google-duration", + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp when this SandboxEnvironment was most recently updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SandboxEnvironmentConnectionInfo": { + "description": "The connection information of the SandboxEnvironment.", + "id": "GoogleCloudAiplatformV1SandboxEnvironmentConnectionInfo", + "properties": { + "loadBalancerHostname": { + "description": "Output only. The hostname of the load balancer.", + "readOnly": true, + "type": "string" + }, + "loadBalancerIp": { + "description": "Output only. The IP address of the load balancer.", + "readOnly": true, + "type": "string" + }, + "sandboxInternalIp": { + "description": "Output only. The internal IP address of the SandboxEnvironment.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SandboxEnvironmentSpec": { + "description": "The specification of a SandboxEnvironment.", + "id": "GoogleCloudAiplatformV1SandboxEnvironmentSpec", + "properties": { + "codeExecutionEnvironment": { + "$ref": "GoogleCloudAiplatformV1SandboxEnvironmentSpecCodeExecutionEnvironment", + "description": "Optional. The code execution environment." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SandboxEnvironmentSpecCodeExecutionEnvironment": { + "description": "The code execution environment with customized settings.", + "id": "GoogleCloudAiplatformV1SandboxEnvironmentSpecCodeExecutionEnvironment", + "properties": { + "codeLanguage": { + "description": "The coding language supported in this environment.", + "enum": [ + "LANGUAGE_UNSPECIFIED", + "LANGUAGE_PYTHON", + "LANGUAGE_JAVASCRIPT" + ], + "enumDescriptions": [ + "The default value. This value is unused.", + "The coding language is Python.", + "The coding language is JavaScript." + ], + "type": "string" + }, + "machineConfig": { + "description": "The machine config of the code execution environment.", + "enum": [ + "MACHINE_CONFIG_UNSPECIFIED", + "MACHINE_CONFIG_VCPU4_RAM4GIB" + ], + "enumDescriptions": [ + "The default value: milligcu 2000, memory 1.5Gib", + "The default value: milligcu 4000, memory 4 Gib" + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1SavedQuery": { "description": "A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.", "id": "GoogleCloudAiplatformV1SavedQuery", @@ -52053,133 +53022,133 @@ "type": "object" }, "GoogleCloudAiplatformV1Schema": { - "description": "Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed.", + "description": "Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object).", "id": "GoogleCloudAiplatformV1Schema", "properties": { "additionalProperties": { - "description": "Optional. Can either be a boolean or an object; controls the presence of additional properties.", + "description": "Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.", "type": "any" }, "anyOf": { - "description": "Optional. The value should be validated against any (one or more) of the subschemas in the list.", + "description": "Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.", "items": { "$ref": "GoogleCloudAiplatformV1Schema" }, "type": "array" }, "default": { - "description": "Optional. Default value of the data.", + "description": "Optional. Default value to use if the field is not specified.", "type": "any" }, "defs": { "additionalProperties": { "$ref": "GoogleCloudAiplatformV1Schema" }, - "description": "Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.", + "description": "Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.", "type": "object" }, "description": { - "description": "Optional. The description of the data.", + "description": "Optional. Description of the schema.", "type": "string" }, "enum": { - "description": "Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[\"EAST\", NORTH\", \"SOUTH\", \"WEST\"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[\"101\", \"201\", \"301\"]}", + "description": "Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:[\"EAST\", \"NORTH\", \"SOUTH\", \"WEST\"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:[\"101\", \"201\", \"301\"]}`", "items": { "type": "string" }, "type": "array" }, "example": { - "description": "Optional. Example of the object. Will only populated when the object is the root.", + "description": "Optional. Example of an instance of this schema.", "type": "any" }, "format": { - "description": "Optional. The format of the data. Supported formats: for NUMBER type: \"float\", \"double\" for INTEGER type: \"int32\", \"int64\" for STRING type: \"email\", \"byte\", etc", + "description": "Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.", "type": "string" }, "items": { "$ref": "GoogleCloudAiplatformV1Schema", - "description": "Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY." + "description": "Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array." }, "maxItems": { - "description": "Optional. Maximum number of the elements for Type.ARRAY.", + "description": "Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.", "format": "int64", "type": "string" }, "maxLength": { - "description": "Optional. Maximum length of the Type.STRING", + "description": "Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.", "format": "int64", "type": "string" }, "maxProperties": { - "description": "Optional. Maximum number of the properties for Type.OBJECT.", + "description": "Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.", "format": "int64", "type": "string" }, "maximum": { - "description": "Optional. Maximum value of the Type.INTEGER and Type.NUMBER", + "description": "Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.", "format": "double", "type": "number" }, "minItems": { - "description": "Optional. Minimum number of the elements for Type.ARRAY.", + "description": "Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.", "format": "int64", "type": "string" }, "minLength": { - "description": "Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING", + "description": "Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.", "format": "int64", "type": "string" }, "minProperties": { - "description": "Optional. Minimum number of the properties for Type.OBJECT.", + "description": "Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.", "format": "int64", "type": "string" }, "minimum": { - "description": "Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER", + "description": "Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.", "format": "double", "type": "number" }, "nullable": { - "description": "Optional. Indicates if the value may be null.", + "description": "Optional. Indicates if the value of this field can be null.", "type": "boolean" }, "pattern": { - "description": "Optional. Pattern of the Type.STRING to restrict a string to a regular expression.", + "description": "Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.", "type": "string" }, "properties": { "additionalProperties": { "$ref": "GoogleCloudAiplatformV1Schema" }, - "description": "Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.", + "description": "Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.", "type": "object" }, "propertyOrdering": { - "description": "Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.", + "description": "Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.", "items": { "type": "string" }, "type": "array" }, "ref": { - "description": "Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named \"Pet\": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the \"pet\" property is a reference to the schema node named \"Pet\". See details in https://json-schema.org/understanding-json-schema/structuring", + "description": "Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named \"Pet\": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the \"pet\" property is a reference to the schema node named \"Pet\". See details in https://json-schema.org/understanding-json-schema/structuring", "type": "string" }, "required": { - "description": "Optional. Required properties of Type.OBJECT.", + "description": "Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.", "items": { "type": "string" }, "type": "array" }, "title": { - "description": "Optional. The title of the Schema.", + "description": "Optional. Title for the schema.", "type": "string" }, "type": { - "description": "Optional. The type of the data.", + "description": "Optional. Data type of the schema field.", "enum": [ "TYPE_UNSPECIFIED", "STRING", @@ -54062,6 +55031,20 @@ "description": "Serialized state of the code repository. This string will typically contain a JSON representation of the UI's CodeRepositoryService state (files, folders, content, and any metadata). The UI is responsible for serialization and deserialization.", "type": "string" }, + "framework": { + "description": "Optional. Framework used to build the application.", + "enum": [ + "FRAMEWORK_UNSPECIFIED", + "REACT", + "ANGULAR" + ], + "enumDescriptions": [ + "Unspecified framework.", + "React framework.", + "Angular framework." + ], + "type": "string" + }, "linkedResources": { "description": "Linked resources attached to the application by the user.", "items": { @@ -56200,16 +57183,16 @@ "type": "object" }, "GoogleCloudAiplatformV1SchemaVertex": { - "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.", + "description": "Represents a 2D point in the image. Vertex coordinates are normalized to be relative to the original image dimensions and range from 0 to 1. The origin of the coordinate system (0,0) is the top-left corner of the image. x increases to the right, and y increases to the bottom.", "id": "GoogleCloudAiplatformV1SchemaVertex", "properties": { "x": { - "description": "X coordinate.", + "description": "X coordinate of the vertex, normalized to [0.0, 1.0].", "format": "double", "type": "number" }, "y": { - "description": "Y coordinate.", + "description": "Y coordinate of the vertex, normalized to [0.0, 1.0].", "format": "double", "type": "number" } @@ -58898,6 +59881,10 @@ "deprecated": true, "description": "Optional. Specialized retrieval tool that is powered by Google Search." }, + "parallelAiSearch": { + "$ref": "GoogleCloudAiplatformV1ToolParallelAiSearch", + "description": "Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation" + }, "retrieval": { "$ref": "GoogleCloudAiplatformV1Retrieval", "description": "Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation." @@ -59141,6 +60128,25 @@ "properties": {}, "type": "object" }, + "GoogleCloudAiplatformV1ToolParallelAiSearch": { + "description": "ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding.", + "id": "GoogleCloudAiplatformV1ToolParallelAiSearch", + "properties": { + "apiKey": { + "description": "Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details.", + "type": "string" + }, + "customConfigs": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { \"source_policy\": { \"include_domains\": [\"google.com\", \"wikipedia.org\"], \"exclude_domains\": [\"example.com\"] }, \"fetch_policy\": { \"max_age_seconds\": 3600 } }", + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1ToolParameterKVMatchInput": { "description": "Input for tool parameter key value match metric.", "id": "GoogleCloudAiplatformV1ToolParameterKVMatchInput", diff --git a/discovery/aiplatform-v1beta1.json b/discovery/aiplatform-v1beta1.json index 839f7e8070f..0ff1b6c889b 100644 --- a/discovery/aiplatform-v1beta1.json +++ b/discovery/aiplatform-v1beta1.json @@ -12692,7 +12692,7 @@ ], "parameters": { "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{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, @@ -12966,6 +12966,40 @@ }, "openapi": { "methods": { + "completions": { + "description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/openapi/completions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.openapi.completions", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "deployedModelId": { + "description": "ID of the DeployedModel that serves the invoke request.", + "location": "query", + "type": "string" + }, + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/openapi$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}/completions", + "request": { + "$ref": "GoogleApiHttpBody" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, "embeddings": { "description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/openapi/embeddings", @@ -26561,7 +26595,7 @@ ], "parameters": { "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", "required": true, @@ -37739,7 +37773,7 @@ } } }, - "revision": "20251210", + "revision": "20251215", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -43450,11 +43484,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1EncryptionSpec": { - "description": "Represents a customer-managed encryption key spec that can be applied to a top-level resource.", + "description": "Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource.", "id": "GoogleCloudAiplatformV1beta1EncryptionSpec", "properties": { "kmsKeyName": { - "description": "Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.", + "description": "Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.", "type": "string" } }, @@ -49469,6 +49503,29 @@ "description": "Optional. If true, no revisions will be created for this request.", "type": "boolean" }, + "metadata": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1beta1MemoryMetadataValue" + }, + "description": "Optional. User-provided metadata for the generated memories. This is not generated by Memory Bank.", + "type": "object" + }, + "metadataMergeStrategy": { + "description": "Optional. The strategy to use when applying metadata to existing memories.", + "enum": [ + "METADATA_MERGE_STRATEGY_UNSPECIFIED", + "OVERWRITE", + "MERGE", + "REQUIRE_EXACT_MATCH" + ], + "enumDescriptions": [ + "Unspecified metadata merge strategy. If unspecified, the default behavior is to overwrite existing metadata (`OVERWRITE`).", + "Replace the metadata of the updated memories with the new metadata.", + "Append new metadata to the existing metadata. If there are duplicate keys, the existing values will be overwritten.", + "Restrict consolidation to memories that have exactly the same metadata as the request. If a memory doesn't have the same metadata, it is not eligible for consolidation." + ], + "type": "string" + }, "revisionExpireTime": { "description": "Optional. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.", "format": "google-datetime", @@ -53127,6 +53184,13 @@ "description": "Required. Semantic knowledge extracted from the source content.", "type": "string" }, + "metadata": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1beta1MemoryMetadataValue" + }, + "description": "Optional. User-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank.", + "type": "object" + }, "name": { "description": "Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "type": "string" @@ -53324,6 +53388,80 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1MemoryConjunctionFilter": { + "description": "A conjunction of filters that will be combined using AND logic.", + "id": "GoogleCloudAiplatformV1beta1MemoryConjunctionFilter", + "properties": { + "filters": { + "description": "Filters that will combined using AND logic.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1MemoryFilter" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1MemoryFilter": { + "description": "Filter to apply when retrieving memories.", + "id": "GoogleCloudAiplatformV1beta1MemoryFilter", + "properties": { + "key": { + "description": "Key of the filter. For example, \"author\" would apply to `metadata` entries with the key \"author\".", + "type": "string" + }, + "negate": { + "description": "If true, the filter will be negated.", + "type": "boolean" + }, + "op": { + "description": "Operator to apply to the filter. If not set, then EQUAL will be used.", + "enum": [ + "OPERATOR_UNSPECIFIED", + "EQUAL", + "GREATER_THAN", + "LESS_THAN" + ], + "enumDescriptions": [ + "Unspecified operator. Defaults to EQUAL.", + "Equal to.", + "Greater than.", + "Less than." + ], + "type": "string" + }, + "value": { + "$ref": "GoogleCloudAiplatformV1beta1MemoryMetadataValue", + "description": "Value to compare to." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1MemoryMetadataValue": { + "description": "Memory metadata.", + "id": "GoogleCloudAiplatformV1beta1MemoryMetadataValue", + "properties": { + "boolValue": { + "description": "Boolean value.", + "type": "boolean" + }, + "doubleValue": { + "description": "Double value.", + "format": "double", + "type": "number" + }, + "stringValue": { + "description": "String value.", + "type": "string" + }, + "timestampValue": { + "description": "Timestamp value. When filtering on timestamp values, only the seconds field will be compared.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1MemoryRevision": { "description": "A revision of a Memory.", "id": "GoogleCloudAiplatformV1beta1MemoryRevision", @@ -61933,11 +62071,11 @@ "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecPythonSpec", "properties": { "entrypointModule": { - "description": "Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to \"agent\". The project root will be added to Python sys.path, allowing imports to be specified relative to the root.", + "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. This field should not be set if the source is `agent_config_source`.", "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\".", + "description": "Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to \"root_agent\". This field should not be set if the source is `agent_config_source`.", "type": "string" }, "requirementsFile": { @@ -62566,6 +62704,13 @@ "description": "Optional. The standard list filter that will be applied to the retrieved memories. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `fact` * `create_time` * `update_time` * `topics` (i.e. `topics.custom_memory_topic_label: \"example topic\" OR topics.managed_memory_topic: USER_PREFERENCES`)", "type": "string" }, + "filterGroups": { + "description": "Optional. Metadata filters that will be applied to the retrieved memories' `metadata` using OR logic. Filters are defined using disjunctive normal form (OR of ANDs). For example: `filter_groups: [{filters: [{key: \"author\", value: {string_value: \"agent 123\"}, op: EQUAL}]}, {filters: [{key: \"label\", value: {string_value: \"travel\"}, op: EQUAL}, {key: \"author\", value: {string_value: \"agent 321\"}, op: EQUAL}]}]` would be equivalent to the logical expression: `(metadata.author = \"agent 123\" OR (metadata.label = \"travel\" AND metadata.author = \"agent 321\"))`.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1MemoryConjunctionFilter" + }, + "type": "array" + }, "scope": { "additionalProperties": { "type": "string" @@ -63826,133 +63971,133 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1Schema": { - "description": "Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed.", + "description": "Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object).", "id": "GoogleCloudAiplatformV1beta1Schema", "properties": { "additionalProperties": { - "description": "Optional. Can either be a boolean or an object; controls the presence of additional properties.", + "description": "Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.", "type": "any" }, "anyOf": { - "description": "Optional. The value should be validated against any (one or more) of the subschemas in the list.", + "description": "Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Schema" }, "type": "array" }, "default": { - "description": "Optional. Default value of the data.", + "description": "Optional. Default value to use if the field is not specified.", "type": "any" }, "defs": { "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1Schema" }, - "description": "Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.", + "description": "Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.", "type": "object" }, "description": { - "description": "Optional. The description of the data.", + "description": "Optional. Description of the schema.", "type": "string" }, "enum": { - "description": "Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[\"EAST\", NORTH\", \"SOUTH\", \"WEST\"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[\"101\", \"201\", \"301\"]}", + "description": "Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:[\"EAST\", \"NORTH\", \"SOUTH\", \"WEST\"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:[\"101\", \"201\", \"301\"]}`", "items": { "type": "string" }, "type": "array" }, "example": { - "description": "Optional. Example of the object. Will only populated when the object is the root.", + "description": "Optional. Example of an instance of this schema.", "type": "any" }, "format": { - "description": "Optional. The format of the data. Supported formats: for NUMBER type: \"float\", \"double\" for INTEGER type: \"int32\", \"int64\" for STRING type: \"email\", \"byte\", etc", + "description": "Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.", "type": "string" }, "items": { "$ref": "GoogleCloudAiplatformV1beta1Schema", - "description": "Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY." + "description": "Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array." }, "maxItems": { - "description": "Optional. Maximum number of the elements for Type.ARRAY.", + "description": "Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.", "format": "int64", "type": "string" }, "maxLength": { - "description": "Optional. Maximum length of the Type.STRING", + "description": "Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.", "format": "int64", "type": "string" }, "maxProperties": { - "description": "Optional. Maximum number of the properties for Type.OBJECT.", + "description": "Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.", "format": "int64", "type": "string" }, "maximum": { - "description": "Optional. Maximum value of the Type.INTEGER and Type.NUMBER", + "description": "Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.", "format": "double", "type": "number" }, "minItems": { - "description": "Optional. Minimum number of the elements for Type.ARRAY.", + "description": "Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.", "format": "int64", "type": "string" }, "minLength": { - "description": "Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING", + "description": "Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.", "format": "int64", "type": "string" }, "minProperties": { - "description": "Optional. Minimum number of the properties for Type.OBJECT.", + "description": "Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.", "format": "int64", "type": "string" }, "minimum": { - "description": "Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER", + "description": "Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.", "format": "double", "type": "number" }, "nullable": { - "description": "Optional. Indicates if the value may be null.", + "description": "Optional. Indicates if the value of this field can be null.", "type": "boolean" }, "pattern": { - "description": "Optional. Pattern of the Type.STRING to restrict a string to a regular expression.", + "description": "Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.", "type": "string" }, "properties": { "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1Schema" }, - "description": "Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.", + "description": "Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.", "type": "object" }, "propertyOrdering": { - "description": "Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.", + "description": "Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.", "items": { "type": "string" }, "type": "array" }, "ref": { - "description": "Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named \"Pet\": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the \"pet\" property is a reference to the schema node named \"Pet\". See details in https://json-schema.org/understanding-json-schema/structuring", + "description": "Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named \"Pet\": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the \"pet\" property is a reference to the schema node named \"Pet\". See details in https://json-schema.org/understanding-json-schema/structuring", "type": "string" }, "required": { - "description": "Optional. Required properties of Type.OBJECT.", + "description": "Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.", "items": { "type": "string" }, "type": "array" }, "title": { - "description": "Optional. The title of the Schema.", + "description": "Optional. Title for the schema.", "type": "string" }, "type": { - "description": "Optional. The type of the data.", + "description": "Optional. Data type of the schema field.", "enum": [ "TYPE_UNSPECIFIED", "STRING", @@ -65835,6 +65980,20 @@ "description": "Serialized state of the code repository. This string will typically contain a JSON representation of the UI's CodeRepositoryService state (files, folders, content, and any metadata). The UI is responsible for serialization and deserialization.", "type": "string" }, + "framework": { + "description": "Optional. Framework used to build the application.", + "enum": [ + "FRAMEWORK_UNSPECIFIED", + "REACT", + "ANGULAR" + ], + "enumDescriptions": [ + "Unspecified framework.", + "React framework.", + "Angular framework." + ], + "type": "string" + }, "linkedResources": { "description": "Linked resources attached to the application by the user.", "items": { @@ -67973,16 +68132,16 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaVertex": { - "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.", + "description": "Represents a 2D point in the image. Vertex coordinates are normalized to be relative to the original image dimensions and range from 0 to 1. The origin of the coordinate system (0,0) is the top-left corner of the image. x increases to the right, and y increases to the bottom.", "id": "GoogleCloudAiplatformV1beta1SchemaVertex", "properties": { "x": { - "description": "X coordinate.", + "description": "X coordinate of the vertex, normalized to [0.0, 1.0].", "format": "double", "type": "number" }, "y": { - "description": "Y coordinate.", + "description": "Y coordinate of the vertex, normalized to [0.0, 1.0].", "format": "double", "type": "number" } @@ -71091,6 +71250,10 @@ "deprecated": true, "description": "Optional. Specialized retrieval tool that is powered by Google Search." }, + "parallelAiSearch": { + "$ref": "GoogleCloudAiplatformV1beta1ToolParallelAiSearch", + "description": "Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation" + }, "retrieval": { "$ref": "GoogleCloudAiplatformV1beta1Retrieval", "description": "Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation." @@ -71334,6 +71497,25 @@ "properties": {}, "type": "object" }, + "GoogleCloudAiplatformV1beta1ToolParallelAiSearch": { + "description": "ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding.", + "id": "GoogleCloudAiplatformV1beta1ToolParallelAiSearch", + "properties": { + "apiKey": { + "description": "Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details.", + "type": "string" + }, + "customConfigs": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { \"source_policy\": { \"include_domains\": [\"google.com\", \"wikipedia.org\"], \"exclude_domains\": [\"example.com\"] }, \"fetch_policy\": { \"max_age_seconds\": 3600 } }", + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ToolParameterKVMatchInput": { "description": "Input for tool parameter key value match metric.", "id": "GoogleCloudAiplatformV1beta1ToolParameterKVMatchInput", @@ -73164,6 +73346,11 @@ "Tuning task for reference to video." ], "type": "string" + }, + "veoDataMixtureRatio": { + "description": "Optional. The ratio of Google internal dataset to use in the training mixture, in range of `[0, 1)`. If `0.2`, it means 20% of Google internal dataset and 80% of user dataset will be used for training.", + "format": "double", + "type": "number" } }, "type": "object" diff --git a/discovery/alloydb-v1.json b/discovery/alloydb-v1.json index bb95f315471..7e30b67e9f9 100644 --- a/discovery/alloydb-v1.json +++ b/discovery/alloydb-v1.json @@ -1879,7 +1879,7 @@ } } }, - "revision": "20251204", + "revision": "20251211", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2512,7 +2512,8 @@ "FAILED", "BOOTSTRAPPING", "MAINTENANCE", - "PROMOTING" + "PROMOTING", + "SWITCHOVER" ], "enumDescriptions": [ "The state of the cluster is unknown.", @@ -2524,7 +2525,8 @@ "The creation of the cluster failed.", "The cluster is bootstrapping with data from some other source. Direct mutations to the cluster (e.g. adding read pool) are not allowed.", "The cluster is under maintenance. AlloyDB regularly performs maintenance and upgrades on customer clusters. Updates on the cluster are not allowed while the cluster is in this state.", - "The cluster is being promoted." + "The cluster is being promoted.", + "The cluster has entered switchover state. All updates on cluster and its associated instances are restricted while the cluster is in this state." ], "readOnly": true, "type": "string" @@ -3337,7 +3339,8 @@ "MAINTENANCE", "FAILED", "BOOTSTRAPPING", - "PROMOTING" + "PROMOTING", + "SWITCHOVER" ], "enumDescriptions": [ "The state of the instance is unknown.", @@ -3348,7 +3351,8 @@ "The instance is down for maintenance.", "The creation of the instance failed or a fatal error occurred during an operation on the instance. Note: Instances in this state would tried to be auto-repaired. And Customers should be able to restart, update or delete these instances.", "The instance has been configured to sync data from some other source.", - "The instance is being promoted." + "The instance is being promoted.", + "The instance has entered switchover state. All updates on instance are restricted while the instance is in this state." ], "readOnly": true, "type": "string" diff --git a/discovery/alloydb-v1alpha.json b/discovery/alloydb-v1alpha.json index d27435adab0..20a29523c90 100644 --- a/discovery/alloydb-v1alpha.json +++ b/discovery/alloydb-v1alpha.json @@ -1879,7 +1879,7 @@ } } }, - "revision": "20251204", + "revision": "20251211", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2561,7 +2561,8 @@ "FAILED", "BOOTSTRAPPING", "MAINTENANCE", - "PROMOTING" + "PROMOTING", + "SWITCHOVER" ], "enumDescriptions": [ "The state of the cluster is unknown.", @@ -2573,7 +2574,8 @@ "The creation of the cluster failed.", "The cluster is bootstrapping with data from some other source. Direct mutations to the cluster (e.g. adding read pool) are not allowed.", "The cluster is under maintenance. AlloyDB regularly performs maintenance and upgrades on customer clusters. Updates on the cluster are not allowed while the cluster is in this state.", - "The cluster is being promoted." + "The cluster is being promoted.", + "The cluster has entered switchover state. All updates on cluster and its associated instances are restricted while the cluster is in this state." ], "readOnly": true, "type": "string" @@ -3519,7 +3521,8 @@ "MAINTENANCE", "FAILED", "BOOTSTRAPPING", - "PROMOTING" + "PROMOTING", + "SWITCHOVER" ], "enumDescriptions": [ "The state of the instance is unknown.", @@ -3530,7 +3533,8 @@ "The instance is down for maintenance.", "The creation of the instance failed or a fatal error occurred during an operation on the instance. Note: Instances in this state would tried to be auto-repaired. And Customers should be able to restart, update or delete these instances.", "The instance has been configured to sync data from some other source.", - "The instance is being promoted." + "The instance is being promoted.", + "The instance has entered switchover state. All updates on instance are restricted while the instance is in this state." ], "readOnly": true, "type": "string" diff --git a/discovery/alloydb-v1beta.json b/discovery/alloydb-v1beta.json index 264ba91e1d4..ceb4ef64a02 100644 --- a/discovery/alloydb-v1beta.json +++ b/discovery/alloydb-v1beta.json @@ -1876,7 +1876,7 @@ } } }, - "revision": "20251204", + "revision": "20251211", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2542,7 +2542,8 @@ "FAILED", "BOOTSTRAPPING", "MAINTENANCE", - "PROMOTING" + "PROMOTING", + "SWITCHOVER" ], "enumDescriptions": [ "The state of the cluster is unknown.", @@ -2554,7 +2555,8 @@ "The creation of the cluster failed.", "The cluster is bootstrapping with data from some other source. Direct mutations to the cluster (e.g. adding read pool) are not allowed.", "The cluster is under maintenance. AlloyDB regularly performs maintenance and upgrades on customer clusters. Updates on the cluster are not allowed while the cluster is in this state.", - "The cluster is being promoted." + "The cluster is being promoted.", + "The cluster has entered switchover state. All updates on cluster and its associated instances are restricted while the cluster is in this state." ], "readOnly": true, "type": "string" @@ -3495,7 +3497,8 @@ "MAINTENANCE", "FAILED", "BOOTSTRAPPING", - "PROMOTING" + "PROMOTING", + "SWITCHOVER" ], "enumDescriptions": [ "The state of the instance is unknown.", @@ -3506,7 +3509,8 @@ "The instance is down for maintenance.", "The creation of the instance failed or a fatal error occurred during an operation on the instance. Note: Instances in this state would tried to be auto-repaired. And Customers should be able to restart, update or delete these instances.", "The instance has been configured to sync data from some other source.", - "The instance is being promoted." + "The instance is being promoted.", + "The instance has entered switchover state. All updates on instance are restricted while the instance is in this state." ], "readOnly": true, "type": "string" diff --git a/discovery/apigateway-v1.json b/discovery/apigateway-v1.json index 310a3ca2533..4b55b953ccf 100644 --- a/discovery/apigateway-v1.json +++ b/discovery/apigateway-v1.json @@ -1074,7 +1074,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -1094,7 +1094,7 @@ } } }, - "revision": "20251021", + "revision": "20251210", "rootUrl": "https://apigateway.googleapis.com/", "schemas": { "ApigatewayApi": { @@ -1563,7 +1563,7 @@ "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.", + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, diff --git a/discovery/apigateway-v1beta.json b/discovery/apigateway-v1beta.json index 516f576e739..7dd9c2f1e6b 100644 --- a/discovery/apigateway-v1beta.json +++ b/discovery/apigateway-v1beta.json @@ -1074,7 +1074,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -1094,7 +1094,7 @@ } } }, - "revision": "20251021", + "revision": "20251210", "rootUrl": "https://apigateway.googleapis.com/", "schemas": { "ApigatewayApi": { @@ -1591,7 +1591,7 @@ "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.", + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, diff --git a/discovery/apigee-v1.json b/discovery/apigee-v1.json index 20d48befaf9..dfde8b6bdfb 100644 --- a/discovery/apigee-v1.json +++ b/discovery/apigee-v1.json @@ -763,6 +763,168 @@ } } }, + "apimServiceExtensions": { + "methods": { + "create": { + "description": "Creates an APIM ServiceExtension in an organization.", + "flatPath": "v1/organizations/{organizationsId}/apimServiceExtensions", + "httpMethod": "POST", + "id": "apigee.organizations.apimServiceExtensions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "apimServiceExtensionId": { + "description": "Optional. ID used to uniquely identify of the service extension. It must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Name of the organization in which the service extension will be created. Use the following structure in your request: `organizations/{org}`", + "location": "path", + "pattern": "^organizations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/apimServiceExtensions", + "request": { + "$ref": "GoogleCloudApigeeV1ApimServiceExtension" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes APIM service extension from an organization.", + "flatPath": "v1/organizations/{organizationsId}/apimServiceExtensions/{apimServiceExtensionsId}", + "httpMethod": "DELETE", + "id": "apigee.organizations.apimServiceExtensions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the service extension. Use the following structure in your request: `organizations/{org}/apimServiceExtensions/{extension_id}`", + "location": "path", + "pattern": "^organizations/[^/]+/apimServiceExtensions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets APIM service extension details.", + "flatPath": "v1/organizations/{organizationsId}/apimServiceExtensions/{apimServiceExtensionsId}", + "httpMethod": "GET", + "id": "apigee.organizations.apimServiceExtensions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the service extension. Use the following structure in your request: `organizations/{org}/apimServiceExtensions/{extension_id}`", + "location": "path", + "pattern": "^organizations/[^/]+/apimServiceExtensions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApigeeV1ApimServiceExtension" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all APIM service extensions in an organization.", + "flatPath": "v1/organizations/{organizationsId}/apimServiceExtensions", + "httpMethod": "GET", + "id": "apigee.organizations.apimServiceExtensions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. Maximum number of items to return. If unspecified, at most 25 service extension will be returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Page token, returned from a previous `ListApimServiceExtensions` call, that you can use to retrieve the next page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Name of the organization for which to list the service extension. Use the following structure in your request: `organizations/{org}/apimServiceExtensions`", + "location": "path", + "pattern": "^organizations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/apimServiceExtensions", + "response": { + "$ref": "GoogleCloudApigeeV1ListApimServiceExtensionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an APIM service extension in an organization.", + "flatPath": "v1/organizations/{organizationsId}/apimServiceExtensions/{apimServiceExtensionsId}", + "httpMethod": "PATCH", + "id": "apigee.organizations.apimServiceExtensions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "allowMissing": { + "description": "Optional. If set to true, and the service extension is not found, a new service extension will be created. In this situation, `update_mask` is ignored.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Identifier. unique name of the APIM service extension. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.", + "location": "path", + "pattern": "^organizations/[^/]+/apimServiceExtensions/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudApigeeV1ApimServiceExtension" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "apiproducts": { "methods": { "attributes": { @@ -2001,6 +2163,56 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getBalance": { + "description": "Gets the account balance for the AppGroup.", + "flatPath": "v1/organizations/{organizationsId}/appgroups/{appgroupsId}/balance", + "httpMethod": "GET", + "id": "apigee.organizations.appgroups.getBalance", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Account balance for the AppGroup. Use the following structure in your request: `organizations/{org}/appgroups/{app_group}/balance`", + "location": "path", + "pattern": "^organizations/[^/]+/appgroups/[^/]+/balance$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApigeeV1AppGroupBalance" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getMonetizationConfig": { + "description": "Gets the monetization configuration for the AppGroup.", + "flatPath": "v1/organizations/{organizationsId}/appgroups/{appgroupsId}/monetizationConfig", + "httpMethod": "GET", + "id": "apigee.organizations.appgroups.getMonetizationConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Monetization configuration for the AppGroup. Use the following structure in your request: `organizations/{org}/appgroups/{app_group}/monetizationConfig`", + "location": "path", + "pattern": "^organizations/[^/]+/appgroups/[^/]+/monetizationConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApigeeV1AppGroupMonetizationConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists all AppGroups in an organization. A maximum of 1000 AppGroups are returned in the response if PageSize is not specified, or if the PageSize is greater than 1000.", "flatPath": "v1/organizations/{organizationsId}/appgroups", @@ -2074,6 +2286,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "updateMonetizationConfig": { + "description": "Updates the monetization configuration for the AppGroup.", + "flatPath": "v1/organizations/{organizationsId}/appgroups/{appgroupsId}/monetizationConfig", + "httpMethod": "PUT", + "id": "apigee.organizations.appgroups.updateMonetizationConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Monetization configuration for the AppGroup. Use the following structure in your request: `organizations/{org}/appgroups/{app_group}/monetizationConfig`", + "location": "path", + "pattern": "^organizations/[^/]+/appgroups/[^/]+/monetizationConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudApigeeV1AppGroupMonetizationConfig" + }, + "response": { + "$ref": "GoogleCloudApigeeV1AppGroupMonetizationConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -2397,7 +2637,188 @@ } } } - } + } + } + } + }, + "balance": { + "methods": { + "adjust": { + "description": "Adjust the prepaid balance for the AppGroup. This API will be used in scenarios where the AppGroup has been under-charged or over-charged.", + "flatPath": "v1/organizations/{organizationsId}/appgroups/{appgroupsId}/balance:adjust", + "httpMethod": "POST", + "id": "apigee.organizations.appgroups.balance.adjust", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Account balance for the AppGroup. Use the following structure in your request: `organizations/{org}/appgroups/{app_group}/balance`", + "location": "path", + "pattern": "^organizations/[^/]+/appgroups/[^/]+/balance$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:adjust", + "request": { + "$ref": "GoogleCloudApigeeV1AdjustAppGroupBalanceRequest" + }, + "response": { + "$ref": "GoogleCloudApigeeV1AppGroupBalance" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "credit": { + "description": "Credits the account balance for the AppGroup.", + "flatPath": "v1/organizations/{organizationsId}/appgroups/{appgroupsId}/balance:credit", + "httpMethod": "POST", + "id": "apigee.organizations.appgroups.balance.credit", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Account balance for the AppGroup. Use the following structure in your request: `organizations/{org}/appgroups/{app_group}/balance`", + "location": "path", + "pattern": "^organizations/[^/]+/appgroups/[^/]+/balance$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:credit", + "request": { + "$ref": "GoogleCloudApigeeV1CreditAppGroupBalanceRequest" + }, + "response": { + "$ref": "GoogleCloudApigeeV1AppGroupBalance" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "subscriptions": { + "methods": { + "create": { + "description": "Creates a subscription to an API product. ", + "flatPath": "v1/organizations/{organizationsId}/appgroups/{appgroupsId}/subscriptions", + "httpMethod": "POST", + "id": "apigee.organizations.appgroups.subscriptions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Name of the appgroup that is purchasing a subscription to the API product. Use the following structure in your request: `organizations/{org}/appgroups/{appgroup}`", + "location": "path", + "pattern": "^organizations/[^/]+/appgroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/subscriptions", + "request": { + "$ref": "GoogleCloudApigeeV1AppGroupSubscription" + }, + "response": { + "$ref": "GoogleCloudApigeeV1AppGroupSubscription" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "expire": { + "description": "Expires an API product subscription immediately.", + "flatPath": "v1/organizations/{organizationsId}/appgroups/{appgroupsId}/subscriptions/{subscriptionsId}:expire", + "httpMethod": "POST", + "id": "apigee.organizations.appgroups.subscriptions.expire", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the API product subscription. Use the following structure in your request: `organizations/{org}/appgroups/{appgroup}/subscriptions/{subscription}`", + "location": "path", + "pattern": "^organizations/[^/]+/appgroups/[^/]+/subscriptions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:expire", + "request": { + "$ref": "GoogleCloudApigeeV1ExpireAppGroupSubscriptionRequest" + }, + "response": { + "$ref": "GoogleCloudApigeeV1AppGroupSubscription" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get an api product subscription for an appgroup.", + "flatPath": "v1/organizations/{organizationsId}/appgroups/{appgroupsId}/subscriptions/{subscriptionsId}", + "httpMethod": "GET", + "id": "apigee.organizations.appgroups.subscriptions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the AppGroupSubscription to retrieve. Format: `organizations/{org}/appgroups/{appgroup}/subscriptions/{subscription}`", + "location": "path", + "pattern": "^organizations/[^/]+/appgroups/[^/]+/subscriptions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApigeeV1AppGroupSubscription" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List all api product subscriptions for an appgroup.", + "flatPath": "v1/organizations/{organizationsId}/appgroups/{appgroupsId}/subscriptions", + "httpMethod": "GET", + "id": "apigee.organizations.appgroups.subscriptions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of subscriptions to return. The service may return fewer than this value. If unspecified, at most 100 subscriptions 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 `ListAppGroupSubscriptions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAppGroupSubscriptions` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Name of the appgroup. Use the following structure in your request: `organizations/{org}/appgroups/{appgroup}`", + "location": "path", + "pattern": "^organizations/[^/]+/appgroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/subscriptions", + "response": { + "$ref": "GoogleCloudApigeeV1ListAppGroupSubscriptionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } } @@ -11493,7 +11914,7 @@ } } }, - "revision": "20251125", + "revision": "20251216", "rootUrl": "https://apigee.googleapis.com/", "schemas": { "EdgeConfigstoreBundleBadBundle": { @@ -11676,6 +12097,17 @@ }, "type": "object" }, + "GoogleCloudApigeeV1AdjustAppGroupBalanceRequest": { + "description": "Request for AdjustAppGroupBalance.", + "id": "GoogleCloudApigeeV1AdjustAppGroupBalanceRequest", + "properties": { + "adjustment": { + "$ref": "GoogleTypeMoney", + "description": "Required. * A positive value of `adjustment` means that that the API provider wants to adjust the balance for an under-charged AppGroup i.e. the balance of the AppGroup will decrease. * A negative value of `adjustment` is not supported. Use credit balance API instead." + } + }, + "type": "object" + }, "GoogleCloudApigeeV1AdjustDeveloperBalanceRequest": { "description": "Request for AdjustDeveloperBalance.", "id": "GoogleCloudApigeeV1AdjustDeveloperBalanceRequest", @@ -11962,6 +12394,10 @@ "description": "The documentation for a catalog item.", "id": "GoogleCloudApigeeV1ApiDocDocumentation", "properties": { + "asyncApiDocumentation": { + "$ref": "GoogleCloudApigeeV1AsyncApiDocumentation", + "description": "Optional. AsyncAPI Specification documentation." + }, "graphqlDocumentation": { "$ref": "GoogleCloudApigeeV1GraphqlDocumentation", "description": "Optional. GraphQL documentation." @@ -12430,6 +12866,137 @@ }, "type": "object" }, + "GoogleCloudApigeeV1ApimServiceExtension": { + "description": "APIM Service Extension is a resource under an Apigee Organization that is used to create APIM Service Extension to route traffic to existing X instances.", + "id": "GoogleCloudApigeeV1ApimServiceExtension", + "properties": { + "createTime": { + "description": "Output only. The time that this resource was created on the server.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "extensionProcessor": { + "description": "Required. Name of the proxy deployed in the Apigee X instance.", + "type": "string" + }, + "extensions": { + "description": "Optional. List of extensions that are part of the service extension. Refer to https://cloud.google.com/service-extensions/docs/quotas#limits for any limits.", + "items": { + "$ref": "GoogleCloudApigeeV1ApimServiceExtensionExtension" + }, + "type": "array" + }, + "lbForwardingRule": { + "description": "Required. Name of the Google Cloud LB forwarding rule. Format: projects/{project}/regions/{region}/forwardingRules/{forwarding_rule} projects/{project}/global/forwardingRules/{forwarding_rule}", + "type": "string" + }, + "name": { + "description": "Identifier. unique name of the APIM service extension. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.", + "type": "string" + }, + "network": { + "description": "Required. The network where the forwarding rule is created. Format: projects/{project}/global/networks/{network}", + "type": "string" + }, + "networkConfigs": { + "description": "Required. List of network configurations for the APIM service extension.", + "items": { + "$ref": "GoogleCloudApigeeV1ApimServiceExtensionNetworkConfig" + }, + "type": "array" + }, + "state": { + "description": "Output only. State of the APIM service extension. Values other than `ACTIVE` mean the resource is not ready to use.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "DELETING", + "UPDATING" + ], + "enumDescriptions": [ + "Resource is in an unspecified state.", + "Resource is being created.", + "Resource is provisioned and ready to use.", + "The resource is being deleted.", + "The resource is being updated." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time that this resource was updated on the server.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApigeeV1ApimServiceExtensionExtension": { + "description": "Extension configuration for Apigee extension processor service extension.", + "id": "GoogleCloudApigeeV1ApimServiceExtensionExtension", + "properties": { + "failOpen": { + "description": "Optional. Whether this request should fail open.", + "type": "boolean" + }, + "hostname": { + "description": "Required. One of the hostnames of Apigee EnvGroup where the proxy is deployed. This hostname (i.e FDQN) will be used to route traffic from the specified forwarding rule to the environment in Apigee X instance where the proxy is deployed for handling extension traffic. Format: ^([a-zA-Z0-9. _-])+$", + "type": "string" + }, + "matchCondition": { + "description": "Optional. Match Condition for CEL expression. Refer to https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference for more details.", + "type": "string" + }, + "name": { + "description": "Required. Name of the `LbTrafficExtension` resource. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.", + "type": "string" + }, + "supportedEvents": { + "description": "Optional. Supported events for the Service Extension. If not specified, all events are supported.", + "items": { + "enum": [ + "SUPPORTED_EVENT_UNSPECIFIED", + "REQUEST_HEADERS", + "REQUEST_BODY", + "RESPONSE_HEADERS", + "RESPONSE_BODY", + "REQUEST_TRAILERS", + "RESPONSE_TRAILERS" + ], + "enumDescriptions": [ + "Unspecified event.", + "Request headers event.", + "Request body event.", + "Response headers event.", + "Response body event.", + "Request trailers event.", + "Response trailers event." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudApigeeV1ApimServiceExtensionNetworkConfig": { + "description": "Network configuration for the APIM service extension.", + "id": "GoogleCloudApigeeV1ApimServiceExtensionNetworkConfig", + "properties": { + "region": { + "description": "Required. The region for the PSC NEG.", + "type": "string" + }, + "subnet": { + "description": "Required. The subnet for the PSC NEG. Format: projects/{project}/regions/{region}/subnetworks/{subnet}", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1App": { "id": "GoogleCloudApigeeV1App", "properties": { @@ -12548,6 +13115,10 @@ "description": "app group name displayed in the UI", "type": "string" }, + "email": { + "description": "Optional. Email of the AppGroup.", + "type": "string" + }, "lastModifiedAt": { "description": "Output only. Modified time as milliseconds since epoch.", "format": "int64", @@ -12700,6 +13271,99 @@ }, "type": "object" }, + "GoogleCloudApigeeV1AppGroupBalance": { + "description": "AppGroupBalance for the AppGroup.", + "id": "GoogleCloudApigeeV1AppGroupBalance", + "properties": { + "wallets": { + "description": "Output only. List of all wallets. Each individual wallet stores the account balance for a particular currency.", + "items": { + "$ref": "GoogleCloudApigeeV1AppGroupBalanceWallet" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudApigeeV1AppGroupBalanceWallet": { + "description": "Wallet used to manage an account balance for a particular currency.", + "id": "GoogleCloudApigeeV1AppGroupBalanceWallet", + "properties": { + "balance": { + "$ref": "GoogleTypeMoney", + "description": "Current remaining balance of the AppGroup for a particular currency." + }, + "lastCreditTime": { + "description": "Output only. Time at which the AppGroup last added credit to the account in milliseconds since epoch.", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApigeeV1AppGroupMonetizationConfig": { + "description": "Monetization configuration for the AppGroup.", + "id": "GoogleCloudApigeeV1AppGroupMonetizationConfig", + "properties": { + "billingType": { + "description": "Required. Billing type.", + "enum": [ + "BILLING_TYPE_UNSPECIFIED", + "PREPAID", + "POSTPAID" + ], + "enumDescriptions": [ + "The default/unset value.", + "AppGroup pays in advance for the use of APIs and the charged amount is deducted from their account balance.", + "AppGroup does not maintain an account balance. The API provider bills the AppGroup for API usage." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApigeeV1AppGroupSubscription": { + "description": "AppGroup Subscription details.", + "id": "GoogleCloudApigeeV1AppGroupSubscription", + "properties": { + "apiproduct": { + "description": "Required. Name of the API product for which the appgroup is purchasing a subscription.", + "type": "string" + }, + "createdAt": { + "description": "Output only. Time when the API product subscription was created in milliseconds since epoch.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. Time when the API product subscription ends in milliseconds since epoch.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "lastModifiedAt": { + "description": "Output only. Time when the API product subscription was last modified in milliseconds since epoch.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. Name of the API product subscription.", + "readOnly": true, + "type": "string" + }, + "startTime": { + "description": "Output only. Time when the API product subscription starts in milliseconds since epoch.", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1ArchiveDeployment": { "description": "Archive Deployment information.", "id": "GoogleCloudApigeeV1ArchiveDeployment", @@ -12739,6 +13403,17 @@ }, "type": "object" }, + "GoogleCloudApigeeV1AsyncApiDocumentation": { + "description": "AsyncAPI Specification documentation for a catalog item.", + "id": "GoogleCloudApigeeV1AsyncApiDocumentation", + "properties": { + "spec": { + "$ref": "GoogleCloudApigeeV1DocumentationFile", + "description": "Required. The documentation file contents for the AsyncAPI Specification. JSON and YAML file formats are supported." + } + }, + "type": "object" + }, "GoogleCloudApigeeV1AsyncQuery": { "id": "GoogleCloudApigeeV1AsyncQuery", "properties": { @@ -13372,6 +14047,21 @@ }, "type": "object" }, + "GoogleCloudApigeeV1CreditAppGroupBalanceRequest": { + "description": "Request for CreditAppGroupBalance.", + "id": "GoogleCloudApigeeV1CreditAppGroupBalanceRequest", + "properties": { + "transactionAmount": { + "$ref": "GoogleTypeMoney", + "description": "Required. The amount of money to be credited. The wallet corresponding to the currency specified within `transaction_amount` will be updated. For example, if you specified `currency_code` within `transaction_amount` as \"USD\", then the amount would be added to the wallet which has the \"USD\" currency or if no such wallet exists, a new wallet will be created with the \"USD\" currency." + }, + "transactionId": { + "description": "Required. Each transaction_id uniquely identifies a credit balance request. If multiple requests are received with the same transaction_id, only one of them will be considered.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1CreditDeveloperBalanceRequest": { "description": "Request for CreditDeveloperBalance.", "id": "GoogleCloudApigeeV1CreditDeveloperBalanceRequest", @@ -14546,7 +15236,8 @@ "REJECTED", "CLOSED", "FROZEN", - "NEEDS_ATTENTION" + "NEEDS_ATTENTION", + "ACCEPTED_LIMITED_CAPACITY" ], "enumDescriptions": [ "The connection state has not been set.", @@ -14556,7 +15247,8 @@ "The connection has been rejected by the PSC producer.", "The connection has been closed by the PSC producer and will not serve traffic going forward.", "The connection has been frozen by the PSC producer and will not serve traffic.", - "The connection has been accepted by the PSC producer, but it is not ready to serve the traffic due to producer side issues." + "The connection has been accepted by the PSC producer, but it is not ready to serve the traffic due to producer side issues.", + "The connection has been accepted by the PSC producer, but it will only serve capacity limited traffic. The producer needs to take further actions to increase capacity for this connection." ], "readOnly": true, "type": "string" @@ -15058,6 +15750,12 @@ }, "type": "object" }, + "GoogleCloudApigeeV1ExpireAppGroupSubscriptionRequest": { + "description": "Request for ExpireAppGroupSubscription.", + "id": "GoogleCloudApigeeV1ExpireAppGroupSubscriptionRequest", + "properties": {}, + "type": "object" + }, "GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest": { "description": "Request for ExpireDeveloperSubscription.", "id": "GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest", @@ -15837,6 +16535,24 @@ }, "type": "object" }, + "GoogleCloudApigeeV1ListApimServiceExtensionsResponse": { + "description": "Response for list service extensions.", + "id": "GoogleCloudApigeeV1ListApimServiceExtensionsResponse", + "properties": { + "apimServiceExtensions": { + "description": "service extension in a given organization.", + "items": { + "$ref": "GoogleCloudApigeeV1ApimServiceExtension" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Page token that you can include in an `ListApimServiceExtensions` request to retrieve the next page. If omitted, no subsequent pages exist.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1ListAppGroupAppsResponse": { "description": "Response for ListAppGroupApps", "id": "GoogleCloudApigeeV1ListAppGroupAppsResponse", @@ -15855,6 +16571,24 @@ }, "type": "object" }, + "GoogleCloudApigeeV1ListAppGroupSubscriptionsResponse": { + "description": "Response for ListAppGroupSubscriptions.", + "id": "GoogleCloudApigeeV1ListAppGroupSubscriptionsResponse", + "properties": { + "appGroupSubscriptions": { + "description": "The list of subscriptions for an AppGroup.", + "items": { + "$ref": "GoogleCloudApigeeV1AppGroupSubscription" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Value that can be sent as `pageToken` to retrieve the next page of content. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1ListAppGroupsResponse": { "description": "ListAppGroupsResponse contains the 0 or more AppGroups, along with the optional page token and the total count of apps.", "id": "GoogleCloudApigeeV1ListAppGroupsResponse", diff --git a/discovery/authorizedbuyersmarketplace-v1alpha.json b/discovery/authorizedbuyersmarketplace-v1alpha.json index 121663de035..4eb8abb3b13 100644 --- a/discovery/authorizedbuyersmarketplace-v1alpha.json +++ b/discovery/authorizedbuyersmarketplace-v1alpha.json @@ -1576,9 +1576,237 @@ } } } + }, + "curators": { + "resources": { + "curatedPackages": { + "methods": { + "activate": { + "description": "Activates an existing curated package.", + "flatPath": "v1alpha/curators/{curatorsId}/curatedPackages/{curatedPackagesId}:activate", + "httpMethod": "POST", + "id": "authorizedbuyersmarketplace.curators.curatedPackages.activate", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the curated package to activate. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`", + "location": "path", + "pattern": "^curators/[^/]+/curatedPackages/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:activate", + "request": { + "$ref": "ActivateCuratedPackageRequest" + }, + "response": { + "$ref": "CuratedPackage" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "create": { + "description": "Creates a new curated package.", + "flatPath": "v1alpha/curators/{curatorsId}/curatedPackages", + "httpMethod": "POST", + "id": "authorizedbuyersmarketplace.curators.curatedPackages.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent curator account where this curated package will be created. Format: `curators/{accountId}`", + "location": "path", + "pattern": "^curators/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/curatedPackages", + "request": { + "$ref": "CuratedPackage" + }, + "response": { + "$ref": "CuratedPackage" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "deactivate": { + "description": "Deactivates an existing curated package.", + "flatPath": "v1alpha/curators/{curatorsId}/curatedPackages/{curatedPackagesId}:deactivate", + "httpMethod": "POST", + "id": "authorizedbuyersmarketplace.curators.curatedPackages.deactivate", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the curated package to deactivate. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`", + "location": "path", + "pattern": "^curators/[^/]+/curatedPackages/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:deactivate", + "request": { + "$ref": "DeactivateCuratedPackageRequest" + }, + "response": { + "$ref": "CuratedPackage" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "get": { + "description": "Gets a curated package given its resource name.", + "flatPath": "v1alpha/curators/{curatorsId}/curatedPackages/{curatedPackagesId}", + "httpMethod": "GET", + "id": "authorizedbuyersmarketplace.curators.curatedPackages.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the curated package to retrieve. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`", + "location": "path", + "pattern": "^curators/[^/]+/curatedPackages/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "CuratedPackage" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "list": { + "description": "Lists curated packages owned by the specified curator.", + "flatPath": "v1alpha/curators/{curatorsId}/curatedPackages", + "httpMethod": "GET", + "id": "authorizedbuyersmarketplace.curators.curatedPackages.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Supported columns for filtering are: * displayName * createTime * updateTime * state * feeCpm.currencyCode * feeCpm.units * feeCpm.nanos * floorPriceCpm.currencyCode * floorPriceCpm.units * floorPriceCpm.nanos", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. The server may return fewer results than requested. Max allowed page size is 500. If unspecified, the server will default to 500.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListCuratedPackages` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent curator account which owns this collection of curated packages. Format: `curators/{accountId}`", + "location": "path", + "pattern": "^curators/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/curatedPackages", + "response": { + "$ref": "ListCuratedPackagesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "patch": { + "description": "Updates an existing curated package.", + "flatPath": "v1alpha/curators/{curatorsId}/curatedPackages/{curatedPackagesId}", + "httpMethod": "PATCH", + "id": "authorizedbuyersmarketplace.curators.curatedPackages.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`", + "location": "path", + "pattern": "^curators/[^/]+/curatedPackages/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path \"*\" can be used to indicate full replacement (the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "CuratedPackage" + }, + "response": { + "$ref": "CuratedPackage" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + } + } + } + } + }, + "mediaPlanners": { + "methods": { + "list": { + "description": "Lists all media planner accounts that the caller has access to. For curators, this will return all media planners that have accepted curator terms. For other accounts, attempting to list media planners will return an error.", + "flatPath": "v1alpha/mediaPlanners", + "httpMethod": "GET", + "id": "authorizedbuyersmarketplace.mediaPlanners.list", + "parameterOrder": [], + "parameters": { + "filter": { + "description": "Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Supported columns for filtering are: * `name` * `displayName` * `ancestorNames`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of media planners to return. If unspecified, at most 100 media planners will be returned. The maximum value is 500; values above 500 will be coerced to 500.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. This value is received from a previous `ListMediaPlanners` call in ListMediaPlannersResponse.nextPageToken.", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/mediaPlanners", + "response": { + "$ref": "ListMediaPlannersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + } + } } }, - "revision": "20251119", + "revision": "20251211", "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/", "schemas": { "AcceptProposalRequest": { @@ -1593,6 +1821,20 @@ }, "type": "object" }, + "AccessControlSettings": { + "description": "Settings for controlling access to a curated package.", + "id": "AccessControlSettings", + "properties": { + "allowlistedMediaPlanners": { + "description": "Required. Immutable. The list of media planners that are explicitly granted access to the curated package. Eligible media planners can be found in the mediaPlanners.list method. Only a single media planner may be allowlisted at this time. Format: `mediaPlanners/{mediaPlannerAccountId}`", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ActivateClientRequest": { "description": "Request message for activating a client.", "id": "ActivateClientRequest", @@ -1605,6 +1847,12 @@ "properties": {}, "type": "object" }, + "ActivateCuratedPackageRequest": { + "description": "Request message for ActivateCuratedPackage.", + "id": "ActivateCuratedPackageRequest", + "properties": {}, + "type": "object" + }, "ActivateDataSegmentRequest": { "description": "Request message for activating a data segment", "id": "ActivateDataSegmentRequest", @@ -2001,6 +2249,68 @@ }, "type": "object" }, + "CuratedPackage": { + "description": "Represents a curated package of inventory created and managed by a Curator.", + "id": "CuratedPackage", + "properties": { + "accessSettings": { + "$ref": "AccessControlSettings", + "description": "Required. Settings for controlling access to the curated package. Access to this curated package is limited to the allowlisted media planners and the creator. Buyers and bidders can not be allowlisted for or have direct access to this resource." + }, + "createTime": { + "description": "Output only. The timestamp when the curated package was created. Can be used to filter the response of the curatedPackages.list method.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. A description of the curated package, provided by the curator.", + "type": "string" + }, + "displayName": { + "description": "Required. The display name assigned to the curated package by the curator. Can be used to filter the response of the curatedPackages.list method.", + "type": "string" + }, + "feeCpm": { + "$ref": "Money", + "description": "Optional. The CPM fee charged by the curator to buyers using this curated package. Can be used to filter the response of the curatedPackages.list method." + }, + "floorPriceCpm": { + "$ref": "Money", + "description": "Optional. The minimum CPM a buyer has to bid to participate in auctions for inventory in this curated package. Can be used to filter the response of the curatedPackages.list method." + }, + "name": { + "description": "Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`", + "type": "string" + }, + "state": { + "description": "Output only. The state of the curated package. Can be used to filter the response of the curatedPackages.list method.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "INACTIVE" + ], + "enumDescriptions": [ + "Default value.", + "The curated package is active.", + "The curated package is inactive." + ], + "readOnly": true, + "type": "string" + }, + "targeting": { + "$ref": "PackageTargeting", + "description": "Optional. Targeting criteria for the curated package." + }, + "updateTime": { + "description": "Output only. The timestamp when the curated package was last updated. Can be used to filter the response of the curatedPackages.list method.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "DataSegment": { "description": "Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms.", "id": "DataSegment", @@ -2122,6 +2432,12 @@ "properties": {}, "type": "object" }, + "DeactivateCuratedPackageRequest": { + "description": "Request message for DeactivateCuratedPackage.", + "id": "DeactivateCuratedPackageRequest", + "properties": {}, + "type": "object" + }, "DeactivateDataSegmentRequest": { "description": "Request message for deactivating a data segment", "id": "DeactivateDataSegmentRequest", @@ -2610,6 +2926,24 @@ }, "type": "object" }, + "ListCuratedPackagesResponse": { + "description": "Response message for ListCuratedPackages.", + "id": "ListCuratedPackagesResponse", + "properties": { + "curatedPackages": { + "description": "The list of curated packages.", + "items": { + "$ref": "CuratedPackage" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the ListCuratedPackagesRequest.pageToken field in the subsequent call to `ListCuratedPackages` method to retrieve the next page of results. If empty, then there are no more results.", + "type": "string" + } + }, + "type": "object" + }, "ListDataSegmentsResponse": { "description": "Response message for listing data segments.", "id": "ListDataSegmentsResponse", @@ -2664,6 +2998,24 @@ }, "type": "object" }, + "ListMediaPlannersResponse": { + "description": "A response containing media planner account information.", + "id": "ListMediaPlannersResponse", + "properties": { + "mediaPlanners": { + "description": "List of media planners.", + "items": { + "$ref": "MediaPlanner" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token which can be passed to a subsequent call to the `ListMediaPlanners` method to retrieve the next page of results in ListMediaPlannersRequest.pageToken.", + "type": "string" + } + }, + "type": "object" + }, "ListProposalsResponse": { "description": "Response message for listing proposals.", "id": "ListProposalsResponse", @@ -2768,6 +3120,23 @@ "description": "Output only. Account ID of the media planner.", "readOnly": true, "type": "string" + }, + "ancestorNames": { + "description": "Output only. The ancestor names of the media planner. Format: `mediaPlanners/{mediaPlannerAccountId}` Can be used to filter the response of the mediaPlanners.list method.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "displayName": { + "description": "Output only. The display name of the media planner. Can be used to filter the response of the mediaPlanners.list method.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The unique resource name of the media planner. Format: `mediaPlanners/{mediaPlannerAccountId}` Can be used to filter the response of the mediaPlanners.list method.", + "type": "string" } }, "type": "object" @@ -2851,6 +3220,373 @@ }, "type": "object" }, + "PackagePlacementTargeting": { + "description": "Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed.", + "id": "PackagePlacementTargeting", + "properties": { + "includedMobileAppCategoryTargeting": { + "description": "Optional. The list of targeted mobile app categories.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "mobileAppTargeting": { + "$ref": "StringTargetingDimension", + "description": "Optional. The list of targeted or excluded mobile application IDs that publishers own. Currently, only Android and Apple apps are supported. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded." + }, + "uriTargeting": { + "$ref": "StringTargetingDimension", + "description": "Optional. The list of targeted or excluded URLs. The domains should have the http/https stripped (for example, google.com), and can contain a max of 5 paths per url." + } + }, + "type": "object" + }, + "PackagePublisherProvidedSignalsTargeting": { + "description": "Represents targeting about publisher provided signals. Different publisher provided signals types will be logically OR'ed.", + "id": "PackagePublisherProvidedSignalsTargeting", + "properties": { + "audienceTargeting": { + "$ref": "TaxonomyTargeting", + "description": "Optional. The list of targeted or excluded audience IDs. Based off of IAB Audience Taxonomy version 1.1 (https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Audience%20Taxonomies/Audience%20Taxonomy%201.1.tsv)" + }, + "contentTargeting": { + "$ref": "TaxonomyTargeting", + "description": "Optional. The list of targeted or excluded content IDs. Based off of IAB Content Taxonomy version 2.2 (https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Content%20Taxonomies/Content%20Taxonomy%202.2.tsv)" + }, + "videoAndAudioSignalsTargeting": { + "$ref": "StringTargetingDimension", + "description": "Optional. The list of targeted and excluded video and audio signals IDs. These are additional signals supported by publisher provided signals." + } + }, + "type": "object" + }, + "PackageTargeting": { + "description": "Targeting criteria for curated and auction packages.", + "id": "PackageTargeting", + "properties": { + "geoTargeting": { + "$ref": "CriteriaTargeting", + "description": "Optional. The geo criteria IDs to be included or excluded as defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv. If unset, inventory will be targeted regardless of geo." + }, + "includedAcceleratedMobilePageType": { + "description": "Optional. The targeted accelerated mobile page type. If unset, inventory will be targeted regardless of AMP status.", + "enum": [ + "ACCELERATED_MOBILE_PAGE_TYPE_UNSPECIFIED", + "ACCELERATED_MOBILE_PAGE_TYPE_NON_AMP", + "ACCELERATED_MOBILE_PAGE_TYPE_AMP", + "ACCELERATED_MOBILE_PAGE_TYPE_AMP_STORY" + ], + "enumDescriptions": [ + "Default value. Should not be used in targeting specifications.", + "Targets inventory on standard web pages not using any AMP framework.", + "Targets inventory on pages built using the core AMP HTML framework.", + "Targets inventory on pages using the AMP Story (STAMP) format, which is optimized for visual storytelling (e.g., tappable full-screen experiences)." + ], + "type": "string" + }, + "includedAdSizes": { + "description": "Optional. The list of ad sizes to target. If unset, inventory will be targeted regardless of ad size. Curated packages supports `PIXEL` and `INTERSTITIAL` ad sizes.", + "items": { + "$ref": "AdSize" + }, + "type": "array" + }, + "includedAuthorizedSellerStatuses": { + "description": "Optional. The included list of targeted authorized seller statuses. If empty, inventory will be targeted regardless of seller status.", + "items": { + "enum": [ + "AUTHORIZED_SELLER_STATUS_UNSPECIFIED", + "AUTHORIZED_SELLER_STATUS_DIRECT", + "AUTHORIZED_SELLER_STATUS_RESELLER" + ], + "enumDescriptions": [ + "Default value. Should not be used in targeting specifications.", + "Targets inventory where the seller is declared as 'DIRECT'. This indicates the publisher (content owner) directly controls the seller account and has a direct business contract with the advertising system for this account.", + "Targets inventory where the seller is declared as 'RESELLER'. This indicates the publisher has authorized another entity to operate the listed seller account and resell their ad space." + ], + "type": "string" + }, + "type": "array" + }, + "includedCreativeFormat": { + "description": "Optional. The creative format to target. If unset, all creative markup types are targeted.", + "enum": [ + "CREATIVE_FORMAT_UNSPECIFIED", + "CREATIVE_FORMAT_DISPLAY", + "CREATIVE_FORMAT_VIDEO", + "CREATIVE_FORMAT_AUDIO" + ], + "enumDescriptions": [ + "Default value. Should not be used in targeting specifications.", + "Targets ad slots intended for HTML display creatives.", + "Targets ad slots intended for video creatives.", + "Targets ad slots intended for audio creatives." + ], + "type": "string" + }, + "includedDataSegments": { + "description": "Optional. The active data segments to be targeted. If unset, inventory will be targeted regardless of data segments. Format: `curators/{account_id}/dataSegments/{data_segment_id}`", + "items": { + "type": "string" + }, + "type": "array" + }, + "includedDeviceTypes": { + "description": "Optional. The list of included device types to target. If empty, all device types are targeted.", + "items": { + "enum": [ + "DEVICE_TYPE_UNSPECIFIED", + "DEVICE_TYPE_PERSONAL_COMPUTER", + "DEVICE_TYPE_CONNECTED_TV", + "DEVICE_TYPE_PHONE", + "DEVICE_TYPE_TABLET" + ], + "enumDescriptions": [ + "Default value. Should not be used in targeting specifications.", + "Targets desktop or laptop computers.", + "Targets connected TVs: devices that stream TV content, including smart TVs, gaming consoles, and streaming boxes/sticks.", + "Targets high-end mobile devices.", + "Targets tablet devices." + ], + "type": "string" + }, + "type": "array" + }, + "includedEnvironment": { + "description": "Optional. The environment to target. If unspecified, all environments are targeted.", + "enum": [ + "ENVIRONMENT_UNSPECIFIED", + "ENVIRONMENT_SITE", + "ENVIRONMENT_APP" + ], + "enumDescriptions": [ + "Default value. Should not be used in targeting specifications.", + "Targets inventory rendered within an ad-supported website.", + "Targets inventory within a mobile application." + ], + "type": "string" + }, + "includedNativeInventoryTypes": { + "description": "Optional. The targeted native inventory types. If empty, inventory will be targeted regardless of native inventory type.", + "items": { + "enum": [ + "NATIVE_INVENTORY_TYPE_UNSPECIFIED", + "NATIVE_INVENTORY_TYPE_NATIVE_ONLY", + "NATIVE_INVENTORY_TYPE_NATIVE_OR_BANNER" + ], + "enumDescriptions": [ + "Default value. Should not be used in targeting specifications.", + "Targets ad slots that *only* accept and render native ads.", + "Targets ad slots that accept and render either native or banner ads." + ], + "type": "string" + }, + "type": "array" + }, + "includedOpenMeasurementTypes": { + "description": "Optional. The list of targeted open measurement types. If empty, inventory will be targeted regardless of Open Measurement support.", + "items": { + "enum": [ + "OPEN_MEASUREMENT_TYPE_UNSPECIFIED", + "OPEN_MEASUREMENT_TYPE_OMID_V1" + ], + "enumDescriptions": [ + "Default value. Should not be used in targeting specifications.", + "Targets inventory that supports the v1 Open Measurement Interface Definition (OMID)." + ], + "type": "string" + }, + "type": "array" + }, + "includedRestrictedCategories": { + "description": "Optional. The list of targeted restricted categories. If empty, inventory will be targeted regardless of restricted categories.", + "items": { + "enum": [ + "RESTRICTED_CATEGORY_UNSPECIFIED", + "RESTRICTED_CATEGORY_ALCOHOL", + "RESTRICTED_CATEGORY_GAMBLING" + ], + "enumDescriptions": [ + "Default value. Should not be used in targeting specifications.", + "Targets inventory where alcohol ads are allowed by the publisher.", + "Targets inventory where gambling ads are allowed by the publisher." + ], + "type": "string" + }, + "type": "array" + }, + "includedRewardedType": { + "description": "Optional. The targeted rewarded type. If unset, inventory will be targeted regardless of rewarded type.", + "enum": [ + "REWARDED_TYPE_UNSPECIFIED", + "REWARDED_TYPE_NON_REWARDED", + "REWARDED_TYPE_REWARDED" + ], + "enumDescriptions": [ + "Default value. Should not be used in targeting specifications.", + "Targets inventory that does NOT offer an explicit reward to the user for watching or interacting with the ad.", + "Targets inventory that offers a reward to the user in exchange for watching or engaging with the ad." + ], + "type": "string" + }, + "languageTargeting": { + "$ref": "StringTargetingDimension", + "description": "Optional. The languages to target. If unset, inventory will be targeted regardless of language. See https://developers.google.com/google-ads/api/data/codes-formats#languages for the list of supported language codes." + }, + "minimumPredictedClickThroughRatePercentageMillis": { + "description": "Optional. The targeted minimum predicted click through rate, ranging in values [10, 10000] (0.01% - 10%). A value of 50 means that the configuration will only match adslots for which we predict at least 0.05% click through rate. An unset value indicates inventory will be targeted regardless of predicted click through rate.", + "format": "int64", + "type": "string" + }, + "minimumPredictedViewabilityPercentage": { + "description": "Optional. The targeted minimum predicted viewability percentage. This value must be a multiple of 10 between 10 and 90 (inclusive). For example, 10 is valid, but 0, 15, and 100 are not. A value of 10 means that the configuration will only match adslots for which we predict at least 10% viewability. An unset value indicates inventory will be targeted regardless of predicted viewability.", + "format": "int64", + "type": "string" + }, + "placementTargeting": { + "$ref": "PackagePlacementTargeting", + "description": "Optional. Placement targeting information, for example, URL, mobile applications." + }, + "publisherProvidedSignalsTargeting": { + "$ref": "PackagePublisherProvidedSignalsTargeting", + "description": "Optional. The publisher provided signals to target. If unset, inventory will be targeted regardless of publisher provided signals." + }, + "publisherTargeting": { + "$ref": "StringTargetingDimension", + "description": "Optional. The targeted publishers. If unset, inventory will be targeted regardless of publisher. Publishers are identified by their publisher ID from ads.txt / app-ads.txt. See https://iabtechlab.com/ads-txt/ and https://iabtechlab.com/app-ads-txt/ for more details." + }, + "verticalTargeting": { + "$ref": "CriteriaTargeting", + "description": "Optional. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals. If unset, inventory will be targeted regardless of vertical." + }, + "videoTargeting": { + "$ref": "PackageVideoTargeting", + "description": "Optional. Video specific targeting criteria." + } + }, + "type": "object" + }, + "PackageVideoTargeting": { + "description": "Video specific targeting criteria.", + "id": "PackageVideoTargeting", + "properties": { + "includedContentDeliveryMethod": { + "description": "Optional. The targeted video delivery method. If unset, inventory will be targeted regardless of video delivery method.", + "enum": [ + "CONTENT_DELIVERY_METHOD_UNSPECIFIED", + "CONTENT_DELIVERY_METHOD_STREAMING", + "CONTENT_DELIVERY_METHOD_PROGRESSIVE" + ], + "enumDescriptions": [ + "Default value. Should not be used in targeting specifications.", + "Targets video content that is being broadcast live.", + "Targets video content that is transferred incrementally as client's playback requires." + ], + "type": "string" + }, + "includedMaximumAdDurationTargeting": { + "description": "Optional. The targeted maximum video ad duration. If unset, inventory will be targeted regardless of maximum video ad duration.", + "enum": [ + "MAXIMUM_VIDEO_AD_DURATION_UNSPECIFIED", + "MAXIMUM_VIDEO_AD_DURATION_FIFTEEN_SECONDS", + "MAXIMUM_VIDEO_AD_DURATION_TWENTY_SECONDS", + "MAXIMUM_VIDEO_AD_DURATION_THIRTY_SECONDS", + "MAXIMUM_VIDEO_AD_DURATION_SIXTY_SECONDS", + "MAXIMUM_VIDEO_AD_DURATION_NINETY_SECONDS", + "MAXIMUM_VIDEO_AD_DURATION_ONE_HUNDRED_TWENTY_SECONDS" + ], + "enumDescriptions": [ + "Default value. Should not be used in targeting specifications.", + "Applies to video ads with a duration up to 15 seconds (0 < duration <= 15s).", + "Applies to video ads with a duration up to 20 seconds (0 < duration <= 20s).", + "Applies to video ads with a duration up to 30 seconds (0 < duration <= 30s).", + "Applies to video ads with a duration up to 60 seconds (0 < duration <= 60s).", + "Applies to video ads with a duration up to 90 seconds (0 < duration <= 90s).", + "Applies to video ads with a duration up to 120 seconds (0 < duration <= 120s)." + ], + "type": "string" + }, + "includedMimeTypes": { + "description": "Optional. The list of targeted video mime types using the IANA published MIME type strings (https://www.iana.org/assignments/media-types/media-types.xhtml). If empty, inventory will be targeted regardless of video mime type.", + "items": { + "enum": [ + "VIDEO_MIME_TYPE_UNSPECIFIED", + "VIDEO_MIME_TYPE_THREEGPP", + "VIDEO_MIME_TYPE_APPLICATION_MPEGURL", + "VIDEO_MIME_TYPE_MP4", + "VIDEO_MIME_TYPE_APPLICATION_MPEGDASH", + "VIDEO_MIME_TYPE_APPLICATION_JAVASCRIPT", + "VIDEO_MIME_TYPE_WEBM" + ], + "enumDescriptions": [ + "Default value. Should not be used in targeting specifications.", + "3GPP container format used on 3G phones.", + "HLS/M3U8", + "MPEG-4 container typically with H.264 codec.", + "DASH.", + "JavaScript (used for VPAID ads).", + "WebM container assuming VP9 codec." + ], + "type": "string" + }, + "type": "array" + }, + "includedPlaybackMethods": { + "description": "Optional. The list of targeted video playback methods. If empty, inventory will be targeted regardless of video playback method.", + "items": { + "enum": [ + "PLAYBACK_METHOD_UNSPECIFIED", + "PLAYBACK_METHOD_AUTO_PLAY_SOUND_ON", + "PLAYBACK_METHOD_AUTO_PLAY_SOUND_OFF", + "PLAYBACK_METHOD_CLICK_TO_PLAY" + ], + "enumDescriptions": [ + "Unspecified video playback method. Should not be used.", + "Playback starts automatically when the page/content loads.", + "Playback starts automatically when the page/content loads, but with sound off.", + "Playback is initiated by a user action (e.g., clicking a play button)." + ], + "type": "string" + }, + "type": "array" + }, + "includedPlayerSizeTargeting": { + "$ref": "VideoPlayerSizeTargeting", + "description": "Optional. The targeted video player size. If unset, inventory will be targeted regardless of video player size." + }, + "includedPositionTypes": { + "description": "Optional. The targeted video ad position types. If empty, inventory will be targeted regardless of video ad position type.", + "items": { + "enum": [ + "POSITION_TYPE_UNSPECIFIED", + "POSITION_TYPE_MIDROLL", + "POSITION_TYPE_POSTROLL", + "POSITION_TYPE_PREROLL" + ], + "enumDescriptions": [ + "Default value. Should not be used in targeting specifications.", + "The ad is played in the middle of the video content.", + "The ad is played after the video content.", + "The ad is played before the video content." + ], + "type": "string" + }, + "type": "array" + }, + "minimumPredictedCompletionRatePercentage": { + "description": "Optional. The targeted minimum predicted completion rate percentage. This value must be a multiple of 10 between 10 and 90 (inclusive). For example, 10 is valid, but 0, 15, and 100 are not. A value of 10 means that the configuration will only match adslots for which we predict at least 10% completion rate. An unset value indicates inventory will be targeted regardless of predicted completion rate.", + "format": "int64", + "type": "string" + }, + "plcmtTargeting": { + "$ref": "VideoPlcmtTargeting", + "description": "Optional. The targeted video plcmt types. If unset, inventory will be targeted regardless of video plcmt type." + } + }, + "type": "object" + }, "PauseFinalizedDealRequest": { "description": "Request message for pausing a finalized deal.", "id": "PauseFinalizedDealRequest", @@ -3376,6 +4112,34 @@ "properties": {}, "type": "object" }, + "StringTargetingDimension": { + "description": "Generic targeting with string values.", + "id": "StringTargetingDimension", + "properties": { + "selectionType": { + "description": "Required. How the items in this list should be targeted.", + "enum": [ + "SELECTION_TYPE_UNSPECIFIED", + "SELECTION_TYPE_INCLUDE", + "SELECTION_TYPE_EXCLUDE" + ], + "enumDescriptions": [ + "Unspecified selection type. Should not be used.", + "The values in the targeting dimension are included.", + "The values in the targeting dimension are excluded." + ], + "type": "string" + }, + "values": { + "description": "Required. The values specified.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "SubscribeAuctionPackageRequest": { "description": "Request message for SubscribeAuctionPackage.", "id": "SubscribeAuctionPackageRequest", @@ -3396,6 +4160,27 @@ }, "type": "object" }, + "TaxonomyTargeting": { + "description": "Defines targeting criteria for handling the IAB audience and content Taxonomy ID space.", + "id": "TaxonomyTargeting", + "properties": { + "excludedTaxonomyIds": { + "description": "Optional. The list of excluded content taxonomy IDs.", + "items": { + "type": "string" + }, + "type": "array" + }, + "targetedTaxonomyIds": { + "description": "Optional. The list of targeted content taxonomy IDs.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "TechnologyTargeting": { "description": "Represents targeting about various types of technology.", "id": "TechnologyTargeting", @@ -3514,6 +4299,65 @@ }, "type": "object" }, + "VideoPlayerSizeTargeting": { + "description": "Represents the size of the video player that can be targeted. Both width and height are required to be set to non-zero values.", + "id": "VideoPlayerSizeTargeting", + "properties": { + "minimumHeight": { + "description": "Required. The minimum height of the video player in pixels.", + "format": "int64", + "type": "string" + }, + "minimumWidth": { + "description": "Required. The minimum width of the video player in pixels.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "VideoPlcmtTargeting": { + "description": "Defines targeting criteria based on the video placement type, often corresponding to the IAB OpenRTB 'plcmt' field.", + "id": "VideoPlcmtTargeting", + "properties": { + "selectionType": { + "description": "Required. The selection type for the list of video plcmts.", + "enum": [ + "SELECTION_TYPE_UNSPECIFIED", + "SELECTION_TYPE_INCLUDE", + "SELECTION_TYPE_EXCLUDE" + ], + "enumDescriptions": [ + "Unspecified selection type. Should not be used.", + "The values in the targeting dimension are included.", + "The values in the targeting dimension are excluded." + ], + "type": "string" + }, + "videoPlcmtTypes": { + "description": "Required. The list of targeted video plcmts types. If empty, inventory will be targeted regardless of video plcmt type.", + "items": { + "enum": [ + "VIDEO_PLCMT_TYPE_UNSPECIFIED", + "INSTREAM", + "ACCOMPANYING_CONTENT", + "INTERSTITIAL", + "NO_CONTENT" + ], + "enumDescriptions": [ + "Default value. Should not be used in targeting specifications.", + "Pre-roll, mid-roll, and post-roll ads that are played before, during or after the streaming video content that the consumer has requested. Instream video must be set to “sound on” by default at player start, or have explicitly clear user intent to watch the video content. While there may be other content surrounding the player, the video content must be the focus of the user’s visit. It should remain the primary content on the page and the only video player in-view capable of audio when playing. If the player converts to floating/sticky, subsequent ad calls should accurately convey the updated player size.", + "Pre-roll, mid-roll, and post-roll ads that are played before, during, or after streaming video content. The video player loads and plays before, between, or after paragraphs of text or graphical content, and starts playing only when it enters the viewport. Accompanying content should only start playback upon entering the viewport. It may convert to a floating/sticky player as it scrolls off the page.", + "Video ads that are played without video content. During playback, it must be the primary focus of the page and take up the majority of the viewport and cannot be scrolled out of view. This can be in placements like in-app video or slideshows.", + "Video ads that are played without streaming video content. This can be in placements like slideshows, native feeds, in-content or sticky/floating." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "VideoTargeting": { "description": "Represents targeting information about video.", "id": "VideoTargeting", diff --git a/discovery/authorizedbuyersmarketplace-v1beta.json b/discovery/authorizedbuyersmarketplace-v1beta.json index b728277b9c2..f7b05479909 100644 --- a/discovery/authorizedbuyersmarketplace-v1beta.json +++ b/discovery/authorizedbuyersmarketplace-v1beta.json @@ -107,6 +107,194 @@ "resources": { "curators": { "resources": { + "curatedPackages": { + "methods": { + "activate": { + "description": "Activates an existing curated package.", + "flatPath": "v1beta/curators/{curatorsId}/curatedPackages/{curatedPackagesId}:activate", + "httpMethod": "POST", + "id": "authorizedbuyersmarketplace.curators.curatedPackages.activate", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the curated package to activate. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`", + "location": "path", + "pattern": "^curators/[^/]+/curatedPackages/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}:activate", + "request": { + "$ref": "ActivateCuratedPackageRequest" + }, + "response": { + "$ref": "CuratedPackage" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "create": { + "description": "Creates a new curated package.", + "flatPath": "v1beta/curators/{curatorsId}/curatedPackages", + "httpMethod": "POST", + "id": "authorizedbuyersmarketplace.curators.curatedPackages.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent curator account where this curated package will be created. Format: `curators/{accountId}`", + "location": "path", + "pattern": "^curators/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/curatedPackages", + "request": { + "$ref": "CuratedPackage" + }, + "response": { + "$ref": "CuratedPackage" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "deactivate": { + "description": "Deactivates an existing curated package.", + "flatPath": "v1beta/curators/{curatorsId}/curatedPackages/{curatedPackagesId}:deactivate", + "httpMethod": "POST", + "id": "authorizedbuyersmarketplace.curators.curatedPackages.deactivate", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the curated package to deactivate. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`", + "location": "path", + "pattern": "^curators/[^/]+/curatedPackages/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}:deactivate", + "request": { + "$ref": "DeactivateCuratedPackageRequest" + }, + "response": { + "$ref": "CuratedPackage" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "get": { + "description": "Gets a curated package given its resource name.", + "flatPath": "v1beta/curators/{curatorsId}/curatedPackages/{curatedPackagesId}", + "httpMethod": "GET", + "id": "authorizedbuyersmarketplace.curators.curatedPackages.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the curated package to retrieve. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`", + "location": "path", + "pattern": "^curators/[^/]+/curatedPackages/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "CuratedPackage" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "list": { + "description": "Lists curated packages owned by the specified curator.", + "flatPath": "v1beta/curators/{curatorsId}/curatedPackages", + "httpMethod": "GET", + "id": "authorizedbuyersmarketplace.curators.curatedPackages.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Supported columns for filtering are: * displayName * createTime * updateTime * state * feeCpm.currencyCode * feeCpm.units * feeCpm.nanos * floorPriceCpm.currencyCode * floorPriceCpm.units * floorPriceCpm.nanos", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. The server may return fewer results than requested. Max allowed page size is 500. If unspecified, the server will default to 500.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListCuratedPackages` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent curator account which owns this collection of curated packages. Format: `curators/{accountId}`", + "location": "path", + "pattern": "^curators/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/curatedPackages", + "response": { + "$ref": "ListCuratedPackagesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "patch": { + "description": "Updates an existing curated package.", + "flatPath": "v1beta/curators/{curatorsId}/curatedPackages/{curatedPackagesId}", + "httpMethod": "PATCH", + "id": "authorizedbuyersmarketplace.curators.curatedPackages.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`", + "location": "path", + "pattern": "^curators/[^/]+/curatedPackages/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path \"*\" can be used to indicate full replacement (the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}", + "request": { + "$ref": "CuratedPackage" + }, + "response": { + "$ref": "CuratedPackage" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + } + } + }, "dataSegments": { "methods": { "activate": { @@ -291,17 +479,193 @@ } } } + }, + "mediaPlanners": { + "methods": { + "list": { + "description": "Lists all media planner accounts that the caller has access to. For curators, this will return all media planners that have accepted curator terms. For other accounts, attempting to list media planners will return an error.", + "flatPath": "v1beta/mediaPlanners", + "httpMethod": "GET", + "id": "authorizedbuyersmarketplace.mediaPlanners.list", + "parameterOrder": [], + "parameters": { + "filter": { + "description": "Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Supported columns for filtering are: * `name` * `displayName` * `ancestorNames`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of media planners to return. If unspecified, at most 100 media planners will be returned. The maximum value is 500; values above 500 will be coerced to 500.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. This value is received from a previous `ListMediaPlanners` call in ListMediaPlannersResponse.nextPageToken.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/mediaPlanners", + "response": { + "$ref": "ListMediaPlannersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + } + } } }, - "revision": "20250910", + "revision": "20251211", "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/", "schemas": { + "AccessControlSettings": { + "description": "Settings for controlling access to a curated package.", + "id": "AccessControlSettings", + "properties": { + "allowlistedMediaPlanners": { + "description": "Required. Immutable. The list of media planners that are explicitly granted access to the curated package. Eligible media planners can be found in the mediaPlanners.list method. Only a single media planner may be allowlisted at this time. Format: `mediaPlanners/{mediaPlannerAccountId}`", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ActivateCuratedPackageRequest": { + "description": "Request message for ActivateCuratedPackage.", + "id": "ActivateCuratedPackageRequest", + "properties": {}, + "type": "object" + }, "ActivateDataSegmentRequest": { "description": "Request message for activating a data segment", "id": "ActivateDataSegmentRequest", "properties": {}, "type": "object" }, + "AdSize": { + "description": "Represents size of a single ad slot, or a creative.", + "id": "AdSize", + "properties": { + "height": { + "description": "The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.", + "format": "int64", + "type": "string" + }, + "type": { + "description": "The type of the ad slot size.", + "enum": [ + "TYPE_UNSPECIFIED", + "PIXEL", + "INTERSTITIAL", + "NATIVE", + "FLUID" + ], + "enumDescriptions": [ + "A placeholder for an undefined size type.", + "Ad slot with size specified by height and width in pixels.", + "Special size to describe an interstitial ad slot.", + "Native (mobile) ads rendered by the publisher.", + "Fluid size (responsive size) can be resized automatically with the change of outside environment." + ], + "type": "string" + }, + "width": { + "description": "The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "CriteriaTargeting": { + "description": "Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax.", + "id": "CriteriaTargeting", + "properties": { + "excludedCriteriaIds": { + "description": "A list of numeric IDs to be excluded.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "targetedCriteriaIds": { + "description": "A list of numeric IDs to be included.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "CuratedPackage": { + "description": "Represents a curated package of inventory created and managed by a Curator.", + "id": "CuratedPackage", + "properties": { + "accessSettings": { + "$ref": "AccessControlSettings", + "description": "Required. Settings for controlling access to the curated package. Access to this curated package is limited to the allowlisted media planners and the creator. Buyers and bidders can not be allowlisted for or have direct access to this resource." + }, + "createTime": { + "description": "Output only. The timestamp when the curated package was created. Can be used to filter the response of the curatedPackages.list method.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. A description of the curated package, provided by the curator.", + "type": "string" + }, + "displayName": { + "description": "Required. The display name assigned to the curated package by the curator. Can be used to filter the response of the curatedPackages.list method.", + "type": "string" + }, + "feeCpm": { + "$ref": "Money", + "description": "Optional. The CPM fee charged by the curator to buyers using this curated package. Can be used to filter the response of the curatedPackages.list method." + }, + "floorPriceCpm": { + "$ref": "Money", + "description": "Optional. The minimum CPM a buyer has to bid to participate in auctions for inventory in this curated package. Can be used to filter the response of the curatedPackages.list method." + }, + "name": { + "description": "Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`", + "type": "string" + }, + "state": { + "description": "Output only. The state of the curated package. Can be used to filter the response of the curatedPackages.list method.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "INACTIVE" + ], + "enumDescriptions": [ + "Default value.", + "The curated package is active.", + "The curated package is inactive." + ], + "readOnly": true, + "type": "string" + }, + "targeting": { + "$ref": "PackageTargeting", + "description": "Optional. Targeting criteria for the curated package." + }, + "updateTime": { + "description": "Output only. The timestamp when the curated package was last updated. Can be used to filter the response of the curatedPackages.list method.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "DataSegment": { "description": "Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms.", "id": "DataSegment", @@ -344,12 +708,36 @@ }, "type": "object" }, + "DeactivateCuratedPackageRequest": { + "description": "Request message for DeactivateCuratedPackage.", + "id": "DeactivateCuratedPackageRequest", + "properties": {}, + "type": "object" + }, "DeactivateDataSegmentRequest": { "description": "Request message for deactivating a data segment", "id": "DeactivateDataSegmentRequest", "properties": {}, "type": "object" }, + "ListCuratedPackagesResponse": { + "description": "Response message for ListCuratedPackages.", + "id": "ListCuratedPackagesResponse", + "properties": { + "curatedPackages": { + "description": "The list of curated packages.", + "items": { + "$ref": "CuratedPackage" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the ListCuratedPackagesRequest.pageToken field in the subsequent call to `ListCuratedPackages` method to retrieve the next page of results. If empty, then there are no more results.", + "type": "string" + } + }, + "type": "object" + }, "ListDataSegmentsResponse": { "description": "Response message for listing data segments.", "id": "ListDataSegmentsResponse", @@ -368,6 +756,54 @@ }, "type": "object" }, + "ListMediaPlannersResponse": { + "description": "A response containing media planner account information.", + "id": "ListMediaPlannersResponse", + "properties": { + "mediaPlanners": { + "description": "List of media planners.", + "items": { + "$ref": "MediaPlanner" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token which can be passed to a subsequent call to the `ListMediaPlanners` method to retrieve the next page of results in ListMediaPlannersRequest.pageToken.", + "type": "string" + } + }, + "type": "object" + }, + "MediaPlanner": { + "description": "Represents a media planner account.", + "id": "MediaPlanner", + "properties": { + "accountId": { + "deprecated": true, + "description": "Output only. Account ID of the media planner.", + "readOnly": true, + "type": "string" + }, + "ancestorNames": { + "description": "Output only. The ancestor names of the media planner. Format: `mediaPlanners/{mediaPlannerAccountId}` Can be used to filter the response of the mediaPlanners.list method.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "displayName": { + "description": "Output only. The display name of the media planner. Can be used to filter the response of the mediaPlanners.list method.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The unique resource name of the media planner. Format: `mediaPlanners/{mediaPlannerAccountId}` Can be used to filter the response of the mediaPlanners.list method.", + "type": "string" + } + }, + "type": "object" + }, "Money": { "description": "Represents an amount of money with its currency type.", "id": "Money", @@ -388,6 +824,481 @@ } }, "type": "object" + }, + "PackagePlacementTargeting": { + "description": "Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed.", + "id": "PackagePlacementTargeting", + "properties": { + "includedMobileAppCategoryTargeting": { + "description": "Optional. The list of targeted mobile app categories.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "mobileAppTargeting": { + "$ref": "StringTargetingDimension", + "description": "Optional. The list of targeted or excluded mobile application IDs that publishers own. Currently, only Android and Apple apps are supported. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded." + }, + "uriTargeting": { + "$ref": "StringTargetingDimension", + "description": "Optional. The list of targeted or excluded URLs. The domains should have the http/https stripped (for example, google.com), and can contain a max of 5 paths per url." + } + }, + "type": "object" + }, + "PackagePublisherProvidedSignalsTargeting": { + "description": "Represents targeting about publisher provided signals. Different publisher provided signals types will be logically OR'ed.", + "id": "PackagePublisherProvidedSignalsTargeting", + "properties": { + "audienceTargeting": { + "$ref": "TaxonomyTargeting", + "description": "Optional. The list of targeted or excluded audience IDs. Based off of IAB Audience Taxonomy version 1.1 (https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Audience%20Taxonomies/Audience%20Taxonomy%201.1.tsv)" + }, + "contentTargeting": { + "$ref": "TaxonomyTargeting", + "description": "Optional. The list of targeted or excluded content IDs. Based off of IAB Content Taxonomy version 2.2 (https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Content%20Taxonomies/Content%20Taxonomy%202.2.tsv)" + }, + "videoAndAudioSignalsTargeting": { + "$ref": "StringTargetingDimension", + "description": "Optional. The list of targeted and excluded video and audio signals IDs. These are additional signals supported by publisher provided signals." + } + }, + "type": "object" + }, + "PackageTargeting": { + "description": "Targeting criteria for curated and auction packages.", + "id": "PackageTargeting", + "properties": { + "geoTargeting": { + "$ref": "CriteriaTargeting", + "description": "Optional. The geo criteria IDs to be included or excluded as defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv. If unset, inventory will be targeted regardless of geo." + }, + "includedAcceleratedMobilePageType": { + "description": "Optional. The targeted accelerated mobile page type. If unset, inventory will be targeted regardless of AMP status.", + "enum": [ + "ACCELERATED_MOBILE_PAGE_TYPE_UNSPECIFIED", + "ACCELERATED_MOBILE_PAGE_TYPE_NON_AMP", + "ACCELERATED_MOBILE_PAGE_TYPE_AMP", + "ACCELERATED_MOBILE_PAGE_TYPE_AMP_STORY" + ], + "enumDescriptions": [ + "Default value. Should not be used in targeting specifications.", + "Targets inventory on standard web pages not using any AMP framework.", + "Targets inventory on pages built using the core AMP HTML framework.", + "Targets inventory on pages using the AMP Story (STAMP) format, which is optimized for visual storytelling (e.g., tappable full-screen experiences)." + ], + "type": "string" + }, + "includedAdSizes": { + "description": "Optional. The list of ad sizes to target. If unset, inventory will be targeted regardless of ad size. Curated packages supports `PIXEL` and `INTERSTITIAL` ad sizes.", + "items": { + "$ref": "AdSize" + }, + "type": "array" + }, + "includedAuthorizedSellerStatuses": { + "description": "Optional. The included list of targeted authorized seller statuses. If empty, inventory will be targeted regardless of seller status.", + "items": { + "enum": [ + "AUTHORIZED_SELLER_STATUS_UNSPECIFIED", + "AUTHORIZED_SELLER_STATUS_DIRECT", + "AUTHORIZED_SELLER_STATUS_RESELLER" + ], + "enumDescriptions": [ + "Default value. Should not be used in targeting specifications.", + "Targets inventory where the seller is declared as 'DIRECT'. This indicates the publisher (content owner) directly controls the seller account and has a direct business contract with the advertising system for this account.", + "Targets inventory where the seller is declared as 'RESELLER'. This indicates the publisher has authorized another entity to operate the listed seller account and resell their ad space." + ], + "type": "string" + }, + "type": "array" + }, + "includedCreativeFormat": { + "description": "Optional. The creative format to target. If unset, all creative markup types are targeted.", + "enum": [ + "CREATIVE_FORMAT_UNSPECIFIED", + "CREATIVE_FORMAT_DISPLAY", + "CREATIVE_FORMAT_VIDEO", + "CREATIVE_FORMAT_AUDIO" + ], + "enumDescriptions": [ + "Default value. Should not be used in targeting specifications.", + "Targets ad slots intended for HTML display creatives.", + "Targets ad slots intended for video creatives.", + "Targets ad slots intended for audio creatives." + ], + "type": "string" + }, + "includedDataSegments": { + "description": "Optional. The active data segments to be targeted. If unset, inventory will be targeted regardless of data segments. Format: `curators/{account_id}/dataSegments/{data_segment_id}`", + "items": { + "type": "string" + }, + "type": "array" + }, + "includedDeviceTypes": { + "description": "Optional. The list of included device types to target. If empty, all device types are targeted.", + "items": { + "enum": [ + "DEVICE_TYPE_UNSPECIFIED", + "DEVICE_TYPE_PERSONAL_COMPUTER", + "DEVICE_TYPE_CONNECTED_TV", + "DEVICE_TYPE_PHONE", + "DEVICE_TYPE_TABLET" + ], + "enumDescriptions": [ + "Default value. Should not be used in targeting specifications.", + "Targets desktop or laptop computers.", + "Targets connected TVs: devices that stream TV content, including smart TVs, gaming consoles, and streaming boxes/sticks.", + "Targets high-end mobile devices.", + "Targets tablet devices." + ], + "type": "string" + }, + "type": "array" + }, + "includedEnvironment": { + "description": "Optional. The environment to target. If unspecified, all environments are targeted.", + "enum": [ + "ENVIRONMENT_UNSPECIFIED", + "ENVIRONMENT_SITE", + "ENVIRONMENT_APP" + ], + "enumDescriptions": [ + "Default value. Should not be used in targeting specifications.", + "Targets inventory rendered within an ad-supported website.", + "Targets inventory within a mobile application." + ], + "type": "string" + }, + "includedNativeInventoryTypes": { + "description": "Optional. The targeted native inventory types. If empty, inventory will be targeted regardless of native inventory type.", + "items": { + "enum": [ + "NATIVE_INVENTORY_TYPE_UNSPECIFIED", + "NATIVE_INVENTORY_TYPE_NATIVE_ONLY", + "NATIVE_INVENTORY_TYPE_NATIVE_OR_BANNER" + ], + "enumDescriptions": [ + "Default value. Should not be used in targeting specifications.", + "Targets ad slots that *only* accept and render native ads.", + "Targets ad slots that accept and render either native or banner ads." + ], + "type": "string" + }, + "type": "array" + }, + "includedOpenMeasurementTypes": { + "description": "Optional. The list of targeted open measurement types. If empty, inventory will be targeted regardless of Open Measurement support.", + "items": { + "enum": [ + "OPEN_MEASUREMENT_TYPE_UNSPECIFIED", + "OPEN_MEASUREMENT_TYPE_OMID_V1" + ], + "enumDescriptions": [ + "Default value. Should not be used in targeting specifications.", + "Targets inventory that supports the v1 Open Measurement Interface Definition (OMID)." + ], + "type": "string" + }, + "type": "array" + }, + "includedRestrictedCategories": { + "description": "Optional. The list of targeted restricted categories. If empty, inventory will be targeted regardless of restricted categories.", + "items": { + "enum": [ + "RESTRICTED_CATEGORY_UNSPECIFIED", + "RESTRICTED_CATEGORY_ALCOHOL", + "RESTRICTED_CATEGORY_GAMBLING" + ], + "enumDescriptions": [ + "Default value. Should not be used in targeting specifications.", + "Targets inventory where alcohol ads are allowed by the publisher.", + "Targets inventory where gambling ads are allowed by the publisher." + ], + "type": "string" + }, + "type": "array" + }, + "includedRewardedType": { + "description": "Optional. The targeted rewarded type. If unset, inventory will be targeted regardless of rewarded type.", + "enum": [ + "REWARDED_TYPE_UNSPECIFIED", + "REWARDED_TYPE_NON_REWARDED", + "REWARDED_TYPE_REWARDED" + ], + "enumDescriptions": [ + "Default value. Should not be used in targeting specifications.", + "Targets inventory that does NOT offer an explicit reward to the user for watching or interacting with the ad.", + "Targets inventory that offers a reward to the user in exchange for watching or engaging with the ad." + ], + "type": "string" + }, + "languageTargeting": { + "$ref": "StringTargetingDimension", + "description": "Optional. The languages to target. If unset, inventory will be targeted regardless of language. See https://developers.google.com/google-ads/api/data/codes-formats#languages for the list of supported language codes." + }, + "minimumPredictedClickThroughRatePercentageMillis": { + "description": "Optional. The targeted minimum predicted click through rate, ranging in values [10, 10000] (0.01% - 10%). A value of 50 means that the configuration will only match adslots for which we predict at least 0.05% click through rate. An unset value indicates inventory will be targeted regardless of predicted click through rate.", + "format": "int64", + "type": "string" + }, + "minimumPredictedViewabilityPercentage": { + "description": "Optional. The targeted minimum predicted viewability percentage. This value must be a multiple of 10 between 10 and 90 (inclusive). For example, 10 is valid, but 0, 15, and 100 are not. A value of 10 means that the configuration will only match adslots for which we predict at least 10% viewability. An unset value indicates inventory will be targeted regardless of predicted viewability.", + "format": "int64", + "type": "string" + }, + "placementTargeting": { + "$ref": "PackagePlacementTargeting", + "description": "Optional. Placement targeting information, for example, URL, mobile applications." + }, + "publisherProvidedSignalsTargeting": { + "$ref": "PackagePublisherProvidedSignalsTargeting", + "description": "Optional. The publisher provided signals to target. If unset, inventory will be targeted regardless of publisher provided signals." + }, + "publisherTargeting": { + "$ref": "StringTargetingDimension", + "description": "Optional. The targeted publishers. If unset, inventory will be targeted regardless of publisher. Publishers are identified by their publisher ID from ads.txt / app-ads.txt. See https://iabtechlab.com/ads-txt/ and https://iabtechlab.com/app-ads-txt/ for more details." + }, + "verticalTargeting": { + "$ref": "CriteriaTargeting", + "description": "Optional. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals. If unset, inventory will be targeted regardless of vertical." + }, + "videoTargeting": { + "$ref": "PackageVideoTargeting", + "description": "Optional. Video specific targeting criteria." + } + }, + "type": "object" + }, + "PackageVideoTargeting": { + "description": "Video specific targeting criteria.", + "id": "PackageVideoTargeting", + "properties": { + "includedContentDeliveryMethod": { + "description": "Optional. The targeted video delivery method. If unset, inventory will be targeted regardless of video delivery method.", + "enum": [ + "CONTENT_DELIVERY_METHOD_UNSPECIFIED", + "CONTENT_DELIVERY_METHOD_STREAMING", + "CONTENT_DELIVERY_METHOD_PROGRESSIVE" + ], + "enumDescriptions": [ + "Default value. Should not be used in targeting specifications.", + "Targets video content that is being broadcast live.", + "Targets video content that is transferred incrementally as client's playback requires." + ], + "type": "string" + }, + "includedMaximumAdDurationTargeting": { + "description": "Optional. The targeted maximum video ad duration. If unset, inventory will be targeted regardless of maximum video ad duration.", + "enum": [ + "MAXIMUM_VIDEO_AD_DURATION_UNSPECIFIED", + "MAXIMUM_VIDEO_AD_DURATION_FIFTEEN_SECONDS", + "MAXIMUM_VIDEO_AD_DURATION_TWENTY_SECONDS", + "MAXIMUM_VIDEO_AD_DURATION_THIRTY_SECONDS", + "MAXIMUM_VIDEO_AD_DURATION_SIXTY_SECONDS", + "MAXIMUM_VIDEO_AD_DURATION_NINETY_SECONDS", + "MAXIMUM_VIDEO_AD_DURATION_ONE_HUNDRED_TWENTY_SECONDS" + ], + "enumDescriptions": [ + "Default value. Should not be used in targeting specifications.", + "Applies to video ads with a duration up to 15 seconds (0 < duration <= 15s).", + "Applies to video ads with a duration up to 20 seconds (0 < duration <= 20s).", + "Applies to video ads with a duration up to 30 seconds (0 < duration <= 30s).", + "Applies to video ads with a duration up to 60 seconds (0 < duration <= 60s).", + "Applies to video ads with a duration up to 90 seconds (0 < duration <= 90s).", + "Applies to video ads with a duration up to 120 seconds (0 < duration <= 120s)." + ], + "type": "string" + }, + "includedMimeTypes": { + "description": "Optional. The list of targeted video mime types using the IANA published MIME type strings (https://www.iana.org/assignments/media-types/media-types.xhtml). If empty, inventory will be targeted regardless of video mime type.", + "items": { + "enum": [ + "VIDEO_MIME_TYPE_UNSPECIFIED", + "VIDEO_MIME_TYPE_THREEGPP", + "VIDEO_MIME_TYPE_APPLICATION_MPEGURL", + "VIDEO_MIME_TYPE_MP4", + "VIDEO_MIME_TYPE_APPLICATION_MPEGDASH", + "VIDEO_MIME_TYPE_APPLICATION_JAVASCRIPT", + "VIDEO_MIME_TYPE_WEBM" + ], + "enumDescriptions": [ + "Default value. Should not be used in targeting specifications.", + "3GPP container format used on 3G phones.", + "HLS/M3U8", + "MPEG-4 container typically with H.264 codec.", + "DASH.", + "JavaScript (used for VPAID ads).", + "WebM container assuming VP9 codec." + ], + "type": "string" + }, + "type": "array" + }, + "includedPlaybackMethods": { + "description": "Optional. The list of targeted video playback methods. If empty, inventory will be targeted regardless of video playback method.", + "items": { + "enum": [ + "PLAYBACK_METHOD_UNSPECIFIED", + "PLAYBACK_METHOD_AUTO_PLAY_SOUND_ON", + "PLAYBACK_METHOD_AUTO_PLAY_SOUND_OFF", + "PLAYBACK_METHOD_CLICK_TO_PLAY" + ], + "enumDescriptions": [ + "Unspecified video playback method. Should not be used.", + "Playback starts automatically when the page/content loads.", + "Playback starts automatically when the page/content loads, but with sound off.", + "Playback is initiated by a user action (e.g., clicking a play button)." + ], + "type": "string" + }, + "type": "array" + }, + "includedPlayerSizeTargeting": { + "$ref": "VideoPlayerSizeTargeting", + "description": "Optional. The targeted video player size. If unset, inventory will be targeted regardless of video player size." + }, + "includedPositionTypes": { + "description": "Optional. The targeted video ad position types. If empty, inventory will be targeted regardless of video ad position type.", + "items": { + "enum": [ + "POSITION_TYPE_UNSPECIFIED", + "POSITION_TYPE_MIDROLL", + "POSITION_TYPE_POSTROLL", + "POSITION_TYPE_PREROLL" + ], + "enumDescriptions": [ + "Default value. Should not be used in targeting specifications.", + "The ad is played in the middle of the video content.", + "The ad is played after the video content.", + "The ad is played before the video content." + ], + "type": "string" + }, + "type": "array" + }, + "minimumPredictedCompletionRatePercentage": { + "description": "Optional. The targeted minimum predicted completion rate percentage. This value must be a multiple of 10 between 10 and 90 (inclusive). For example, 10 is valid, but 0, 15, and 100 are not. A value of 10 means that the configuration will only match adslots for which we predict at least 10% completion rate. An unset value indicates inventory will be targeted regardless of predicted completion rate.", + "format": "int64", + "type": "string" + }, + "plcmtTargeting": { + "$ref": "VideoPlcmtTargeting", + "description": "Optional. The targeted video plcmt types. If unset, inventory will be targeted regardless of video plcmt type." + } + }, + "type": "object" + }, + "StringTargetingDimension": { + "description": "Generic targeting with string values.", + "id": "StringTargetingDimension", + "properties": { + "selectionType": { + "description": "Required. How the items in this list should be targeted.", + "enum": [ + "SELECTION_TYPE_UNSPECIFIED", + "SELECTION_TYPE_INCLUDE", + "SELECTION_TYPE_EXCLUDE" + ], + "enumDescriptions": [ + "Unspecified selection type. Should not be used.", + "The values in the targeting dimension are included.", + "The values in the targeting dimension are excluded." + ], + "type": "string" + }, + "values": { + "description": "Required. The values specified.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "TaxonomyTargeting": { + "description": "Defines targeting criteria for handling the IAB audience and content Taxonomy ID space.", + "id": "TaxonomyTargeting", + "properties": { + "excludedTaxonomyIds": { + "description": "Optional. The list of excluded content taxonomy IDs.", + "items": { + "type": "string" + }, + "type": "array" + }, + "targetedTaxonomyIds": { + "description": "Optional. The list of targeted content taxonomy IDs.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "VideoPlayerSizeTargeting": { + "description": "Represents the size of the video player that can be targeted. Both width and height are required to be set to non-zero values.", + "id": "VideoPlayerSizeTargeting", + "properties": { + "minimumHeight": { + "description": "Required. The minimum height of the video player in pixels.", + "format": "int64", + "type": "string" + }, + "minimumWidth": { + "description": "Required. The minimum width of the video player in pixels.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "VideoPlcmtTargeting": { + "description": "Defines targeting criteria based on the video placement type, often corresponding to the IAB OpenRTB 'plcmt' field.", + "id": "VideoPlcmtTargeting", + "properties": { + "selectionType": { + "description": "Required. The selection type for the list of video plcmts.", + "enum": [ + "SELECTION_TYPE_UNSPECIFIED", + "SELECTION_TYPE_INCLUDE", + "SELECTION_TYPE_EXCLUDE" + ], + "enumDescriptions": [ + "Unspecified selection type. Should not be used.", + "The values in the targeting dimension are included.", + "The values in the targeting dimension are excluded." + ], + "type": "string" + }, + "videoPlcmtTypes": { + "description": "Required. The list of targeted video plcmts types. If empty, inventory will be targeted regardless of video plcmt type.", + "items": { + "enum": [ + "VIDEO_PLCMT_TYPE_UNSPECIFIED", + "INSTREAM", + "ACCOMPANYING_CONTENT", + "INTERSTITIAL", + "NO_CONTENT" + ], + "enumDescriptions": [ + "Default value. Should not be used in targeting specifications.", + "Pre-roll, mid-roll, and post-roll ads that are played before, during or after the streaming video content that the consumer has requested. Instream video must be set to “sound on” by default at player start, or have explicitly clear user intent to watch the video content. While there may be other content surrounding the player, the video content must be the focus of the user’s visit. It should remain the primary content on the page and the only video player in-view capable of audio when playing. If the player converts to floating/sticky, subsequent ad calls should accurately convey the updated player size.", + "Pre-roll, mid-roll, and post-roll ads that are played before, during, or after streaming video content. The video player loads and plays before, between, or after paragraphs of text or graphical content, and starts playing only when it enters the viewport. Accompanying content should only start playback upon entering the viewport. It may convert to a floating/sticky player as it scrolls off the page.", + "Video ads that are played without video content. During playback, it must be the primary focus of the page and take up the majority of the viewport and cannot be scrolled out of view. This can be in placements like in-app video or slideshows.", + "Video ads that are played without streaming video content. This can be in placements like slideshows, native feeds, in-content or sticky/floating." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/beyondcorp-v1.json b/discovery/beyondcorp-v1.json index ef95e19aa01..f0896f4b7bb 100644 --- a/discovery/beyondcorp-v1.json +++ b/discovery/beyondcorp-v1.json @@ -222,7 +222,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -1339,7 +1339,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -1909,7 +1909,7 @@ } } }, - "revision": "20251029", + "revision": "20251210", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { @@ -3933,7 +3933,7 @@ "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.", + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, diff --git a/discovery/beyondcorp-v1alpha.json b/discovery/beyondcorp-v1alpha.json index 23f6b20cc79..73541e5b9e9 100644 --- a/discovery/beyondcorp-v1alpha.json +++ b/discovery/beyondcorp-v1alpha.json @@ -563,7 +563,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -2875,7 +2875,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -3445,7 +3445,7 @@ } } }, - "revision": "20251029", + "revision": "20251210", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { @@ -6244,7 +6244,7 @@ "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.", + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, diff --git a/discovery/clouddeploy-v1.json b/discovery/clouddeploy-v1.json index b7def98d785..6d16d9d031a 100644 --- a/discovery/clouddeploy-v1.json +++ b/discovery/clouddeploy-v1.json @@ -2359,7 +2359,7 @@ } } }, - "revision": "20251203", + "revision": "20251210", "rootUrl": "https://clouddeploy.googleapis.com/", "schemas": { "AbandonReleaseRequest": { @@ -5444,7 +5444,7 @@ }, "toolVersions": { "$ref": "ToolVersions", - "description": "Optional. The tool versions to use for this release and all subsequent operations involving this release. If unset, then it will freeze the tool versions at the time of release creation." + "description": "Optional. The tool versions to use for this release and all subsequent operations involving this release. If unset, tool versions are frozen when the release is created." }, "uid": { "description": "Output only. Unique identifier of the `Release`.", @@ -5470,7 +5470,7 @@ }, "kptVersionSupportedCondition": { "$ref": "ToolVersionSupportedCondition", - "description": "Output only. Details around the support state of the release's Kpt version.", + "description": "Output only. Details around the support state of the release's kpt version.", "readOnly": true }, "kubectlVersionSupportedCondition": { @@ -7277,11 +7277,11 @@ "type": "object" }, "ToolVersionSupportedCondition": { - "description": "ToolVersionSupportedCondition contains information about when support for the release's version of a Tool ends.", + "description": "ToolVersionSupportedCondition contains information about when support for the release's version of a tool ends.", "id": "ToolVersionSupportedCondition", "properties": { "maintenanceModeTime": { - "description": "Output only. The time at which this release's version of the Tool will enter maintenance mode.", + "description": "Output only. The time at which this release's version of the tool will enter maintenance mode.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -7292,13 +7292,13 @@ "type": "boolean" }, "supportExpirationTime": { - "description": "Output only. The time at which this release's version of the Tool will no longer be supported.", + "description": "Output only. The time at which this release's version of the tool will no longer be supported.", "format": "google-datetime", "readOnly": true, "type": "string" }, "toolVersionSupportState": { - "description": "Output only. The Tool support state for this release's version of the Tool.", + "description": "Output only. The tool support state for this release's version of the tool.", "enum": [ "TOOL_VERSION_SUPPORT_STATE_UNSPECIFIED", "TOOL_VERSION_SUPPORT_STATE_SUPPORTED", @@ -7307,9 +7307,9 @@ ], "enumDescriptions": [ "Default value. This value is unused.", - "This Tool version is currently supported.", - "This Tool version is in maintenance mode.", - "This Tool version is no longer supported." + "This tool version is currently supported.", + "This tool version is in maintenance mode.", + "This tool version is no longer supported." ], "readOnly": true, "type": "string" @@ -7322,11 +7322,11 @@ "id": "ToolVersions", "properties": { "docker": { - "description": "Optional. The docker version to use for Cloud Deploy operations.", + "description": "Optional. The Docker version to use for Cloud Deploy operations.", "type": "string" }, "helm": { - "description": "Optional. The helm version to use for Cloud Deploy operations.", + "description": "Optional. The Helm version to use for Cloud Deploy operations.", "type": "string" }, "kpt": { @@ -7334,15 +7334,15 @@ "type": "string" }, "kubectl": { - "description": "Optional. The kubectl version to use for Cloud Deploy operations.", + "description": "Optional. The Kubectl version to use for Cloud Deploy operations.", "type": "string" }, "kustomize": { - "description": "Optional. The kustomize version to use for Cloud Deploy operations.", + "description": "Optional. The Kustomize version to use for Cloud Deploy operations.", "type": "string" }, "skaffold": { - "description": "Optional. The skaffold version to use for Cloud Deploy operations.", + "description": "Optional. The Skaffold version to use for Cloud Deploy operations.", "type": "string" } }, diff --git a/discovery/contactcenterinsights-v1.json b/discovery/contactcenterinsights-v1.json index a6d2b973b02..55051a5f0b0 100644 --- a/discovery/contactcenterinsights-v1.json +++ b/discovery/contactcenterinsights-v1.json @@ -1275,6 +1275,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "generateSignedAudio": { + "description": "Gets the signed URI for the audio for the given conversation.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}:generateSignedAudio", + "httpMethod": "GET", + "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.generateSignedAudio", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the conversation to sign.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:generateSignedAudio", + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1GenerateConversationSignedAudioResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Gets a conversation.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}", @@ -2138,6 +2163,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "generateSignedAudio": { + "description": "Gets the signed URI for the audio for the given conversation.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}:generateSignedAudio", + "httpMethod": "GET", + "id": "contactcenterinsights.projects.locations.conversations.generateSignedAudio", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the conversation to sign.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:generateSignedAudio", + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1GenerateConversationSignedAudioResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Gets a conversation.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}", @@ -3399,6 +3449,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "generateSignedAudio": { + "description": "Gets the signed URI for the audio for the given conversation.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}:generateSignedAudio", + "httpMethod": "GET", + "id": "contactcenterinsights.projects.locations.datasets.conversations.generateSignedAudio", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the conversation to sign.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:generateSignedAudio", + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1GenerateConversationSignedAudioResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Gets a conversation.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}", @@ -5378,7 +5453,7 @@ } } }, - "revision": "20251208", + "revision": "20251219", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudContactcenterinsightsV1Analysis": { @@ -6638,6 +6713,22 @@ }, "type": "object" }, + "GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio": { + "description": "A wrapper for holding the audio for any given turn.", + "id": "GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio", + "properties": { + "audioDuration": { + "description": "The duration of the audio.", + "format": "google-duration", + "type": "string" + }, + "audioGcsUri": { + "description": "The Cloud Storage URI of the audio for any given turn.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1ConversationLevelSentiment": { "description": "One channel of conversation-level sentiment data.", "id": "GoogleCloudContactcenterinsightsV1ConversationLevelSentiment", @@ -7751,6 +7842,8 @@ "EXPORT_V12", "EXPORT_V13", "EXPORT_V14", + "EXPORT_V15", + "EXPORT_V16", "EXPORT_VERSION_LATEST_AVAILABLE" ], "enumDescriptions": [ @@ -7769,6 +7862,8 @@ "Export schema version 12.", "Export schema version 13.", "Export schema version 14.", + "Export schema version 15.", + "Export schema version 16.", "Export schema version latest available." ], "type": "string" @@ -7971,6 +8066,17 @@ }, "type": "object" }, + "GoogleCloudContactcenterinsightsV1GenerateConversationSignedAudioResponse": { + "description": "The response from a GenerateConversationSignedAudio request.", + "id": "GoogleCloudContactcenterinsightsV1GenerateConversationSignedAudioResponse", + "properties": { + "signedAudioUris": { + "$ref": "GoogleCloudContactcenterinsightsV1SignedAudioUris", + "description": "The signed uris for the audio." + } + }, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1HoldData": { "description": "The data for a hold annotation.", "id": "GoogleCloudContactcenterinsightsV1HoldData", @@ -9148,7 +9254,7 @@ "id": "GoogleCloudContactcenterinsightsV1QaAnswer", "properties": { "answerSources": { - "description": "List of all individual answers given to the question.", + "description": "Lists all answer sources containing one or more answer values of a specific source type, e.g., all system-generated answer sources, or all manual edit answer sources.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource" }, @@ -9156,7 +9262,7 @@ }, "answerValue": { "$ref": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue", - "description": "The main answer value, incorporating any manual edits if they exist." + "description": "The answer value from this source. This field is populated by default, unless the question has a selection strategy configured to return multiple answer values, in which case `answer_values` will be populated instead." }, "conversation": { "description": "The conversation the answer applies to.", @@ -9186,7 +9292,7 @@ "properties": { "answerValue": { "$ref": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue", - "description": "The answer value from this source." + "description": "The answer value from this source. This field is populated by default, unless the question has a selection strategy configured to return multiple answer values, in which case `answer_values` will be populated instead." }, "sourceType": { "description": "What created the answer.", @@ -10335,6 +10441,28 @@ }, "type": "object" }, + "GoogleCloudContactcenterinsightsV1SignedAudioUris": { + "description": "Signed audio URIs for a conversation.", + "id": "GoogleCloudContactcenterinsightsV1SignedAudioUris", + "properties": { + "signedDialogflowAudioUri": { + "description": "The signed URI for the audio from the Dialogflow conversation source.", + "type": "string" + }, + "signedGcsAudioUri": { + "description": "The signed URI for the audio from the Cloud Storage conversation source.", + "type": "string" + }, + "signedTurnLevelAudios": { + "description": "The signed URI for the audio corresponding to each turn in the conversation.", + "items": { + "$ref": "GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1SilenceData": { "description": "The data for a silence annotation.", "id": "GoogleCloudContactcenterinsightsV1SilenceData", @@ -10399,6 +10527,10 @@ "description": "Speech-to-Text configuration. Speech-to-Text settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint.", "id": "GoogleCloudContactcenterinsightsV1SpeechConfig", "properties": { + "disableWordTimeOffsets": { + "description": "Whether to disable word time offsets. If true, the `enable_word_time_offsets` field in the recognition config will be set to false.", + "type": "boolean" + }, "speechRecognizer": { "description": "The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`", "type": "string" @@ -12419,6 +12551,8 @@ "EXPORT_V12", "EXPORT_V13", "EXPORT_V14", + "EXPORT_V15", + "EXPORT_V16", "EXPORT_VERSION_LATEST_AVAILABLE" ], "enumDescriptions": [ @@ -12437,6 +12571,8 @@ "Export schema version 12.", "Export schema version 13.", "Export schema version 14.", + "Export schema version 15.", + "Export schema version 16.", "Export schema version latest available." ], "type": "string" @@ -13286,7 +13422,7 @@ "id": "GoogleCloudContactcenterinsightsV1alpha1QaAnswer", "properties": { "answerSources": { - "description": "List of all individual answers given to the question.", + "description": "Lists all answer sources containing one or more answer values of a specific source type, e.g., all system-generated answer sources, or all manual edit answer sources.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerSource" }, @@ -13294,7 +13430,7 @@ }, "answerValue": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue", - "description": "The main answer value, incorporating any manual edits if they exist." + "description": "The answer value from this source. This field is populated by default, unless the question has a selection strategy configured to return multiple answer values, in which case `answer_values` will be populated instead." }, "conversation": { "description": "The conversation the answer applies to.", @@ -13324,7 +13460,7 @@ "properties": { "answerValue": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue", - "description": "The answer value from this source." + "description": "The answer value from this source. This field is populated by default, unless the question has a selection strategy configured to return multiple answer values, in which case `answer_values` will be populated instead." }, "sourceType": { "description": "What created the answer.", @@ -14030,6 +14166,10 @@ "description": "Speech-to-Text configuration. Speech-to-Text settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint.", "id": "GoogleCloudContactcenterinsightsV1alpha1SpeechConfig", "properties": { + "disableWordTimeOffsets": { + "description": "Whether to disable word time offsets. If true, the `enable_word_time_offsets` field in the recognition config will be set to false.", + "type": "boolean" + }, "speechRecognizer": { "description": "The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`", "type": "string" @@ -16167,6 +16307,8 @@ "EXPORT_V12", "EXPORT_V13", "EXPORT_V14", + "EXPORT_V15", + "EXPORT_V16", "EXPORT_VERSION_LATEST_AVAILABLE" ], "enumDescriptions": [ @@ -16185,6 +16327,8 @@ "Export schema version 12.", "Export schema version 13.", "Export schema version 14.", + "Export schema version 15.", + "Export schema version 16.", "Export schema version latest available." ], "type": "string" @@ -17034,7 +17178,7 @@ "id": "GoogleCloudContactcenterinsightsV1mainQaAnswer", "properties": { "answerSources": { - "description": "List of all individual answers given to the question.", + "description": "Lists all answer sources containing one or more answer values of a specific source type, e.g., all system-generated answer sources, or all manual edit answer sources.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerSource" }, @@ -17042,7 +17186,7 @@ }, "answerValue": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue", - "description": "The main answer value, incorporating any manual edits if they exist." + "description": "The answer value from this source. This field is populated by default, unless the question has a selection strategy configured to return multiple answer values, in which case `answer_values` will be populated instead." }, "conversation": { "description": "The conversation the answer applies to.", @@ -17072,7 +17216,7 @@ "properties": { "answerValue": { "$ref": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue", - "description": "The answer value from this source." + "description": "The answer value from this source. This field is populated by default, unless the question has a selection strategy configured to return multiple answer values, in which case `answer_values` will be populated instead." }, "sourceType": { "description": "What created the answer.", @@ -17778,6 +17922,10 @@ "description": "Speech-to-Text configuration. Speech-to-Text settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint.", "id": "GoogleCloudContactcenterinsightsV1mainSpeechConfig", "properties": { + "disableWordTimeOffsets": { + "description": "Whether to disable word time offsets. If true, the `enable_word_time_offsets` field in the recognition config will be set to false.", + "type": "boolean" + }, "speechRecognizer": { "description": "The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`", "type": "string" diff --git a/discovery/container-v1.json b/discovery/container-v1.json index e5d24b06700..57e8a01a71e 100644 --- a/discovery/container-v1.json +++ b/discovery/container-v1.json @@ -2660,7 +2660,7 @@ } } }, - "revision": "20251202", + "revision": "20251216", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -3325,7 +3325,7 @@ }, "gcpSecretManagerCertificateConfig": { "$ref": "GCPSecretManagerCertificateConfig", - "description": "Google Secret Manager (GCP) certificate configuration." + "description": "Secret Manager certificate configuration." } }, "type": "object" diff --git a/discovery/container-v1beta1.json b/discovery/container-v1beta1.json index b697d7f98ec..16c33737d1c 100644 --- a/discovery/container-v1beta1.json +++ b/discovery/container-v1beta1.json @@ -2741,7 +2741,7 @@ } } }, - "revision": "20251202", + "revision": "20251216", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -6539,7 +6539,7 @@ "properties": { "compatibilityStatus": { "$ref": "CompatibilityStatus", - "description": "Output only. The compatibility status of the control plane. It should be empty if the cluster does not have emulated version. For details, see go/user-initiated-rollbackable-upgrade-design.", + "description": "Output only. The compatibility status of the control plane. It should be empty if the cluster does not have emulated version.", "readOnly": true } }, diff --git a/discovery/dataflow-v1b3.json b/discovery/dataflow-v1b3.json index 84c077e1acc..1f0f9440e37 100644 --- a/discovery/dataflow-v1b3.json +++ b/discovery/dataflow-v1b3.json @@ -2375,7 +2375,7 @@ } } }, - "revision": "20251030", + "revision": "20251214", "rootUrl": "https://dataflow.googleapis.com/", "schemas": { "ApproximateProgress": { @@ -5945,6 +5945,11 @@ "description": "Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation.", "id": "RuntimeUpdatableParams", "properties": { + "acceptableBacklogDuration": { + "description": "Optional. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.", + "format": "google-duration", + "type": "string" + }, "maxNumWorkers": { "description": "The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.", "format": "int32", diff --git a/discovery/developerconnect-v1.json b/discovery/developerconnect-v1.json index b9d57de1cd8..8d900884fee 100644 --- a/discovery/developerconnect-v1.json +++ b/discovery/developerconnect-v1.json @@ -1754,7 +1754,7 @@ } } }, - "revision": "20251209", + "revision": "20251211", "rootUrl": "https://developerconnect.googleapis.com/", "schemas": { "AccountConnector": { @@ -2493,6 +2493,11 @@ "enabled": { "description": "Optional. Setting this to true allows the git proxy to be used for performing git operations on the repositories linked in the connection.", "type": "boolean" + }, + "httpProxyBaseUri": { + "description": "Output only. The base URI for the HTTP proxy endpoint. Has the format `https://{generatedID}-c-h-{shortRegion}.developerconnect.dev` Populated only when enabled is set to true. This endpoint is used by other Google services that integrate with Developer Connect.", + "readOnly": true, + "type": "string" } }, "type": "object" @@ -3196,16 +3201,27 @@ "DATASTAX", "DYNATRACE" ], + "enumDeprecated": [ + false, + false, + false, + true, + true, + true, + true, + true, + true + ], "enumDescriptions": [ "No system provider specified.", "GitHub provider. Scopes can be found at https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps#available-scopes", "GitLab provider. Scopes can be found at https://docs.gitlab.com/user/profile/personal_access_tokens/#personal-access-token-scopes", - "Google provider. Recommended scopes: \"https://www.googleapis.com/auth/drive.readonly\", \"https://www.googleapis.com/auth/documents.readonly\"", - "Sentry provider. Scopes can be found at https://docs.sentry.io/api/permissions/", - "Rovo provider. Must select the \"rovo\" scope.", - "New Relic provider. No scopes are allowed.", - "Datastax provider. No scopes are allowed.", - "Dynatrace provider." + "Deprecated: This provider is no longer supported. Google provider. Recommended scopes: \"https://www.googleapis.com/auth/drive.readonly\", \"https://www.googleapis.com/auth/documents.readonly\"", + "Deprecated: This provider is no longer supported. Sentry provider. Scopes can be found at https://docs.sentry.io/api/permissions/", + "Deprecated: This provider is no longer supported. Rovo provider. Must select the \"rovo\" scope.", + "Deprecated: This provider is no longer supported. New Relic provider. No scopes are allowed.", + "Deprecated: This provider is no longer supported. Datastax provider. No scopes are allowed.", + "Deprecated: This provider is no longer supported. Dynatrace provider." ], "type": "string" } @@ -3309,16 +3325,27 @@ "DATASTAX", "DYNATRACE" ], + "enumDeprecated": [ + false, + false, + false, + true, + true, + true, + true, + true, + true + ], "enumDescriptions": [ "No system provider specified.", "GitHub provider. Scopes can be found at https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps#available-scopes", "GitLab provider. Scopes can be found at https://docs.gitlab.com/user/profile/personal_access_tokens/#personal-access-token-scopes", - "Google provider. Recommended scopes: \"https://www.googleapis.com/auth/drive.readonly\", \"https://www.googleapis.com/auth/documents.readonly\"", - "Sentry provider. Scopes can be found at https://docs.sentry.io/api/permissions/", - "Rovo provider. Must select the \"rovo\" scope.", - "New Relic provider. No scopes are allowed.", - "Datastax provider. No scopes are allowed.", - "Dynatrace provider." + "Deprecated: This provider is no longer supported. Google provider. Recommended scopes: \"https://www.googleapis.com/auth/drive.readonly\", \"https://www.googleapis.com/auth/documents.readonly\"", + "Deprecated: This provider is no longer supported. Sentry provider. Scopes can be found at https://docs.sentry.io/api/permissions/", + "Deprecated: This provider is no longer supported. Rovo provider. Must select the \"rovo\" scope.", + "Deprecated: This provider is no longer supported. New Relic provider. No scopes are allowed.", + "Deprecated: This provider is no longer supported. Datastax provider. No scopes are allowed.", + "Deprecated: This provider is no longer supported. Dynatrace provider." ], "type": "string" }, diff --git a/discovery/discoveryengine-v1.json b/discovery/discoveryengine-v1.json index 54d8c3b9af3..4d01879267c 100644 --- a/discovery/discoveryengine-v1.json +++ b/discovery/discoveryengine-v1.json @@ -551,7 +551,7 @@ "type": "string" }, "updateMask": { - "description": "Indicates which fields in the provided DataConnector to update. Supported field paths include: - refresh_interval - params - auto_run_disabled - action_config - action_config.action_params - action_config.service_name - destination_configs - blocking_reasons - sync_mode - incremental_sync_disabled - incremental_refresh_interval Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error.", + "description": "Indicates which fields in the provided DataConnector to update. Supported field paths include: - `refresh_interval` - `params` - `auto_run_disabled` - `action_config` - `action_config.action_params` - `action_config.service_name` - `destination_configs` - `blocking_reasons` - `sync_mode` - `incremental_sync_disabled` - `incremental_refresh_interval` - `data_protection_policy` Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -8801,7 +8801,7 @@ } } }, - "revision": "20251216", + "revision": "20251221", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -16925,7 +16925,7 @@ "description": "Optional. The specification for returning the relevance score." }, "relevanceThreshold": { - "description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.", + "description": "The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search.", "enum": [ "RELEVANCE_THRESHOLD_UNSPECIFIED", "LOWEST", @@ -25340,12 +25340,16 @@ "description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.", "type": "string" }, + "relevanceFilterSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec", + "description": "Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search." + }, "relevanceScoreSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec", "description": "Optional. The specification for returning the relevance score." }, "relevanceThreshold": { - "description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.", + "description": "The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search.", "enum": [ "RELEVANCE_THRESHOLD_UNSPECIFIED", "LOWEST", @@ -25997,6 +26001,51 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec": { + "description": "Relevance filtering specification.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec", + "properties": { + "keywordSearchThreshold": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec", + "description": "Optional. Relevance filtering threshold specification for keyword search." + }, + "semanticSearchThreshold": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec", + "description": "Optional. Relevance filtering threshold specification for semantic search." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec": { + "description": "Specification for relevance filtering on a specific sub-search.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec", + "properties": { + "relevanceThreshold": { + "description": "Pre-defined relevance threshold for the sub-search.", + "enum": [ + "RELEVANCE_THRESHOLD_UNSPECIFIED", + "LOWEST", + "LOW", + "MEDIUM", + "HIGH" + ], + "enumDescriptions": [ + "Default value. In this case, server behavior defaults to Google defined threshold.", + "Lowest relevance threshold.", + "Low relevance threshold.", + "Medium relevance threshold.", + "High relevance threshold." + ], + "type": "string" + }, + "semanticRelevanceThreshold": { + "description": "Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0].", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec": { "description": "The specification for returning the document relevance score.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec", @@ -29393,12 +29442,16 @@ "description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.", "type": "string" }, + "relevanceFilterSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec", + "description": "Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search." + }, "relevanceScoreSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec", "description": "Optional. The specification for returning the relevance score." }, "relevanceThreshold": { - "description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.", + "description": "The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search.", "enum": [ "RELEVANCE_THRESHOLD_UNSPECIFIED", "LOWEST", @@ -30046,6 +30099,51 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec": { + "description": "Relevance filtering specification.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec", + "properties": { + "keywordSearchThreshold": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec", + "description": "Optional. Relevance filtering threshold specification for keyword search." + }, + "semanticSearchThreshold": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec", + "description": "Optional. Relevance filtering threshold specification for semantic search." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec": { + "description": "Specification for relevance filtering on a specific sub-search.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec", + "properties": { + "relevanceThreshold": { + "description": "Pre-defined relevance threshold for the sub-search.", + "enum": [ + "RELEVANCE_THRESHOLD_UNSPECIFIED", + "LOWEST", + "LOW", + "MEDIUM", + "HIGH" + ], + "enumDescriptions": [ + "Default value. In this case, server behavior defaults to Google defined threshold.", + "Lowest relevance threshold.", + "Low relevance threshold.", + "Medium relevance threshold.", + "High relevance threshold." + ], + "type": "string" + }, + "semanticRelevanceThreshold": { + "description": "Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0].", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec": { "description": "The specification for returning the document relevance score.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec", diff --git a/discovery/discoveryengine-v1alpha.json b/discovery/discoveryengine-v1alpha.json index 6d41eac083e..dfa56bc3f8b 100644 --- a/discovery/discoveryengine-v1alpha.json +++ b/discovery/discoveryengine-v1alpha.json @@ -1242,7 +1242,7 @@ "type": "string" }, "updateMask": { - "description": "Indicates which fields in the provided DataConnector to update. Supported field paths include: - refresh_interval - params - auto_run_disabled - action_config - action_config.action_params - action_config.service_name - destination_configs - blocking_reasons - sync_mode - incremental_sync_disabled - incremental_refresh_interval Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error.", + "description": "Indicates which fields in the provided DataConnector to update. Supported field paths include: - `refresh_interval` - `params` - `auto_run_disabled` - `action_config` - `action_config.action_params` - `action_config.service_name` - `destination_configs` - `blocking_reasons` - `sync_mode` - `incremental_sync_disabled` - `incremental_refresh_interval` - `data_protection_policy` Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -12111,7 +12111,7 @@ } } }, - "revision": "20251216", + "revision": "20251221", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -27638,12 +27638,16 @@ "description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.", "type": "string" }, + "relevanceFilterSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec", + "description": "Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search." + }, "relevanceScoreSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec", "description": "Optional. The specification for returning the relevance score." }, "relevanceThreshold": { - "description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.", + "description": "The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search.", "enum": [ "RELEVANCE_THRESHOLD_UNSPECIFIED", "LOWEST", @@ -28295,6 +28299,51 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec": { + "description": "Relevance filtering specification.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec", + "properties": { + "keywordSearchThreshold": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec", + "description": "Optional. Relevance filtering threshold specification for keyword search." + }, + "semanticSearchThreshold": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec", + "description": "Optional. Relevance filtering threshold specification for semantic search." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec": { + "description": "Specification for relevance filtering on a specific sub-search.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec", + "properties": { + "relevanceThreshold": { + "description": "Pre-defined relevance threshold for the sub-search.", + "enum": [ + "RELEVANCE_THRESHOLD_UNSPECIFIED", + "LOWEST", + "LOW", + "MEDIUM", + "HIGH" + ], + "enumDescriptions": [ + "Default value. In this case, server behavior defaults to Google defined threshold.", + "Lowest relevance threshold.", + "Low relevance threshold.", + "Medium relevance threshold.", + "High relevance threshold." + ], + "type": "string" + }, + "semanticRelevanceThreshold": { + "description": "Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0].", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec": { "description": "The specification for returning the document relevance score.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec", @@ -34125,12 +34174,16 @@ "description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.", "type": "string" }, + "relevanceFilterSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec", + "description": "Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search." + }, "relevanceScoreSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec", "description": "Optional. The specification for returning the relevance score." }, "relevanceThreshold": { - "description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.", + "description": "The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search.", "enum": [ "RELEVANCE_THRESHOLD_UNSPECIFIED", "LOWEST", @@ -34778,6 +34831,51 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec": { + "description": "Relevance filtering specification.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec", + "properties": { + "keywordSearchThreshold": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec", + "description": "Optional. Relevance filtering threshold specification for keyword search." + }, + "semanticSearchThreshold": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec", + "description": "Optional. Relevance filtering threshold specification for semantic search." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec": { + "description": "Specification for relevance filtering on a specific sub-search.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec", + "properties": { + "relevanceThreshold": { + "description": "Pre-defined relevance threshold for the sub-search.", + "enum": [ + "RELEVANCE_THRESHOLD_UNSPECIFIED", + "LOWEST", + "LOW", + "MEDIUM", + "HIGH" + ], + "enumDescriptions": [ + "Default value. In this case, server behavior defaults to Google defined threshold.", + "Lowest relevance threshold.", + "Low relevance threshold.", + "Medium relevance threshold.", + "High relevance threshold." + ], + "type": "string" + }, + "semanticRelevanceThreshold": { + "description": "Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0].", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec": { "description": "The specification for returning the document relevance score.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec", diff --git a/discovery/discoveryengine-v1beta.json b/discovery/discoveryengine-v1beta.json index ce0eeb42015..b9a74c7fb1d 100644 --- a/discovery/discoveryengine-v1beta.json +++ b/discovery/discoveryengine-v1beta.json @@ -9106,7 +9106,7 @@ } } }, - "revision": "20251216", + "revision": "20251217", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -18928,12 +18928,16 @@ "description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.", "type": "string" }, + "relevanceFilterSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec", + "description": "Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search." + }, "relevanceScoreSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec", "description": "Optional. The specification for returning the relevance score." }, "relevanceThreshold": { - "description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.", + "description": "The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search.", "enum": [ "RELEVANCE_THRESHOLD_UNSPECIFIED", "LOWEST", @@ -19585,6 +19589,51 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec": { + "description": "Relevance filtering specification.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec", + "properties": { + "keywordSearchThreshold": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec", + "description": "Optional. Relevance filtering threshold specification for keyword search." + }, + "semanticSearchThreshold": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec", + "description": "Optional. Relevance filtering threshold specification for semantic search." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec": { + "description": "Specification for relevance filtering on a specific sub-search.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec", + "properties": { + "relevanceThreshold": { + "description": "Pre-defined relevance threshold for the sub-search.", + "enum": [ + "RELEVANCE_THRESHOLD_UNSPECIFIED", + "LOWEST", + "LOW", + "MEDIUM", + "HIGH" + ], + "enumDescriptions": [ + "Default value. In this case, server behavior defaults to Google defined threshold.", + "Lowest relevance threshold.", + "Low relevance threshold.", + "Medium relevance threshold.", + "High relevance threshold." + ], + "type": "string" + }, + "semanticRelevanceThreshold": { + "description": "Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0].", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec": { "description": "The specification for returning the document relevance score.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec", @@ -28064,12 +28113,16 @@ "description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.", "type": "string" }, + "relevanceFilterSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec", + "description": "Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search." + }, "relevanceScoreSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec", "description": "Optional. The specification for returning the relevance score." }, "relevanceThreshold": { - "description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.", + "description": "The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search.", "enum": [ "RELEVANCE_THRESHOLD_UNSPECIFIED", "LOWEST", @@ -28717,6 +28770,51 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec": { + "description": "Relevance filtering specification.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec", + "properties": { + "keywordSearchThreshold": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec", + "description": "Optional. Relevance filtering threshold specification for keyword search." + }, + "semanticSearchThreshold": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec", + "description": "Optional. Relevance filtering threshold specification for semantic search." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec": { + "description": "Specification for relevance filtering on a specific sub-search.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec", + "properties": { + "relevanceThreshold": { + "description": "Pre-defined relevance threshold for the sub-search.", + "enum": [ + "RELEVANCE_THRESHOLD_UNSPECIFIED", + "LOWEST", + "LOW", + "MEDIUM", + "HIGH" + ], + "enumDescriptions": [ + "Default value. In this case, server behavior defaults to Google defined threshold.", + "Lowest relevance threshold.", + "Low relevance threshold.", + "Medium relevance threshold.", + "High relevance threshold." + ], + "type": "string" + }, + "semanticRelevanceThreshold": { + "description": "Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0].", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec": { "description": "The specification for returning the document relevance score.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec", diff --git a/discovery/dlp-v2.json b/discovery/dlp-v2.json index 813b7d6ea8a..bcef653425e 100644 --- a/discovery/dlp-v2.json +++ b/discovery/dlp-v2.json @@ -5123,7 +5123,7 @@ } } }, - "revision": "20251204", + "revision": "20251213", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -6735,7 +6735,7 @@ }, "storedType": { "$ref": "GooglePrivacyDlpV2StoredType", - "description": "Load an existing `StoredInfoType` resource for use in `InspectDataSource`. Not currently supported in `InspectContent`." + "description": "Loads an existing `StoredInfoType` resource." }, "surrogateType": { "$ref": "GooglePrivacyDlpV2SurrogateType", diff --git a/discovery/eventarc-v1.json b/discovery/eventarc-v1.json index bd68844bd5a..c9a09c13f55 100644 --- a/discovery/eventarc-v1.json +++ b/discovery/eventarc-v1.json @@ -1284,97 +1284,6 @@ } } }, - "kafkaSources": { - "methods": { - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/kafkaSources/{kafkaSourcesId}:getIamPolicy", - "httpMethod": "GET", - "id": "eventarc.projects.locations.kafkaSources.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/[^/]+/kafkaSources/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "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}/kafkaSources/{kafkaSourcesId}:setIamPolicy", - "httpMethod": "POST", - "id": "eventarc.projects.locations.kafkaSources.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/[^/]+/kafkaSources/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "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}/kafkaSources/{kafkaSourcesId}:testIamPermissions", - "httpMethod": "POST", - "id": "eventarc.projects.locations.kafkaSources.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/kafkaSources/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, "messageBuses": { "methods": { "create": { @@ -2471,7 +2380,7 @@ } } }, - "revision": "20251202", + "revision": "20251219", "rootUrl": "https://eventarc.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/discovery/firestore-v1.json b/discovery/firestore-v1.json index 2503a2fd0ad..994b5786de9 100644 --- a/discovery/firestore-v1.json +++ b/discovery/firestore-v1.json @@ -1464,6 +1464,35 @@ "https://www.googleapis.com/auth/datastore" ] }, + "executePipeline": { + "description": "Executes a pipeline query.", + "flatPath": "v1/projects/{projectsId}/databases/{databasesId}/documents:executePipeline", + "httpMethod": "POST", + "id": "firestore.projects.databases.documents.executePipeline", + "parameterOrder": [ + "database" + ], + "parameters": { + "database": { + "description": "Required. Database identifier, in the form `projects/{project}/databases/{database}`.", + "location": "path", + "pattern": "^projects/[^/]+/databases/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+database}/documents:executePipeline", + "request": { + "$ref": "ExecutePipelineRequest" + }, + "response": { + "$ref": "ExecutePipelineResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ] + }, "get": { "description": "Gets a single document.", "flatPath": "v1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}", @@ -2416,7 +2445,7 @@ } } }, - "revision": "20251203", + "revision": "20251216", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -2902,6 +2931,59 @@ "properties": {}, "type": "object" }, + "ExecutePipelineRequest": { + "description": "The request for Firestore.ExecutePipeline.", + "id": "ExecutePipelineRequest", + "properties": { + "newTransaction": { + "$ref": "TransactionOptions", + "description": "Execute the pipeline in a new transaction. The identifier of the newly created transaction will be returned in the first response on the stream. This defaults to a read-only transaction." + }, + "readTime": { + "description": "Execute the pipeline in a snapshot transaction at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.", + "format": "google-datetime", + "type": "string" + }, + "structuredPipeline": { + "$ref": "StructuredPipeline", + "description": "A pipelined operation." + }, + "transaction": { + "description": "Run the query within an already active transaction. The value here is the opaque transaction ID to execute the query in.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "ExecutePipelineResponse": { + "description": "The response for Firestore.Execute.", + "id": "ExecutePipelineResponse", + "properties": { + "executionTime": { + "description": "The time at which the results are valid. This is a (not strictly) monotonically increasing value across multiple responses in the same stream. The API guarantees that all previously returned results are still valid at the latest `execution_time`. This allows the API consumer to treat the query if it ran at the latest `execution_time` returned. If the query returns no results, a response with `execution_time` and no `results` will be sent, and this represents the time at which the operation was run.", + "format": "google-datetime", + "type": "string" + }, + "explainStats": { + "$ref": "ExplainStats", + "description": "Query explain stats. This is present on the **last** response if the request configured explain to run in 'analyze' or 'explain' mode in the pipeline options. If the query does not return any results, a response with `explain_stats` and no `results` will still be sent." + }, + "results": { + "description": "An ordered batch of results returned executing a pipeline. The batch size is variable, and can even be zero for when only a partial progress message is returned. The fields present in the returned documents are only those that were explicitly requested in the pipeline, this includes those like `__name__` and `__update_time__`. This is explicitly a divergence from `Firestore.RunQuery` / `Firestore.GetDocument` RPCs which always return such fields even when they are not specified in the `mask`.", + "items": { + "$ref": "Document" + }, + "type": "array" + }, + "transaction": { + "description": "Newly created transaction identifier. This field is only specified as part of the first response from the server, alongside the `results` field when the original request specified ExecuteRequest.new_transaction.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, "ExecutionStats": { "description": "Execution statistics for the query.", "id": "ExecutionStats", @@ -2979,6 +3061,21 @@ }, "type": "object" }, + "ExplainStats": { + "description": "Pipeline explain stats. Depending on the explain options in the original request, this can contain the optimized plan and / or execution stats.", + "id": "ExplainStats", + "properties": { + "data": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The format depends on the `output_format` options in the request. Currently there are two supported options: `TEXT` and `JSON`. Both supply a `google.protobuf.StringValue`.", + "type": "object" + } + }, + "type": "object" + }, "FieldFilter": { "description": "A filter on a specific field.", "id": "FieldFilter", @@ -3142,6 +3239,31 @@ }, "type": "object" }, + "Function": { + "description": "Represents an unevaluated scalar expression. For example, the expression `like(user_name, \"%alice%\")` is represented as: ``` name: \"like\" args { field_reference: \"user_name\" } args { string_value: \"%alice%\" } ```", + "id": "Function", + "properties": { + "args": { + "description": "Optional. Ordered list of arguments the given function expects.", + "items": { + "$ref": "Value" + }, + "type": "array" + }, + "name": { + "description": "Required. The name of the function to evaluate. **Requires:** * must be in snake case (lower case with underscore separator).", + "type": "string" + }, + "options": { + "additionalProperties": { + "$ref": "Value" + }, + "description": "Optional. Optional named arguments that certain functions may support.", + "type": "object" + } + }, + "type": "object" + }, "GoogleFirestoreAdminV1Backup": { "description": "A Backup of a Cloud Firestore Database. The backup contains all documents and index configurations for the given database at a specific point in time.", "id": "GoogleFirestoreAdminV1Backup", @@ -3479,7 +3601,7 @@ "description": "Optional. Presence indicates CMEK is enabled for this database." }, "concurrencyMode": { - "description": "The concurrency control mode to use for this database.", + "description": "The concurrency control mode to use for this database. If unspecified in a CreateDatabase request, this will default based on the database edition: Optimistic for Enterprise and Pessimistic for all other databases.", "enum": [ "CONCURRENCY_MODE_UNSPECIFIED", "OPTIMISTIC", @@ -3488,9 +3610,9 @@ ], "enumDescriptions": [ "Not used.", - "Use optimistic concurrency control by default. This mode is available for Cloud Firestore databases.", - "Use pessimistic concurrency control by default. This mode is available for Cloud Firestore databases. This is the default setting for Cloud Firestore.", - "Use optimistic concurrency control with entity groups by default. This is the only available mode for Cloud Datastore. This mode is also available for Cloud Firestore with Datastore Mode but is not recommended." + "Use optimistic concurrency control by default. This mode is available for Cloud Firestore databases. This is the default setting for Cloud Firestore Enterprise Edition databases.", + "Use pessimistic concurrency control by default. This mode is available for Cloud Firestore databases. This is the default setting for Cloud Firestore Standard Edition databases.", + "Use optimistic concurrency control with entity groups by default. This mode is enabled for some databases that were automatically upgraded from Cloud Datastore to Cloud Firestore with Datastore Mode. It is not recommended for any new databases, and not supported for Firestore Native databases." ], "type": "string" }, @@ -5012,6 +5134,20 @@ }, "type": "object" }, + "Pipeline": { + "description": "A Firestore query represented as an ordered list of operations / stages.", + "id": "Pipeline", + "properties": { + "stages": { + "description": "Required. Ordered list of stages to evaluate.", + "items": { + "$ref": "Stage" + }, + "type": "array" + } + }, + "type": "object" + }, "PlanSummary": { "description": "Planning phase information for the query.", "id": "PlanSummary", @@ -5228,6 +5364,31 @@ }, "type": "object" }, + "Stage": { + "description": "A single operation within a pipeline. A stage is made up of a unique name, and a list of arguments. The exact number of arguments & types is dependent on the stage type. To give an example, the stage `filter(state = \"MD\")` would be encoded as: ``` name: \"filter\" args { function_value { name: \"eq\" args { field_reference_value: \"state\" } args { string_value: \"MD\" } } } ``` See public documentation for the full list.", + "id": "Stage", + "properties": { + "args": { + "description": "Optional. Ordered list of arguments the given stage expects.", + "items": { + "$ref": "Value" + }, + "type": "array" + }, + "name": { + "description": "Required. The name of the stage to evaluate. **Requires:** * must be in snake case (lower case with underscore separator).", + "type": "string" + }, + "options": { + "additionalProperties": { + "$ref": "Value" + }, + "description": "Optional. Optional named arguments that certain functions may support.", + "type": "object" + } + }, + "type": "object" + }, "Status": { "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", @@ -5273,6 +5434,24 @@ }, "type": "object" }, + "StructuredPipeline": { + "description": "A Firestore query represented as an ordered list of operations / stages. This is considered the top-level function which plans and executes a query. It is logically equivalent to `query(stages, options)`, but prevents the client from having to build a function wrapper.", + "id": "StructuredPipeline", + "properties": { + "options": { + "additionalProperties": { + "$ref": "Value" + }, + "description": "Optional. Optional query-level arguments. ", + "type": "object" + }, + "pipeline": { + "$ref": "Pipeline", + "description": "Required. The pipeline query to execute." + } + }, + "type": "object" + }, "StructuredQuery": { "description": "A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7. find_nearest", "id": "StructuredQuery", @@ -5487,6 +5666,14 @@ "format": "double", "type": "number" }, + "fieldReferenceValue": { + "description": "Value which references a field. This is considered relative (vs absolute) since it only refers to a field and not a field within a particular document. **Requires:** * Must follow field reference limitations. * Not allowed to be used when writing documents.", + "type": "string" + }, + "functionValue": { + "$ref": "Function", + "description": "A value that represents an unevaluated expression. **Requires:** * Not allowed to be used when writing documents." + }, "geoPointValue": { "$ref": "LatLng", "description": "A geo point value representing a point on the surface of Earth." @@ -5510,6 +5697,10 @@ ], "type": "string" }, + "pipelineValue": { + "$ref": "Pipeline", + "description": "A value that represents an unevaluated pipeline. **Requires:** * Not allowed to be used when writing documents." + }, "referenceValue": { "description": "A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.", "type": "string" diff --git a/discovery/firestore-v1beta1.json b/discovery/firestore-v1beta1.json index 5993a0da03a..c83368d1241 100644 --- a/discovery/firestore-v1beta1.json +++ b/discovery/firestore-v1beta1.json @@ -836,6 +836,35 @@ "https://www.googleapis.com/auth/datastore" ] }, + "executePipeline": { + "description": "Executes a pipeline query.", + "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:executePipeline", + "httpMethod": "POST", + "id": "firestore.projects.databases.documents.executePipeline", + "parameterOrder": [ + "database" + ], + "parameters": { + "database": { + "description": "Required. Database identifier, in the form `projects/{project}/databases/{database}`.", + "location": "path", + "pattern": "^projects/[^/]+/databases/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+database}/documents:executePipeline", + "request": { + "$ref": "ExecutePipelineRequest" + }, + "response": { + "$ref": "ExecutePipelineResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ] + }, "get": { "description": "Gets a single document.", "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}", @@ -1412,7 +1441,7 @@ } } }, - "revision": "20251014", + "revision": "20251216", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -1898,6 +1927,59 @@ "properties": {}, "type": "object" }, + "ExecutePipelineRequest": { + "description": "The request for Firestore.ExecutePipeline.", + "id": "ExecutePipelineRequest", + "properties": { + "newTransaction": { + "$ref": "TransactionOptions", + "description": "Execute the pipeline in a new transaction. The identifier of the newly created transaction will be returned in the first response on the stream. This defaults to a read-only transaction." + }, + "readTime": { + "description": "Execute the pipeline in a snapshot transaction at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.", + "format": "google-datetime", + "type": "string" + }, + "structuredPipeline": { + "$ref": "StructuredPipeline", + "description": "A pipelined operation." + }, + "transaction": { + "description": "Run the query within an already active transaction. The value here is the opaque transaction ID to execute the query in.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "ExecutePipelineResponse": { + "description": "The response for Firestore.Execute.", + "id": "ExecutePipelineResponse", + "properties": { + "executionTime": { + "description": "The time at which the results are valid. This is a (not strictly) monotonically increasing value across multiple responses in the same stream. The API guarantees that all previously returned results are still valid at the latest `execution_time`. This allows the API consumer to treat the query if it ran at the latest `execution_time` returned. If the query returns no results, a response with `execution_time` and no `results` will be sent, and this represents the time at which the operation was run.", + "format": "google-datetime", + "type": "string" + }, + "explainStats": { + "$ref": "ExplainStats", + "description": "Query explain stats. This is present on the **last** response if the request configured explain to run in 'analyze' or 'explain' mode in the pipeline options. If the query does not return any results, a response with `explain_stats` and no `results` will still be sent." + }, + "results": { + "description": "An ordered batch of results returned executing a pipeline. The batch size is variable, and can even be zero for when only a partial progress message is returned. The fields present in the returned documents are only those that were explicitly requested in the pipeline, this includes those like `__name__` and `__update_time__`. This is explicitly a divergence from `Firestore.RunQuery` / `Firestore.GetDocument` RPCs which always return such fields even when they are not specified in the `mask`.", + "items": { + "$ref": "Document" + }, + "type": "array" + }, + "transaction": { + "description": "Newly created transaction identifier. This field is only specified as part of the first response from the server, alongside the `results` field when the original request specified ExecuteRequest.new_transaction.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, "ExecutionStats": { "description": "Execution statistics for the query.", "id": "ExecutionStats", @@ -1975,6 +2057,21 @@ }, "type": "object" }, + "ExplainStats": { + "description": "Pipeline explain stats. Depending on the explain options in the original request, this can contain the optimized plan and / or execution stats.", + "id": "ExplainStats", + "properties": { + "data": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The format depends on the `output_format` options in the request. Currently there are two supported options: `TEXT` and `JSON`. Both supply a `google.protobuf.StringValue`.", + "type": "object" + } + }, + "type": "object" + }, "FieldFilter": { "description": "A filter on a specific field.", "id": "FieldFilter", @@ -2138,6 +2235,31 @@ }, "type": "object" }, + "Function": { + "description": "Represents an unevaluated scalar expression. For example, the expression `like(user_name, \"%alice%\")` is represented as: ``` name: \"like\" args { field_reference: \"user_name\" } args { string_value: \"%alice%\" } ```", + "id": "Function", + "properties": { + "args": { + "description": "Optional. Ordered list of arguments the given function expects.", + "items": { + "$ref": "Value" + }, + "type": "array" + }, + "name": { + "description": "Required. The name of the function to evaluate. **Requires:** * must be in snake case (lower case with underscore separator).", + "type": "string" + }, + "options": { + "additionalProperties": { + "$ref": "Value" + }, + "description": "Optional. Optional named arguments that certain functions may support.", + "type": "object" + } + }, + "type": "object" + }, "GoogleFirestoreAdminV1BulkDeleteDocumentsMetadata": { "description": "Metadata for google.longrunning.Operation results from FirestoreAdmin.BulkDeleteDocuments.", "id": "GoogleFirestoreAdminV1BulkDeleteDocumentsMetadata", @@ -2929,6 +3051,20 @@ }, "type": "object" }, + "Pipeline": { + "description": "A Firestore query represented as an ordered list of operations / stages.", + "id": "Pipeline", + "properties": { + "stages": { + "description": "Required. Ordered list of stages to evaluate.", + "items": { + "$ref": "Stage" + }, + "type": "array" + } + }, + "type": "object" + }, "PlanSummary": { "description": "Planning phase information for the query.", "id": "PlanSummary", @@ -3145,6 +3281,31 @@ }, "type": "object" }, + "Stage": { + "description": "A single operation within a pipeline. A stage is made up of a unique name, and a list of arguments. The exact number of arguments & types is dependent on the stage type. To give an example, the stage `filter(state = \"MD\")` would be encoded as: ``` name: \"filter\" args { function_value { name: \"eq\" args { field_reference_value: \"state\" } args { string_value: \"MD\" } } } ``` See public documentation for the full list.", + "id": "Stage", + "properties": { + "args": { + "description": "Optional. Ordered list of arguments the given stage expects.", + "items": { + "$ref": "Value" + }, + "type": "array" + }, + "name": { + "description": "Required. The name of the stage to evaluate. **Requires:** * must be in snake case (lower case with underscore separator).", + "type": "string" + }, + "options": { + "additionalProperties": { + "$ref": "Value" + }, + "description": "Optional. Optional named arguments that certain functions may support.", + "type": "object" + } + }, + "type": "object" + }, "Status": { "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", @@ -3190,6 +3351,24 @@ }, "type": "object" }, + "StructuredPipeline": { + "description": "A Firestore query represented as an ordered list of operations / stages. This is considered the top-level function which plans and executes a query. It is logically equivalent to `query(stages, options)`, but prevents the client from having to build a function wrapper.", + "id": "StructuredPipeline", + "properties": { + "options": { + "additionalProperties": { + "$ref": "Value" + }, + "description": "Optional. Optional query-level arguments. ", + "type": "object" + }, + "pipeline": { + "$ref": "Pipeline", + "description": "Required. The pipeline query to execute." + } + }, + "type": "object" + }, "StructuredQuery": { "description": "A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7. find_nearest", "id": "StructuredQuery", @@ -3404,6 +3583,14 @@ "format": "double", "type": "number" }, + "fieldReferenceValue": { + "description": "Value which references a field. This is considered relative (vs absolute) since it only refers to a field and not a field within a particular document. **Requires:** * Must follow field reference limitations. * Not allowed to be used when writing documents.", + "type": "string" + }, + "functionValue": { + "$ref": "Function", + "description": "A value that represents an unevaluated expression. **Requires:** * Not allowed to be used when writing documents." + }, "geoPointValue": { "$ref": "LatLng", "description": "A geo point value representing a point on the surface of Earth." @@ -3427,6 +3614,10 @@ ], "type": "string" }, + "pipelineValue": { + "$ref": "Pipeline", + "description": "A value that represents an unevaluated pipeline. **Requires:** * Not allowed to be used when writing documents." + }, "referenceValue": { "description": "A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.", "type": "string" diff --git a/discovery/healthcare-v1.json b/discovery/healthcare-v1.json index 14987a2ce0c..8d95d347b80 100644 --- a/discovery/healthcare-v1.json +++ b/discovery/healthcare-v1.json @@ -5142,7 +5142,7 @@ } } }, - "revision": "20251117", + "revision": "20251211", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -8977,6 +8977,10 @@ "description": "Optional. Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", "type": "boolean" }, + "enableFhirpathProfileValidation": { + "description": "Optional. Whether to enable FHIRPath validation for incoming resource types that have profiles configured for them in the `enabled_implementation_guides` list. Set this to true to enable checking incoming resources for conformance against FHIRPath requirements defined in the configured profiles.", + "type": "boolean" + }, "enabledImplementationGuides": { "description": "Optional. A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `[\"http://hl7.org/fhir/us/core/ImplementationGuide/ig\"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using \"value\" as the discriminator type - FHIRPath constraints (only when `enable_fhirpath_profile_validation` is true) When a URL cannot be resolved (for example, in a type assertion), the server does not return an error.", "items": { diff --git a/discovery/healthcare-v1beta1.json b/discovery/healthcare-v1beta1.json index 1dcc3a6ae5a..b4019576f14 100644 --- a/discovery/healthcare-v1beta1.json +++ b/discovery/healthcare-v1beta1.json @@ -5689,7 +5689,7 @@ } } }, - "revision": "20251117", + "revision": "20251211", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -10088,6 +10088,10 @@ "description": "Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", "type": "boolean" }, + "enableFhirpathProfileValidation": { + "description": "Optional. Whether to enable FHIRPath validation for incoming resource types that have profiles configured for them in the `enabled_implementation_guides` list. Set this to true to enable checking incoming resources for conformance against FHIRPath requirements defined in the configured profiles.", + "type": "boolean" + }, "enabledImplementationGuides": { "description": "A list of ImplementationGuide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `[\"http://hl7.org/fhir/us/core/ImplementationGuide/ig\"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using \"value\" as the discriminator type - FHIRPath constraints (only when `enable_fhirpath_profile_validation` is true) When a URL cannot be resolved (for example, in a type assertion), the server does not return an error.", "items": { diff --git a/discovery/networkconnectivity-v1.json b/discovery/networkconnectivity-v1.json index 0b64dbf6252..21461f7856e 100644 --- a/discovery/networkconnectivity-v1.json +++ b/discovery/networkconnectivity-v1.json @@ -3540,7 +3540,7 @@ } } }, - "revision": "20251113", + "revision": "20251209", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AcceptHubSpokeRequest": { @@ -3870,8 +3870,7 @@ "additionalProperties": { "type": "string" }, - "description": "Output only. A map to store mapping between customer vip and target service attachment. Only service attachment with producer specified ip addresses are stored here.", - "readOnly": true, + "description": "Optional. A map to store mapping between customer vip and target service attachment. This field can be used to specify a static IP address for a PSC connection.", "type": "object" }, "state": { diff --git a/discovery/pubsub-v1.json b/discovery/pubsub-v1.json index 5a7667918e7..db1f61f5990 100644 --- a/discovery/pubsub-v1.json +++ b/discovery/pubsub-v1.json @@ -84,6 +84,31 @@ "endpointUrl": "https://pubsub.australia-southeast2.rep.googleapis.com/", "location": "australia-southeast2" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.europe-central2.rep.googleapis.com/", + "location": "europe-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.europe-north1.rep.googleapis.com/", + "location": "europe-north1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.europe-north2.rep.googleapis.com/", + "location": "europe-north2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.europe-southwest1.rep.googleapis.com/", + "location": "europe-southwest1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.europe-west1.rep.googleapis.com/", + "location": "europe-west1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://pubsub.europe-west2.rep.googleapis.com/", @@ -94,6 +119,11 @@ "endpointUrl": "https://pubsub.europe-west3.rep.googleapis.com/", "location": "europe-west3" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.europe-west4.rep.googleapis.com/", + "location": "europe-west4" + }, { "description": "Regional Endpoint", "endpointUrl": "https://pubsub.europe-west6.rep.googleapis.com/", @@ -109,6 +139,16 @@ "endpointUrl": "https://pubsub.europe-west9.rep.googleapis.com/", "location": "europe-west9" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.europe-west10.rep.googleapis.com/", + "location": "europe-west10" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.europe-west12.rep.googleapis.com/", + "location": "europe-west12" + }, { "description": "Regional Endpoint", "endpointUrl": "https://pubsub.me-central1.rep.googleapis.com/", @@ -174,6 +214,11 @@ "endpointUrl": "https://pubsub.us-east5.rep.googleapis.com/", "location": "us-east5" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-east7.rep.googleapis.com/", + "location": "us-east7" + }, { "description": "Regional Endpoint", "endpointUrl": "https://pubsub.us-south1.rep.googleapis.com/", @@ -198,6 +243,11 @@ "description": "Regional Endpoint", "endpointUrl": "https://pubsub.us-west4.rep.googleapis.com/", "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-west8.rep.googleapis.com/", + "location": "us-west8" } ], "icons": { @@ -750,7 +800,7 @@ ], "parameters": { "name": { - "description": "Required. User-provided name for this snapshot. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription. Note that for REST API requests, you must specify a name. See the [resource name rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). Format is `projects/{project}/snapshots/{snap}`.", + "description": "Required. Identifier. User-provided name for this snapshot. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription. Note that for REST API requests, you must specify a name. See the [resource name rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). Format is `projects/{project}/snapshots/{snap}`.", "location": "path", "pattern": "^projects/[^/]+/snapshots/[^/]+$", "required": true, @@ -779,7 +829,7 @@ ], "parameters": { "snapshot": { - "description": "Required. The name of the snapshot to delete. Format is `projects/{project}/snapshots/{snap}`.", + "description": "Required. Identifier. The name of the snapshot to delete. Format is `projects/{project}/snapshots/{snap}`.", "location": "path", "pattern": "^projects/[^/]+/snapshots/[^/]+$", "required": true, @@ -805,7 +855,7 @@ ], "parameters": { "snapshot": { - "description": "Required. The name of the snapshot to get. Format is `projects/{project}/snapshots/{snap}`.", + "description": "Required. Identifier. The name of the snapshot to get. Format is `projects/{project}/snapshots/{snap}`.", "location": "path", "pattern": "^projects/[^/]+/snapshots/[^/]+$", "required": true, @@ -874,7 +924,7 @@ "type": "string" }, "project": { - "description": "Required. The name of the project in which to list snapshots. Format is `projects/{project-id}`.", + "description": "Required. Identifier. The name of the project in which to list snapshots. Format is `projects/{project-id}`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -1020,7 +1070,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the subscription. It must have the format `\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `\"goog\"`.", + "description": "Required. Identifier. The name of the subscription. It must have the format `\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `\"goog\"`.", "location": "path", "pattern": "^projects/[^/]+/subscriptions/[^/]+$", "required": true, @@ -1049,7 +1099,7 @@ ], "parameters": { "subscription": { - "description": "Required. The subscription to delete. Format is `projects/{project}/subscriptions/{sub}`.", + "description": "Required. Identifier. The subscription to delete. Format is `projects/{project}/subscriptions/{sub}`.", "location": "path", "pattern": "^projects/[^/]+/subscriptions/[^/]+$", "required": true, @@ -1101,7 +1151,7 @@ ], "parameters": { "subscription": { - "description": "Required. The name of the subscription to get. Format is `projects/{project}/subscriptions/{sub}`.", + "description": "Required. Identifier. The name of the subscription to get. Format is `projects/{project}/subscriptions/{sub}`.", "location": "path", "pattern": "^projects/[^/]+/subscriptions/[^/]+$", "required": true, @@ -1170,7 +1220,7 @@ "type": "string" }, "project": { - "description": "Required. The name of the project in which to list subscriptions. Format is `projects/{project-id}`.", + "description": "Required. Identifier. The name of the project in which to list subscriptions. Format is `projects/{project-id}`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -1254,7 +1304,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the subscription. It must have the format `\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `\"goog\"`.", + "description": "Required. Identifier. The name of the subscription. It must have the format `\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `\"goog\"`.", "location": "path", "pattern": "^projects/[^/]+/subscriptions/[^/]+$", "required": true, @@ -1403,7 +1453,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the topic. It must have the format `\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `\"goog\"`.", + "description": "Required. Identifier. The name of the topic. It must have the format `\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `\"goog\"`.", "location": "path", "pattern": "^projects/[^/]+/topics/[^/]+$", "required": true, @@ -1432,7 +1482,7 @@ ], "parameters": { "topic": { - "description": "Required. Name of the topic to delete. Format is `projects/{project}/topics/{topic}`.", + "description": "Required. Identifier. Name of the topic to delete. Format is `projects/{project}/topics/{topic}`.", "location": "path", "pattern": "^projects/[^/]+/topics/[^/]+$", "required": true, @@ -1458,7 +1508,7 @@ ], "parameters": { "topic": { - "description": "Required. The name of the topic to get. Format is `projects/{project}/topics/{topic}`.", + "description": "Required. Identifier. The name of the topic to get. Format is `projects/{project}/topics/{topic}`.", "location": "path", "pattern": "^projects/[^/]+/topics/[^/]+$", "required": true, @@ -1527,7 +1577,7 @@ "type": "string" }, "project": { - "description": "Required. The name of the project in which to list topics. Format is `projects/{project-id}`.", + "description": "Required. Identifier. The name of the project in which to list topics. Format is `projects/{project-id}`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -1553,7 +1603,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the topic. It must have the format `\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `\"goog\"`.", + "description": "Required. Identifier. The name of the topic. It must have the format `\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `\"goog\"`.", "location": "path", "pattern": "^projects/[^/]+/topics/[^/]+$", "required": true, @@ -1582,7 +1632,7 @@ ], "parameters": { "topic": { - "description": "Required. The messages in the request will be published on this topic. Format is `projects/{project}/topics/{topic}`.", + "description": "Required. Identifier. The messages in the request will be published on this topic. Format is `projects/{project}/topics/{topic}`.", "location": "path", "pattern": "^projects/[^/]+/topics/[^/]+$", "required": true, @@ -1748,7 +1798,7 @@ } } }, - "revision": "20251104", + "revision": "20251212", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { @@ -2220,7 +2270,7 @@ "type": "object" }, "subscription": { - "description": "Required. The subscription whose backlog the snapshot retains. Specifically, the created snapshot is guaranteed to retain: (a) The existing backlog on the subscription. More precisely, this is defined as the messages in the subscription's backlog that are unacknowledged upon the successful completion of the `CreateSnapshot` request; as well as: (b) Any messages published to the subscription's topic following the successful completion of the CreateSnapshot request. Format is `projects/{project}/subscriptions/{sub}`.", + "description": "Required. Identifier. The subscription whose backlog the snapshot retains. Specifically, the created snapshot is guaranteed to retain: (a) The existing backlog on the subscription. More precisely, this is defined as the messages in the subscription's backlog that are unacknowledged upon the successful completion of the `CreateSnapshot` request; as well as: (b) Any messages published to the subscription's topic following the successful completion of the CreateSnapshot request. Format is `projects/{project}/subscriptions/{sub}`.", "type": "string" }, "tags": { @@ -2993,7 +3043,7 @@ "type": "array" }, "name": { - "description": "Required. The name of the subscription. It must have the format `\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `\"goog\"`.", + "description": "Required. Identifier. The name of the subscription. It must have the format `\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `\"goog\"`.", "type": "string" }, "pushConfig": { @@ -3031,7 +3081,7 @@ "type": "object" }, "topic": { - "description": "Required. The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. The value of this field will be `_deleted-topic_` if the topic has been deleted.", + "description": "Required. Identifier. The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. The value of this field will be `_deleted-topic_` if the topic has been deleted.", "type": "string" }, "topicMessageRetentionDuration": { @@ -3124,7 +3174,7 @@ "type": "array" }, "name": { - "description": "Required. The name of the topic. It must have the format `\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `\"goog\"`.", + "description": "Required. Identifier. The name of the topic. It must have the format `\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `\"goog\"`.", "type": "string" }, "satisfiesPzs": { diff --git a/discovery/pubsub-v1beta1a.json b/discovery/pubsub-v1beta1a.json index 9955571fec9..1c77e8f53ea 100644 --- a/discovery/pubsub-v1beta1a.json +++ b/discovery/pubsub-v1beta1a.json @@ -84,6 +84,31 @@ "endpointUrl": "https://pubsub.australia-southeast2.rep.googleapis.com/", "location": "australia-southeast2" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.europe-central2.rep.googleapis.com/", + "location": "europe-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.europe-north1.rep.googleapis.com/", + "location": "europe-north1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.europe-north2.rep.googleapis.com/", + "location": "europe-north2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.europe-southwest1.rep.googleapis.com/", + "location": "europe-southwest1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.europe-west1.rep.googleapis.com/", + "location": "europe-west1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://pubsub.europe-west2.rep.googleapis.com/", @@ -94,6 +119,11 @@ "endpointUrl": "https://pubsub.europe-west3.rep.googleapis.com/", "location": "europe-west3" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.europe-west4.rep.googleapis.com/", + "location": "europe-west4" + }, { "description": "Regional Endpoint", "endpointUrl": "https://pubsub.europe-west6.rep.googleapis.com/", @@ -109,6 +139,16 @@ "endpointUrl": "https://pubsub.europe-west9.rep.googleapis.com/", "location": "europe-west9" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.europe-west10.rep.googleapis.com/", + "location": "europe-west10" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.europe-west12.rep.googleapis.com/", + "location": "europe-west12" + }, { "description": "Regional Endpoint", "endpointUrl": "https://pubsub.me-central1.rep.googleapis.com/", @@ -174,6 +214,11 @@ "endpointUrl": "https://pubsub.us-east5.rep.googleapis.com/", "location": "us-east5" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-east7.rep.googleapis.com/", + "location": "us-east7" + }, { "description": "Regional Endpoint", "endpointUrl": "https://pubsub.us-south1.rep.googleapis.com/", @@ -198,6 +243,11 @@ "description": "Regional Endpoint", "endpointUrl": "https://pubsub.us-west4.rep.googleapis.com/", "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-west8.rep.googleapis.com/", + "location": "us-west8" } ], "icons": { @@ -639,7 +689,7 @@ } } }, - "revision": "20251104", + "revision": "20251212", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { diff --git a/discovery/pubsub-v1beta2.json b/discovery/pubsub-v1beta2.json index a1879675f67..6f5879de1d7 100644 --- a/discovery/pubsub-v1beta2.json +++ b/discovery/pubsub-v1beta2.json @@ -84,6 +84,31 @@ "endpointUrl": "https://pubsub.australia-southeast2.rep.googleapis.com/", "location": "australia-southeast2" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.europe-central2.rep.googleapis.com/", + "location": "europe-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.europe-north1.rep.googleapis.com/", + "location": "europe-north1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.europe-north2.rep.googleapis.com/", + "location": "europe-north2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.europe-southwest1.rep.googleapis.com/", + "location": "europe-southwest1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.europe-west1.rep.googleapis.com/", + "location": "europe-west1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://pubsub.europe-west2.rep.googleapis.com/", @@ -94,6 +119,11 @@ "endpointUrl": "https://pubsub.europe-west3.rep.googleapis.com/", "location": "europe-west3" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.europe-west4.rep.googleapis.com/", + "location": "europe-west4" + }, { "description": "Regional Endpoint", "endpointUrl": "https://pubsub.europe-west6.rep.googleapis.com/", @@ -109,6 +139,16 @@ "endpointUrl": "https://pubsub.europe-west9.rep.googleapis.com/", "location": "europe-west9" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.europe-west10.rep.googleapis.com/", + "location": "europe-west10" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.europe-west12.rep.googleapis.com/", + "location": "europe-west12" + }, { "description": "Regional Endpoint", "endpointUrl": "https://pubsub.me-central1.rep.googleapis.com/", @@ -174,6 +214,11 @@ "endpointUrl": "https://pubsub.us-east5.rep.googleapis.com/", "location": "us-east5" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-east7.rep.googleapis.com/", + "location": "us-east7" + }, { "description": "Regional Endpoint", "endpointUrl": "https://pubsub.us-south1.rep.googleapis.com/", @@ -198,6 +243,11 @@ "description": "Regional Endpoint", "endpointUrl": "https://pubsub.us-west4.rep.googleapis.com/", "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-west8.rep.googleapis.com/", + "location": "us-west8" } ], "icons": { @@ -906,7 +956,7 @@ } } }, - "revision": "20251104", + "revision": "20251212", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { diff --git a/discovery/safebrowsing-v5.json b/discovery/safebrowsing-v5.json index 2de53c5ad43..6bc077afc88 100644 --- a/discovery/safebrowsing-v5.json +++ b/discovery/safebrowsing-v5.json @@ -99,7 +99,7 @@ "hashList": { "methods": { "get": { - "description": "Get the latest contents of a hash list. A hash list may either by a threat list or a non-threat list such as the Global Cache. This is a standard Get method as defined by https://google.aip.dev/131 and the HTTP method is also GET.", + "description": "Gets the latest contents of a hash list. A hash list may either by a threat list or a non-threat list such as the Global Cache. This is a standard Get method as defined by https://google.aip.dev/131 and the HTTP method is also GET.", "flatPath": "v5/hashList/{name}", "httpMethod": "GET", "id": "safebrowsing.hashList.get", @@ -142,7 +142,7 @@ "hashLists": { "methods": { "batchGet": { - "description": "Get multiple hash lists at once. It is very common for a client to need to get multiple hash lists. Using this method is preferred over using the regular Get method multiple times. This is a standard batch Get method as defined by https://google.aip.dev/231 and the HTTP method is also GET.", + "description": "Gets multiple hash lists at once. It is very common for a client to need to get multiple hash lists. Using this method is preferred over using the regular Get method multiple times. This is a standard batch Get method as defined by https://google.aip.dev/231 and the HTTP method is also GET.", "flatPath": "v5/hashLists:batchGet", "httpMethod": "GET", "id": "safebrowsing.hashLists.batchGet", @@ -180,7 +180,7 @@ } }, "list": { - "description": "List hash lists. In the V5 API, Google will never remove a hash list that has ever been returned by this method. This enables clients to skip using this method and simply hard-code all hash lists they need. This is a standard List method as defined by https://google.aip.dev/132 and the HTTP method is GET.", + "description": "Lists hash lists. In the V5 API, Google will never remove a hash list that has ever been returned by this method. This enables clients to skip using this method and simply hard-code all hash lists they need. This is a standard List method as defined by https://google.aip.dev/132 and the HTTP method is GET.", "flatPath": "v5/hashLists", "httpMethod": "GET", "id": "safebrowsing.hashLists.list", @@ -208,7 +208,7 @@ "hashes": { "methods": { "search": { - "description": "Search for full hashes matching the specified prefixes. This is a custom method as defined by https://google.aip.dev/136 (the custom method refers to this method having a custom name within Google's general API development nomenclature; it does not refer to using a custom HTTP method).", + "description": "Searches for full hashes matching the specified prefixes. This is a custom method as defined by https://google.aip.dev/136 (the custom method refers to this method having a custom name within Google's general API development nomenclature; it does not refer to using a custom HTTP method).", "flatPath": "v5/hashes:search", "httpMethod": "GET", "id": "safebrowsing.hashes.search", @@ -228,9 +228,32 @@ } } } + }, + "urls": { + "methods": { + "search": { + "description": "Searches for URLs matching known threats. Each URL and it's host-suffix and path-prefix expressions (up to a limited depth) are checked. This means that the response may contain URLs that were not included in the request, but are expressions of the requested URLs.", + "flatPath": "v5/urls:search", + "httpMethod": "GET", + "id": "safebrowsing.urls.search", + "parameterOrder": [], + "parameters": { + "urls": { + "description": "Required. The URLs to be looked up. Clients MUST NOT send more than 50 URLs.", + "location": "query", + "repeated": true, + "type": "string" + } + }, + "path": "v5/urls:search", + "response": { + "$ref": "GoogleSecuritySafebrowsingV5SearchUrlsResponse" + } + } + } } }, - "revision": "20250518", + "revision": "20251214", "rootUrl": "https://safebrowsing.googleapis.com/", "schemas": { "GoogleSecuritySafebrowsingV5BatchGetHashListsResponse": { @@ -595,6 +618,57 @@ } }, "type": "object" + }, + "GoogleSecuritySafebrowsingV5SearchUrlsResponse": { + "description": "The response returned after searching threats matching the specified URLs. If nothing is found, the server will return an OK status (HTTP status code 200) with the `threats` field empty, rather than returning a NOT_FOUND status (HTTP status code 404).", + "id": "GoogleSecuritySafebrowsingV5SearchUrlsResponse", + "properties": { + "cacheDuration": { + "description": "The client-side cache duration. The client MUST add this duration to the current time to determine the expiration time. The expiration time then applies to every URL queried by the client in the request, regardless of how many URLs are returned in the response. Even if the server returns no matches for a particular URL, this fact MUST also be cached by the client. If and only if the field `threats` is empty, the client MAY increase the `cache_duration` to determine a new expiration that is later than that specified by the server. In any case, the increased cache duration must not be longer than 24 hours. Important: the client MUST NOT assume that the server will return the same cache duration for all responses. The server MAY choose different cache durations for different responses depending on the situation.", + "format": "google-duration", + "type": "string" + }, + "threats": { + "description": "Unordered list. The unordered list of threat matches found. Each entry contains a URL and the threat types that were found matching that URL. The list size can be greater than the number of URLs in the request as the all expressions of the URL would've been considered.", + "items": { + "$ref": "GoogleSecuritySafebrowsingV5ThreatUrl" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleSecuritySafebrowsingV5ThreatUrl": { + "description": "A URL matching one or more threats.", + "id": "GoogleSecuritySafebrowsingV5ThreatUrl", + "properties": { + "threatTypes": { + "description": "Unordered list. The unordered list of threat that the URL is classified as.", + "items": { + "enum": [ + "THREAT_TYPE_UNSPECIFIED", + "MALWARE", + "SOCIAL_ENGINEERING", + "UNWANTED_SOFTWARE", + "POTENTIALLY_HARMFUL_APPLICATION" + ], + "enumDescriptions": [ + "Unknown threat type. If this is returned by the server, the client shall disregard the enclosing `FullHashDetail` altogether.", + "Malware threat type. Malware is any software or mobile application specifically designed to harm a computer, a mobile device, the software it's running, or its users. Malware exhibits malicious behavior that can include installing software without user consent and installing harmful software such as viruses. More information can be found [here](https://developers.google.com/search/docs/monitor-debug/security/malware).", + "Social engineering threat type. Social engineering pages falsely purport to act on behalf of a third party with the intention of confusing viewers into performing an action with which the viewer would only trust a true agent of that third party. Phishing is a type of social engineering that tricks the viewer into performing the specific action of providing information, such as login credentials. More information can be found [here](https://developers.google.com/search/docs/monitor-debug/security/social-engineering).", + "Unwanted software threat type. Unwanted software is any software that does not adhere to [Google's Software Principles](https://www.google.com/about/software-principles.html) but isn't malware.", + "Potentially harmful application threat type [as used by Google Play Protect for the Play Store](https://developers.google.com/android/play-protect/potentially-harmful-applications)." + ], + "type": "string" + }, + "type": "array" + }, + "url": { + "description": "The requested URL that was matched by one or more threats.", + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/spanner-v1.json b/discovery/spanner-v1.json index 2daa01fe400..091e0d6a6ff 100644 --- a/discovery/spanner-v1.json +++ b/discovery/spanner-v1.json @@ -9,7 +9,7 @@ "description": "Administer your Spanner databases" }, "https://www.googleapis.com/auth/spanner.data": { - "description": "View and manage the contents of your Spanner databases" + "description": "See, edit, configure, and delete your Google Cloud Spanner data and see the email address for your Google Account" } } } @@ -505,7 +505,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -636,7 +636,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -1410,7 +1410,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -2345,7 +2345,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -3223,7 +3223,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -3354,7 +3354,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -3436,9 +3436,31 @@ } } }, - "revision": "20251121", + "revision": "20251205", "rootUrl": "https://spanner.googleapis.com/", "schemas": { + "Ack": { + "description": "Arguments to ack operations.", + "id": "Ack", + "properties": { + "ignoreNotFound": { + "description": "By default, an attempt to ack a message that does not exist will fail with a `NOT_FOUND` error. With `ignore_not_found` set to true, the ack will succeed even if the message does not exist. This is useful for unconditionally acking a message, even if it is missing or has already been acked.", + "type": "boolean" + }, + "key": { + "description": "Required. The primary key of the message to be acked.", + "items": { + "type": "any" + }, + "type": "array" + }, + "queue": { + "description": "Required. The queue where the message to be acked is stored.", + "type": "string" + } + }, + "type": "object" + }, "AdaptMessageRequest": { "description": "Message sent by the client to the adapter.", "id": "AdaptMessageRequest", @@ -4047,12 +4069,6 @@ }, "type": "object" }, - "ClientContext": { - "description": "Container for various pieces of client-owned context attached to a request.", - "id": "ClientContext", - "properties": {}, - "type": "object" - }, "ColumnMetadata": { "description": "Metadata for a column.", "id": "ColumnMetadata", @@ -4154,6 +4170,29 @@ }, "type": "object" }, + "CompactDatabaseMetadata": { + "description": "Metadata type for the long-running operation returned by `CALL compact_all()`, which can be executed using ExecuteSql or ExecuteStreamingSql APIs.", + "id": "CompactDatabaseMetadata", + "properties": { + "cancelTime": { + "description": "Output only. The time at which cancellation of this operation was received. Operations.CancelOperation starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "database": { + "description": "Output only. The database being compacted.", + "readOnly": true, + "type": "string" + }, + "progress": { + "$ref": "OperationProgress", + "description": "Output only. The progress of the compaction operation.", + "readOnly": true + } + }, + "type": "object" + }, "ContextValue": { "description": "A message representing context for a KeyRangeInfo, including a label, value, unit, and severity.", "id": "ContextValue", @@ -6065,7 +6104,7 @@ "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.", + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, @@ -6338,6 +6377,10 @@ "description": "A modification to one or more Cloud Spanner rows. Mutations can be applied to a Cloud Spanner database by sending them in a Commit call.", "id": "Mutation", "properties": { + "ack": { + "$ref": "Ack", + "description": "Ack a message from a queue." + }, "delete": { "$ref": "Delete", "description": "Delete rows from a table. Succeeds whether or not the named rows were present." @@ -6354,6 +6397,10 @@ "$ref": "Write", "description": "Like insert, except that if the row already exists, it is deleted, and the column values provided are inserted instead. Unlike insert_or_update, this means any values not explicitly written become `NULL`. In an interleaved table, if you create the child table with the `ON DELETE CASCADE` annotation, then replacing a parent row also deletes the child rows. Otherwise, you must delete the child rows before you replace the parent row." }, + "send": { + "$ref": "Send", + "description": "Send a message to a queue." + }, "update": { "$ref": "Write", "description": "Update existing rows in a table. If any of the rows does not already exist, the transaction fails with error `NOT_FOUND`." @@ -7121,10 +7168,6 @@ "description": "Common request options for various APIs.", "id": "RequestOptions", "properties": { - "clientContext": { - "$ref": "ClientContext", - "description": "Optional. Optional context that may be needed for some requests." - }, "priority": { "description": "Priority for the request.", "enum": [ @@ -7412,6 +7455,33 @@ }, "type": "object" }, + "Send": { + "description": "Arguments to send operations.", + "id": "Send", + "properties": { + "deliverTime": { + "description": "The time at which Spanner will begin attempting to deliver the message. If `deliver_time` is not set, Spanner will deliver the message immediately. If `deliver_time` is in the past, Spanner will replace it with a value closer to the current time.", + "format": "google-datetime", + "type": "string" + }, + "key": { + "description": "Required. The primary key of the message to be sent.", + "items": { + "type": "any" + }, + "type": "array" + }, + "payload": { + "description": "The payload of the message.", + "type": "any" + }, + "queue": { + "description": "Required. The queue to which the message will be sent.", + "type": "string" + } + }, + "type": "object" + }, "Session": { "description": "A session in the Cloud Spanner API.", "id": "Session", diff --git a/discovery/workspaceevents-v1.json b/discovery/workspaceevents-v1.json index f4c4fb857af..2a9891ca157 100644 --- a/discovery/workspaceevents-v1.json +++ b/discovery/workspaceevents-v1.json @@ -558,6 +558,11 @@ "pattern": "^tasks/[^/]+$", "required": true, "type": "string" + }, + "tenant": { + "description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.", + "location": "query", + "type": "string" } }, "path": "v1/{+name}", @@ -580,6 +585,11 @@ "pattern": "^tasks/[^/]+$", "required": true, "type": "string" + }, + "tenant": { + "description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.", + "location": "query", + "type": "string" } }, "path": "v1/{+name}:subscribe", @@ -611,6 +621,11 @@ "pattern": "^tasks/[^/]+/pushNotificationConfigs$", "required": true, "type": "string" + }, + "tenant": { + "description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.", + "location": "query", + "type": "string" } }, "path": "v1/{+parent}", @@ -636,6 +651,11 @@ "pattern": "^tasks/[^/]+/pushNotificationConfigs/[^/]+$", "required": true, "type": "string" + }, + "tenant": { + "description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.", + "location": "query", + "type": "string" } }, "path": "v1/{+name}", @@ -658,6 +678,11 @@ "pattern": "^tasks/[^/]+/pushNotificationConfigs/[^/]+$", "required": true, "type": "string" + }, + "tenant": { + "description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.", + "location": "query", + "type": "string" } }, "path": "v1/{+name}", @@ -691,6 +716,11 @@ "pattern": "^tasks/[^/]+$", "required": true, "type": "string" + }, + "tenant": { + "description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.", + "location": "query", + "type": "string" } }, "path": "v1/{+parent}/pushNotificationConfigs", @@ -703,7 +733,7 @@ } } }, - "revision": "20251118", + "revision": "20251216", "rootUrl": "https://workspaceevents.googleapis.com/", "schemas": { "Artifact": { @@ -767,7 +797,12 @@ }, "CancelTaskRequest": { "id": "CancelTaskRequest", - "properties": {}, + "properties": { + "tenant": { + "description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.", + "type": "string" + } + }, "type": "object" }, "DataPart": { @@ -1061,6 +1096,10 @@ }, "description": "Optional metadata for the request.", "type": "object" + }, + "tenant": { + "description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.", + "type": "string" } }, "type": "object" diff --git a/discovery/youtube-v3.json b/discovery/youtube-v3.json index 8c0fef3a0af..eb35dbd4d14 100644 --- a/discovery/youtube-v3.json +++ b/discovery/youtube-v3.json @@ -4176,6 +4176,12 @@ "id": "youtube.youtube.v3.videos.batchGetStats", "parameterOrder": [], "parameters": { + "id": { + "description": "Required. Return videos with the given ids.", + "location": "query", + "repeated": true, + "type": "string" + }, "onBehalfOfContentOwner": { "description": "Optional. **Note:** This parameter is intended exclusively for YouTube content partners. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.", "location": "query", @@ -4186,12 +4192,6 @@ "location": "query", "repeated": true, "type": "string" - }, - "videoIds": { - "description": "Required. Return videos with the given ids.", - "location": "query", - "repeated": true, - "type": "string" } }, "path": "youtube/v3/videos:batchGetStats", @@ -4206,7 +4206,7 @@ } } }, - "revision": "20251125", + "revision": "20251217", "rootUrl": "https://youtube.googleapis.com/", "schemas": { "AbuseReport": { @@ -12142,13 +12142,13 @@ "readOnly": true, "type": "string" }, - "kind": { - "description": "Output only. Identifies what kind of resource this is. Value: the fixed string \"youtube#videoStats\".", + "id": { + "description": "Output only. The ID that YouTube uses to uniquely identify the video.", "readOnly": true, "type": "string" }, - "name": { - "description": "Output only. Identifier. The resource name for the `VideoStats` resource, in the format `videoStats/{video_stat}`.", + "kind": { + "description": "Output only. Identifies what kind of resource this is. Value: the fixed string \"youtube#videoStats\".", "readOnly": true, "type": "string" }, @@ -12161,11 +12161,6 @@ "$ref": "VideoStatsStatistics", "description": "Output only. The VideoStatsStatistics object contains statistics about the video.", "readOnly": true - }, - "videoId": { - "description": "Output only. The ID that YouTube uses to uniquely identify the video.", - "readOnly": true, - "type": "string" } }, "type": "object" diff --git a/src/apis/aiplatform/v1.ts b/src/apis/aiplatform/v1.ts index 243f414c519..c4b77b87460 100644 --- a/src/apis/aiplatform/v1.ts +++ b/src/apis/aiplatform/v1.ts @@ -1808,6 +1808,23 @@ export namespace aiplatform_v1 { */ shouldStop?: boolean | null; } + /** + * Container for bytes-encoded data such as video frame, audio sample, or a complete binary/text data. + */ + export interface Schema$GoogleCloudAiplatformV1Chunk { + /** + * Required. The data in the chunk. + */ + data?: string | null; + /** + * Optional. Metadata that is associated with the data in the payload. + */ + metadata?: Schema$GoogleCloudAiplatformV1Metadata; + /** + * Required. Mime type of the chunk data. See https://www.iana.org/assignments/media-types/media-types.xhtml for the full list. + */ + mimeType?: string | null; + } /** * A citation for a piece of generatedcontent. */ @@ -3850,11 +3867,11 @@ export namespace aiplatform_v1 { values?: number[] | null; } /** - * Represents a customer-managed encryption key spec that can be applied to a top-level resource. + * Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. */ export interface Schema$GoogleCloudAiplatformV1EncryptionSpec { /** - * Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created. + * Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project\}/locations/{location\}/keyRings/{key_ring\}/cryptoKeys/{crypto_key\}`. */ kmsKeyName?: string | null; } @@ -5257,6 +5274,42 @@ export namespace aiplatform_v1 { */ language?: string | null; } + /** + * Request message for SandboxEnvironmentExecutionService.ExecuteCode. + */ + export interface Schema$GoogleCloudAiplatformV1ExecuteCodeRequest { + /** + * Required. The inputs used for the stateless code execution. + */ + inputs?: Schema$GoogleCloudAiplatformV1Chunk[]; + } + /** + * Response message for SandboxEnvironmentExecutionService.ExecuteCode. + */ + export interface Schema$GoogleCloudAiplatformV1ExecuteCodeResponse { + /** + * The outputs from the sandbox environment. + */ + outputs?: Schema$GoogleCloudAiplatformV1Chunk[]; + } + /** + * Request message for SandboxEnvironmentExecutionService.Execute. + */ + export interface Schema$GoogleCloudAiplatformV1ExecuteSandboxEnvironmentRequest { + /** + * Required. The inputs to the sandbox environment. + */ + inputs?: Schema$GoogleCloudAiplatformV1Chunk[]; + } + /** + * Response message for SandboxEnvironmentExecutionService.Execute. + */ + export interface Schema$GoogleCloudAiplatformV1ExecuteSandboxEnvironmentResponse { + /** + * The outputs from the sandbox environment. + */ + outputs?: Schema$GoogleCloudAiplatformV1Chunk[]; + } /** * Instance of a general execution. */ @@ -7535,6 +7588,16 @@ export namespace aiplatform_v1 { * Optional. If true, no revisions will be created for this request. */ disableMemoryRevisions?: boolean | null; + /** + * Optional. User-provided metadata for the generated memories. This is not generated by Memory Bank. + */ + metadata?: { + [key: string]: Schema$GoogleCloudAiplatformV1MemoryMetadataValue; + } | null; + /** + * Optional. The strategy to use when applying metadata to existing memories. + */ + metadataMergeStrategy?: string | null; /** * Optional. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. */ @@ -9501,6 +9564,19 @@ export namespace aiplatform_v1 { */ reasoningEngines?: Schema$GoogleCloudAiplatformV1ReasoningEngine[]; } + /** + * Response message for SandboxEnvironmentService.ListSandboxEnvironments. + */ + export interface Schema$GoogleCloudAiplatformV1ListSandboxEnvironmentsResponse { + /** + * A token, which can be sent as ListSandboxEnvironmentsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * The SandboxEnvironments matching the request. + */ + sandboxEnvironments?: Schema$GoogleCloudAiplatformV1SandboxEnvironment[]; + } /** * Response message for DatasetService.ListSavedQueries. */ @@ -9855,6 +9931,12 @@ export namespace aiplatform_v1 { * Required. Semantic knowledge extracted from the source content. */ fact?: string | null; + /** + * Optional. User-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank. + */ + metadata?: { + [key: string]: Schema$GoogleCloudAiplatformV1MemoryMetadataValue; + } | null; /** * Identifier. The resource name of the Memory. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}` */ @@ -9988,6 +10070,57 @@ export namespace aiplatform_v1 { */ managedTopicEnum?: string | null; } + /** + * A conjunction of filters that will be combined using AND logic. + */ + export interface Schema$GoogleCloudAiplatformV1MemoryConjunctionFilter { + /** + * Filters that will combined using AND logic. + */ + filters?: Schema$GoogleCloudAiplatformV1MemoryFilter[]; + } + /** + * Filter to apply when retrieving memories. + */ + export interface Schema$GoogleCloudAiplatformV1MemoryFilter { + /** + * Key of the filter. For example, "author" would apply to `metadata` entries with the key "author". + */ + key?: string | null; + /** + * If true, the filter will be negated. + */ + negate?: boolean | null; + /** + * Operator to apply to the filter. If not set, then EQUAL will be used. + */ + op?: string | null; + /** + * Value to compare to. + */ + value?: Schema$GoogleCloudAiplatformV1MemoryMetadataValue; + } + /** + * Memory metadata. + */ + export interface Schema$GoogleCloudAiplatformV1MemoryMetadataValue { + /** + * Boolean value. + */ + boolValue?: boolean | null; + /** + * Double value. + */ + doubleValue?: number | null; + /** + * String value. + */ + stringValue?: string | null; + /** + * Timestamp value. When filtering on timestamp values, only the seconds field will be compared. + */ + timestampValue?: string | null; + } /** * A revision of a Memory. */ @@ -10039,6 +10172,15 @@ export namespace aiplatform_v1 { */ versionAliases?: string[] | null; } + /** + * Metadata for a chunk. + */ + export interface Schema$GoogleCloudAiplatformV1Metadata { + /** + * Optional. Attributes attached to the data. The keys have semantic conventions and the consumers of the attributes should know how to deserialize the value bytes based on the keys. + */ + attributes?: {[key: string]: string} | null; + } /** * Instance of a general MetadataSchema. */ @@ -15176,11 +15318,11 @@ export namespace aiplatform_v1 { */ export interface Schema$GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecPythonSpec { /** - * Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root. + * 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. This field should not be set if the source is `agent_config_source`. */ entrypointModule?: string | null; /** - * Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent". + * Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent". This field should not be set if the source is `agent_config_source`. */ entrypointObject?: string | null; /** @@ -15480,6 +15622,10 @@ export namespace aiplatform_v1 { * Optional. The standard list filter that will be applied to the retrieved memories. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `fact` * `create_time` * `update_time` * `topics` (i.e. `topics.custom_memory_topic_label: "example topic" OR topics.managed_memory_topic: USER_PREFERENCES`) */ filter?: string | null; + /** + * Optional. Metadata filters that will be applied to the retrieved memories' `metadata` using OR logic. Filters are defined using disjunctive normal form (OR of ANDs). For example: `filter_groups: [{filters: [{key: "author", value: {string_value: "agent 123"\}, op: EQUAL\}]\}, {filters: [{key: "label", value: {string_value: "travel"\}, op: EQUAL\}, {key: "author", value: {string_value: "agent 321"\}, op: EQUAL\}]\}]` would be equivalent to the logical expression: `(metadata.author = "agent 123" OR (metadata.label = "travel" AND metadata.author = "agent 321"))`. + */ + filterGroups?: Schema$GoogleCloudAiplatformV1MemoryConjunctionFilter[]; /** * Required. The scope of the memories to retrieve. A memory must have exactly the same scope (`Memory.scope`) as the scope provided here to be retrieved (same keys and values). Order does not matter, but it is case-sensitive. */ @@ -15903,6 +16049,86 @@ export namespace aiplatform_v1 { */ sampleRate?: number | null; } + /** + * SandboxEnvironment is a containerized environment that provides a customizable secure execution runtime for AI agents. + */ + export interface Schema$GoogleCloudAiplatformV1SandboxEnvironment { + /** + * Output only. The connection information of the SandboxEnvironment. + */ + connectionInfo?: Schema$GoogleCloudAiplatformV1SandboxEnvironmentConnectionInfo; + /** + * Output only. The timestamp when this SandboxEnvironment was created. + */ + createTime?: string | null; + /** + * Required. The display name of the SandboxEnvironment. + */ + displayName?: string | null; + /** + * Optional. Timestamp in UTC of when this SandboxEnvironment is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input. + */ + expireTime?: string | null; + /** + * Identifier. The name of the SandboxEnvironment. + */ + name?: string | null; + /** + * Optional. The configuration of the SandboxEnvironment. + */ + spec?: Schema$GoogleCloudAiplatformV1SandboxEnvironmentSpec; + /** + * Output only. The runtime state of the SandboxEnvironment. + */ + state?: string | null; + /** + * Optional. Input only. The TTL for the sandbox environment. The expiration time is computed: now + TTL. + */ + ttl?: string | null; + /** + * Output only. The timestamp when this SandboxEnvironment was most recently updated. + */ + updateTime?: string | null; + } + /** + * The connection information of the SandboxEnvironment. + */ + export interface Schema$GoogleCloudAiplatformV1SandboxEnvironmentConnectionInfo { + /** + * Output only. The hostname of the load balancer. + */ + loadBalancerHostname?: string | null; + /** + * Output only. The IP address of the load balancer. + */ + loadBalancerIp?: string | null; + /** + * Output only. The internal IP address of the SandboxEnvironment. + */ + sandboxInternalIp?: string | null; + } + /** + * The specification of a SandboxEnvironment. + */ + export interface Schema$GoogleCloudAiplatformV1SandboxEnvironmentSpec { + /** + * Optional. The code execution environment. + */ + codeExecutionEnvironment?: Schema$GoogleCloudAiplatformV1SandboxEnvironmentSpecCodeExecutionEnvironment; + } + /** + * The code execution environment with customized settings. + */ + export interface Schema$GoogleCloudAiplatformV1SandboxEnvironmentSpecCodeExecutionEnvironment { + /** + * The coding language supported in this environment. + */ + codeLanguage?: string | null; + /** + * The machine config of the code execution environment. + */ + machineConfig?: string | null; + } /** * A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters. */ @@ -16077,107 +16303,107 @@ export namespace aiplatform_v1 { timeout?: string | null; } /** - * Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. + * Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). */ export interface Schema$GoogleCloudAiplatformV1Schema { /** - * Optional. Can either be a boolean or an object; controls the presence of additional properties. + * Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. */ additionalProperties?: any | null; /** - * Optional. The value should be validated against any (one or more) of the subschemas in the list. + * Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. */ anyOf?: Schema$GoogleCloudAiplatformV1Schema[]; /** - * Optional. Default value of the data. + * Optional. Default value to use if the field is not specified. */ default?: any | null; /** - * Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + * Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. */ defs?: {[key: string]: Schema$GoogleCloudAiplatformV1Schema} | null; /** - * Optional. The description of the data. + * Optional. Description of the schema. */ description?: string | null; /** - * Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]\} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]\} + * Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]\}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]\}` */ enum?: string[] | null; /** - * Optional. Example of the object. Will only populated when the object is the root. + * Optional. Example of an instance of this schema. */ example?: any | null; /** - * Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + * Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. */ format?: string | null; /** - * Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + * Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. */ items?: Schema$GoogleCloudAiplatformV1Schema; /** - * Optional. Maximum value of the Type.INTEGER and Type.NUMBER + * Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. */ maximum?: number | null; /** - * Optional. Maximum number of the elements for Type.ARRAY. + * Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. */ maxItems?: string | null; /** - * Optional. Maximum length of the Type.STRING + * Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. */ maxLength?: string | null; /** - * Optional. Maximum number of the properties for Type.OBJECT. + * Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. */ maxProperties?: string | null; /** - * Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + * Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. */ minimum?: number | null; /** - * Optional. Minimum number of the elements for Type.ARRAY. + * Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. */ minItems?: string | null; /** - * Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + * Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. */ minLength?: string | null; /** - * Optional. Minimum number of the properties for Type.OBJECT. + * Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. */ minProperties?: string | null; /** - * Optional. Indicates if the value may be null. + * Optional. Indicates if the value of this field can be null. */ nullable?: boolean | null; /** - * Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + * Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. */ pattern?: string | null; /** - * Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + * Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. */ properties?: {[key: string]: Schema$GoogleCloudAiplatformV1Schema} | null; /** - * Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + * Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. */ propertyOrdering?: string[] | null; /** - * Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + * Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring */ ref?: string | null; /** - * Optional. Required properties of Type.OBJECT. + * Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. */ required?: string[] | null; /** - * Optional. The title of the Schema. + * Optional. Title for the schema. */ title?: string | null; /** - * Optional. The type of the data. + * Optional. Data type of the schema field. */ type?: string | null; } @@ -17521,6 +17747,10 @@ export namespace aiplatform_v1 { * Serialized state of the code repository. This string will typically contain a JSON representation of the UI's CodeRepositoryService state (files, folders, content, and any metadata). The UI is responsible for serialization and deserialization. */ codeRepositoryState?: string | null; + /** + * Optional. Framework used to build the application. + */ + framework?: string | null; /** * Linked resources attached to the application by the user. */ @@ -18954,15 +19184,15 @@ export namespace aiplatform_v1 { strideLength?: string | null; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. + * Represents a 2D point in the image. Vertex coordinates are normalized to be relative to the original image dimensions and range from 0 to 1. The origin of the coordinate system (0,0) is the top-left corner of the image. x increases to the right, and y increases to the bottom. */ export interface Schema$GoogleCloudAiplatformV1SchemaVertex { /** - * X coordinate. + * X coordinate of the vertex, normalized to [0.0, 1.0]. */ x?: number | null; /** - * Y coordinate. + * Y coordinate of the vertex, normalized to [0.0, 1.0]. */ y?: number | null; } @@ -20908,6 +21138,10 @@ export namespace aiplatform_v1 { * Optional. Specialized retrieval tool that is powered by Google Search. */ googleSearchRetrieval?: Schema$GoogleCloudAiplatformV1GoogleSearchRetrieval; + /** + * Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + */ + parallelAiSearch?: Schema$GoogleCloudAiplatformV1ToolParallelAiSearch; /** * Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. */ @@ -21069,6 +21303,19 @@ export namespace aiplatform_v1 { * Spec for tool name match metric. */ export interface Schema$GoogleCloudAiplatformV1ToolNameMatchSpec {} + /** + * ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. + */ + export interface Schema$GoogleCloudAiplatformV1ToolParallelAiSearch { + /** + * Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. + */ + apiKey?: string | null; + /** + * Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] \}, "fetch_policy": { "max_age_seconds": 3600 \} \} + */ + customConfigs?: {[key: string]: any} | null; + } /** * Input for tool parameter key match metric. */ @@ -72036,7 +72283,7 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = await aiplatform.projects.locations.endpoints.streamRawPredict({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', * * // Request body metadata @@ -72689,7 +72936,7 @@ export namespace aiplatform_v1 { } export interface Params$Resource$Projects$Locations$Endpoints$Streamrawpredict extends StandardParameters { /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` */ endpoint?: string; @@ -73463,6 +73710,163 @@ export namespace aiplatform_v1 { this.context = context; } + /** + * Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.endpoints.openapi.completions( + * { + * // ID of the DeployedModel that serves the invoke request. + * deployedModelId: 'placeholder-value', + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'projects/my-project/locations/my-location/endpoints/openapi', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + completions( + params: Params$Resource$Projects$Locations$Endpoints$Openapi$Completions, + options: StreamMethodOptions + ): Promise>; + completions( + params?: Params$Resource$Projects$Locations$Endpoints$Openapi$Completions, + options?: MethodOptions + ): Promise>; + completions( + params: Params$Resource$Projects$Locations$Endpoints$Openapi$Completions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + completions( + params: Params$Resource$Projects$Locations$Endpoints$Openapi$Completions, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + completions( + params: Params$Resource$Projects$Locations$Endpoints$Openapi$Completions, + callback: BodyResponseCallback + ): void; + completions(callback: BodyResponseCallback): void; + completions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Openapi$Completions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Openapi$Completions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Openapi$Completions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}/completions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request. * @example @@ -73619,6 +74023,21 @@ export namespace aiplatform_v1 { } } + export interface Params$Resource$Projects$Locations$Endpoints$Openapi$Completions extends StandardParameters { + /** + * ID of the DeployedModel that serves the invoke request. + */ + deployedModelId?: string; + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleApiHttpBody; + } export interface Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings extends StandardParameters { /** * ID of the DeployedModel that serves the invoke request. @@ -129499,7 +129918,7 @@ export namespace aiplatform_v1 { * // Do the magic * const res = * await aiplatform.projects.locations.publishers.models.streamRawPredict({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` * endpoint: * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', * @@ -129732,7 +130151,7 @@ export namespace aiplatform_v1 { } export interface Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict extends StandardParameters { /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` */ endpoint?: string; @@ -133578,6 +133997,7 @@ export namespace aiplatform_v1 { context: APIRequestContext; memories: Resource$Projects$Locations$Reasoningengines$Memories; operations: Resource$Projects$Locations$Reasoningengines$Operations; + sandboxEnvironments: Resource$Projects$Locations$Reasoningengines$Sandboxenvironments; sessions: Resource$Projects$Locations$Reasoningengines$Sessions; constructor(context: APIRequestContext) { this.context = context; @@ -133588,6 +134008,10 @@ export namespace aiplatform_v1 { new Resource$Projects$Locations$Reasoningengines$Operations( this.context ); + this.sandboxEnvironments = + new Resource$Projects$Locations$Reasoningengines$Sandboxenvironments( + this.context + ); this.sessions = new Resource$Projects$Locations$Reasoningengines$Sessions( this.context ); @@ -133901,6 +134325,162 @@ export namespace aiplatform_v1 { } } + /** + * Executes code statelessly. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.reasoningEngines.executeCode({ + * // Required. The resource name of the sandbox environment to execute. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "inputs": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "outputs": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + executeCode( + params: Params$Resource$Projects$Locations$Reasoningengines$Executecode, + options: StreamMethodOptions + ): Promise>; + executeCode( + params?: Params$Resource$Projects$Locations$Reasoningengines$Executecode, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + executeCode( + params: Params$Resource$Projects$Locations$Reasoningengines$Executecode, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + executeCode( + params: Params$Resource$Projects$Locations$Reasoningengines$Executecode, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + executeCode( + params: Params$Resource$Projects$Locations$Reasoningengines$Executecode, + callback: BodyResponseCallback + ): void; + executeCode( + callback: BodyResponseCallback + ): void; + executeCode( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Reasoningengines$Executecode + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Reasoningengines$Executecode; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Executecode; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:executeCode').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Gets a reasoning engine. * @example @@ -134695,6 +135275,17 @@ export namespace aiplatform_v1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Reasoningengines$Executecode extends StandardParameters { + /** + * Required. The resource name of the sandbox environment to execute. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ExecuteCodeRequest; + } export interface Params$Resource$Projects$Locations$Reasoningengines$Get extends StandardParameters { /** * Required. The name of the ReasoningEngine resource. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` @@ -134819,6 +135410,7 @@ export namespace aiplatform_v1 { * // "displayName": "my_displayName", * // "expireTime": "my_expireTime", * // "fact": "my_fact", + * // "metadata": {}, * // "name": "my_name", * // "revisionExpireTime": "my_revisionExpireTime", * // "revisionLabels": {}, @@ -135130,6 +135722,8 @@ export namespace aiplatform_v1 { * // "directMemoriesSource": {}, * // "disableConsolidation": false, * // "disableMemoryRevisions": false, + * // "metadata": {}, + * // "metadataMergeStrategy": "my_metadataMergeStrategy", * // "revisionExpireTime": "my_revisionExpireTime", * // "revisionLabels": {}, * // "revisionTtl": "my_revisionTtl", @@ -135296,6 +135890,7 @@ export namespace aiplatform_v1 { * // "displayName": "my_displayName", * // "expireTime": "my_expireTime", * // "fact": "my_fact", + * // "metadata": {}, * // "name": "my_name", * // "revisionExpireTime": "my_revisionExpireTime", * // "revisionLabels": {}, @@ -135612,6 +136207,7 @@ export namespace aiplatform_v1 { * // "displayName": "my_displayName", * // "expireTime": "my_expireTime", * // "fact": "my_fact", + * // "metadata": {}, * // "name": "my_name", * // "revisionExpireTime": "my_revisionExpireTime", * // "revisionLabels": {}, @@ -135930,6 +136526,7 @@ export namespace aiplatform_v1 { * // request body parameters * // { * // "filter": "my_filter", + * // "filterGroups": [], * // "scope": {}, * // "similaritySearchParams": {}, * // "simpleRetrievalParams": {} @@ -138216,24 +138813,19 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Reasoningengines$Sessions { + export class Resource$Projects$Locations$Reasoningengines$Sandboxenvironments { context: APIRequestContext; - events: Resource$Projects$Locations$Reasoningengines$Sessions$Events; - operations: Resource$Projects$Locations$Reasoningengines$Sessions$Operations; + operations: Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations; constructor(context: APIRequestContext) { this.context = context; - this.events = - new Resource$Projects$Locations$Reasoningengines$Sessions$Events( - this.context - ); this.operations = - new Resource$Projects$Locations$Reasoningengines$Sessions$Operations( + new Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations( this.context ); } /** - * Appends an event to a given session. + * Creates a SandboxEnvironment in a given reasoning engine. * @example * ```js * // Before running the sample: @@ -138263,30 +138855,39 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.sessions.appendEvent({ - * // Required. The resource name of the session to append event to. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session', + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.create( + * { + * // Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}`. + * parent: + * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "actions": {}, - * // "author": "my_author", - * // "content": {}, - * // "errorCode": "my_errorCode", - * // "errorMessage": "my_errorMessage", - * // "eventMetadata": {}, - * // "invocationId": "my_invocationId", - * // "name": "my_name", - * // "timestamp": "my_timestamp" - * // } + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "connectionInfo": {}, + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "expireTime": "my_expireTime", + * // "name": "my_name", + * // "spec": {}, + * // "state": "my_state", + * // "ttl": "my_ttl", + * // "updateTime": "my_updateTime" + * // } + * }, * }, - * }); + * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -138301,62 +138902,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - appendEvent( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent, + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Create, options: StreamMethodOptions ): Promise>; - appendEvent( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent, + create( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Create, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - appendEvent( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - appendEvent( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent, + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - appendEvent( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Create, + callback: BodyResponseCallback ): void; - appendEvent( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - appendEvent( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Create; options = {}; } @@ -138369,7 +138966,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:appendEvent').replace( + url: (rootUrl + '/v1/{+parent}/sandboxEnvironments').replace( /([^:]\/)\/+/g, '$1' ), @@ -138379,24 +138976,22 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Creates a new Session. + * Deletes the specific SandboxEnvironment. * @example * ```js * // Before running the sample: @@ -138426,27 +139021,12 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.sessions.create({ - * // Required. The resource name of the location to create the session in. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * parent: - * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "expireTime": "my_expireTime", - * // "labels": {}, - * // "name": "my_name", - * // "sessionState": {}, - * // "ttl": "my_ttl", - * // "updateTime": "my_updateTime", - * // "userId": "my_userId" - * // } + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.delete( + * { + * // Required. The resource name of the SandboxEnvironment to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment', * }, - * }); + * ); * console.log(res.data); * * // Example response @@ -138471,36 +139051,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create, + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Delete, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create, + delete( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Delete, options?: MethodOptions ): Promise>; - create( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create, + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create, + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create, + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Delete, callback: BodyResponseCallback ): void; - create( + delete( callback: BodyResponseCallback ): void; - create( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -138516,13 +139096,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Delete; options = {}; } @@ -138535,18 +139115,15 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/sessions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -138560,7 +139137,7 @@ export namespace aiplatform_v1 { } /** - * Deletes details of the specific Session. + * Executes using a sandbox environment. * @example * ```js * // Before running the sample: @@ -138590,19 +139167,25 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.sessions.delete({ - * // Required. The resource name of the session. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session', - * }); + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.execute( + * { + * // Required. The resource name of the sandbox environment to execute. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "inputs": [] + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "outputs": [] * // } * } * @@ -138618,58 +139201,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete, + execute( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Execute, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete, + execute( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Execute, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + execute( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Execute, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete, + execute( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Execute, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete, - callback: BodyResponseCallback + execute( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Execute, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + execute( + callback: BodyResponseCallback ): void; - delete( + execute( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Execute + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Execute; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Execute; options = {}; } @@ -138682,8 +139269,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:execute').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -138694,17 +139284,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets details of the specific Session. + * Gets details of the specific SandboxEnvironment. * @example * ```js * // Before running the sample: @@ -138733,25 +139325,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.reasoningEngines.sessions.get( - * { - * // Required. The resource name of the session. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session', - * }, - * ); + * const res = + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.get( + * { + * // Required. The resource name of the sandbox environment. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment', + * }, + * ); * console.log(res.data); * * // Example response * // { + * // "connectionInfo": {}, * // "createTime": "my_createTime", * // "displayName": "my_displayName", * // "expireTime": "my_expireTime", - * // "labels": {}, * // "name": "my_name", - * // "sessionState": {}, + * // "spec": {}, + * // "state": "my_state", * // "ttl": "my_ttl", - * // "updateTime": "my_updateTime", - * // "userId": "my_userId" + * // "updateTime": "my_updateTime" * // } * } * @@ -138768,57 +139361,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get, + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Get, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Get; options = {}; } @@ -138843,19 +139440,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists Sessions in a given reasoning engine. + * Lists SandboxEnvironments in a given reasoning engine. * @example * ```js * // Before running the sample: @@ -138885,25 +139482,25 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.sessions.list({ - * // Optional. The standard list filter. Supported fields: * `display_name` * `user_id` * `labels` Example: `display_name="abc"`, `user_id="123"`, `labels.key="value"`. - * filter: 'placeholder-value', - * // Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`. - * orderBy: 'placeholder-value', - * // Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 100 sessions will be returned. - * pageSize: 'placeholder-value', - * // Optional. The next_page_token value returned from a previous list SessionService.ListSessions call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the location to list sessions from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * parent: - * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', - * }); + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.list( + * { + * // Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). + * filter: 'placeholder-value', + * // Optional. The maximum number of SandboxEnvironments to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironments will be returned. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token, received from a previous `ListSandboxEnvironments` call. Provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * parent: + * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', + * }, + * ); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "sessions": [] + * // "sandboxEnvironments": [] * // } * } * @@ -138920,61 +139517,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$List, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$List, + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$List, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$List, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sessions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$List; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$List; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$List; options = {}; } @@ -138987,7 +139584,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/sessions').replace( + url: (rootUrl + '/v1/{+parent}/sandboxEnvironments').replace( /([^:]\/)\/+/g, '$1' ), @@ -139002,448 +139599,72 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Updates the specific Session. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await aiplatform.projects.locations.reasoningEngines.sessions.patch({ - * // Identifier. The resource name of the session. Format: 'projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}'. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session', - * // Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "expireTime": "my_expireTime", - * // "labels": {}, - * // "name": "my_name", - * // "sessionState": {}, - * // "ttl": "my_ttl", - * // "updateTime": "my_updateTime", - * // "userId": "my_userId" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "expireTime": "my_expireTime", - * // "labels": {}, - * // "name": "my_name", - * // "sessionState": {}, - * // "ttl": "my_ttl", - * // "updateTime": "my_updateTime", - * // "userId": "my_userId" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - patch( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch, - options: StreamMethodOptions - ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch, - options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch, - callback: BodyResponseCallback - ): void; - patch( - callback: BodyResponseCallback - ): void; - patch( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent extends StandardParameters { - /** - * Required. The resource name of the session to append event to. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1SessionEvent; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create extends StandardParameters { + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Create extends StandardParameters { /** - * Required. The resource name of the location to create the session in. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}`. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1Session; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete extends StandardParameters { - /** - * Required. The resource name of the session. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` - */ - name?: string; + requestBody?: Schema$GoogleCloudAiplatformV1SandboxEnvironment; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Delete extends StandardParameters { /** - * Required. The resource name of the session. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` + * Required. The resource name of the SandboxEnvironment to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$List extends StandardParameters { - /** - * Optional. The standard list filter. Supported fields: * `display_name` * `user_id` * `labels` Example: `display_name="abc"`, `user_id="123"`, `labels.key="value"`. - */ - filter?: string; - /** - * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`. - */ - orderBy?: string; - /** - * Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 100 sessions will be returned. - */ - pageSize?: number; - /** - * Optional. The next_page_token value returned from a previous list SessionService.ListSessions call. - */ - pageToken?: string; - /** - * Required. The resource name of the location to list sessions from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch extends StandardParameters { + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Execute extends StandardParameters { /** - * Identifier. The resource name of the session. Format: 'projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}'. + * Required. The resource name of the sandbox environment to execute. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` */ name?: string; - /** - * Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated. - */ - updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1Session; + requestBody?: Schema$GoogleCloudAiplatformV1ExecuteSandboxEnvironmentRequest; } - - export class Resource$Projects$Locations$Reasoningengines$Sessions$Events { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Get extends StandardParameters { /** - * Lists Events in a given session. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await aiplatform.projects.locations.reasoningEngines.sessions.events.list({ - * // Optional. The standard list filter. Supported fields: * `timestamp` range (i.e. `timestamp\>="2025-01-31T11:30:00-04:00"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160). - * filter: 'placeholder-value', - * // Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `timestamp` Example: `timestamp desc`. - * orderBy: 'placeholder-value', - * // Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. These events are ordered by timestamp in ascending order. - * pageSize: 'placeholder-value', - * // Optional. The next_page_token value returned from a previous list SessionService.ListEvents call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the session to list events from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` - * parent: - * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "nextPageToken": "my_nextPageToken", - * // "sessionEvents": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * Required. The resource name of the sandbox environment. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` */ - list( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/events').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } + name?: string; } - - export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$List extends StandardParameters { /** - * Optional. The standard list filter. Supported fields: * `timestamp` range (i.e. `timestamp\>="2025-01-31T11:30:00-04:00"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160). + * Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). */ filter?: string; /** - * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `timestamp` Example: `timestamp desc`. - */ - orderBy?: string; - /** - * Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. These events are ordered by timestamp in ascending order. + * Optional. The maximum number of SandboxEnvironments to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironments will be returned. */ pageSize?: number; /** - * Optional. The next_page_token value returned from a previous list SessionService.ListEvents call. + * Optional. The standard list page token, received from a previous `ListSandboxEnvironments` call. Provide this to retrieve the subsequent page. */ pageToken?: string; /** - * Required. The resource name of the session to list events from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` + * Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` */ parent?: string; } - export class Resource$Projects$Locations$Reasoningengines$Sessions$Operations { + export class Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -139480,10 +139701,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.sessions.operations.cancel( + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.cancel( * { * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session/operations/my-operation', + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment/operations/my-operation', * }, * ); * console.log(res.data); @@ -139505,31 +139726,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -139545,13 +139766,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel; options = {}; } @@ -139616,10 +139837,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.sessions.operations.delete( + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.delete( * { * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session/operations/my-operation', + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment/operations/my-operation', * }, * ); * console.log(res.data); @@ -139641,31 +139862,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete, + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -139681,13 +139902,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete; options = {}; } @@ -139752,10 +139973,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.sessions.operations.get( + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.get( * { * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session/operations/my-operation', + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment/operations/my-operation', * }, * ); * console.log(res.data); @@ -139783,27 +140004,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get, + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -139811,7 +140032,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -139827,13 +140048,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get; options = {}; } @@ -139867,167 +140088,6 @@ export namespace aiplatform_v1 { } } - /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await aiplatform.projects.locations.reasoningEngines.sessions.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - /** * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example @@ -140059,10 +140119,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.sessions.operations.wait( + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.wait( * { * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session/operations/my-operation', + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment/operations/my-operation', * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. * timeout: 'placeholder-value', * }, @@ -140092,27 +140152,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait, + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -140120,7 +140180,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -140136,13 +140196,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Wait; options = {}; } @@ -140177,47 +140237,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -140228,18 +140266,24 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Schedules { + export class Resource$Projects$Locations$Reasoningengines$Sessions { context: APIRequestContext; - operations: Resource$Projects$Locations$Schedules$Operations; + events: Resource$Projects$Locations$Reasoningengines$Sessions$Events; + operations: Resource$Projects$Locations$Reasoningengines$Sessions$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = new Resource$Projects$Locations$Schedules$Operations( - this.context - ); + this.events = + new Resource$Projects$Locations$Reasoningengines$Sessions$Events( + this.context + ); + this.operations = + new Resource$Projects$Locations$Reasoningengines$Sessions$Operations( + this.context + ); } /** - * Creates a Schedule. + * Appends an event to a given session. * @example * ```js * // Before running the sample: @@ -140268,60 +140312,31 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.create({ - * // Required. The resource name of the Location to create the Schedule in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = + * await aiplatform.projects.locations.reasoningEngines.sessions.appendEvent({ + * // Required. The resource name of the session to append event to. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "allowQueueing": false, - * // "catchUp": false, - * // "createNotebookExecutionJobRequest": {}, - * // "createPipelineJobRequest": {}, - * // "createTime": "my_createTime", - * // "cron": "my_cron", - * // "displayName": "my_displayName", - * // "endTime": "my_endTime", - * // "lastPauseTime": "my_lastPauseTime", - * // "lastResumeTime": "my_lastResumeTime", - * // "lastScheduledRunResponse": {}, - * // "maxConcurrentRunCount": "my_maxConcurrentRunCount", - * // "maxRunCount": "my_maxRunCount", - * // "name": "my_name", - * // "nextRunTime": "my_nextRunTime", - * // "startTime": "my_startTime", - * // "startedRunCount": "my_startedRunCount", - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "actions": {}, + * // "author": "my_author", + * // "content": {}, + * // "errorCode": "my_errorCode", + * // "errorMessage": "my_errorMessage", + * // "eventMetadata": {}, + * // "invocationId": "my_invocationId", + * // "name": "my_name", + * // "timestamp": "my_timestamp" + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // { - * // "allowQueueing": false, - * // "catchUp": false, - * // "createNotebookExecutionJobRequest": {}, - * // "createPipelineJobRequest": {}, - * // "createTime": "my_createTime", - * // "cron": "my_cron", - * // "displayName": "my_displayName", - * // "endTime": "my_endTime", - * // "lastPauseTime": "my_lastPauseTime", - * // "lastResumeTime": "my_lastResumeTime", - * // "lastScheduledRunResponse": {}, - * // "maxConcurrentRunCount": "my_maxConcurrentRunCount", - * // "maxRunCount": "my_maxRunCount", - * // "name": "my_name", - * // "nextRunTime": "my_nextRunTime", - * // "startTime": "my_startTime", - * // "startedRunCount": "my_startedRunCount", - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } + * // {} * } * * main().catch(e => { @@ -140336,57 +140351,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Schedules$Create, + appendEvent( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Schedules$Create, + appendEvent( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Schedules$Create, + ): Promise< + GaxiosResponseWithHTTP2 + >; + appendEvent( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Schedules$Create, + appendEvent( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Schedules$Create, - callback: BodyResponseCallback + appendEvent( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + appendEvent( + callback: BodyResponseCallback ): void; - create( + appendEvent( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$Create; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Schedules$Create; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent; options = {}; } @@ -140399,7 +140419,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/schedules').replace( + url: (rootUrl + '/v1/{+name}:appendEvent').replace( /([^:]\/)\/+/g, '$1' ), @@ -140409,24 +140429,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a Schedule. + * Creates a new Session. * @example * ```js * // Before running the sample: @@ -140455,10 +140475,28 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.delete({ - * // Required. The name of the Schedule resource to be deleted. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` - * name: 'projects/my-project/locations/my-location/schedules/my-schedule', - * }); + * const res = + * await aiplatform.projects.locations.reasoningEngines.sessions.create({ + * // Required. The resource name of the location to create the session in. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * parent: + * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "expireTime": "my_expireTime", + * // "labels": {}, + * // "name": "my_name", + * // "sessionState": {}, + * // "ttl": "my_ttl", + * // "updateTime": "my_updateTime", + * // "userId": "my_userId" + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -140483,36 +140521,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Schedules$Delete, + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Schedules$Delete, + create( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Schedules$Delete, + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Schedules$Delete, + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Schedules$Delete, + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create, callback: BodyResponseCallback ): void; - delete( + create( callback: BodyResponseCallback ): void; - delete( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$Delete + | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -140528,12 +140566,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$Delete; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Schedules$Delete; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create; options = {}; } @@ -140546,15 +140585,18 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/sessions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -140568,7 +140610,7 @@ export namespace aiplatform_v1 { } /** - * Gets a Schedule. + * Deletes details of the specific Session. * @example * ```js * // Before running the sample: @@ -140597,33 +140639,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.get({ - * // Required. The name of the Schedule resource. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` - * name: 'projects/my-project/locations/my-location/schedules/my-schedule', - * }); + * const res = + * await aiplatform.projects.locations.reasoningEngines.sessions.delete({ + * // Required. The resource name of the session. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session', + * }); * console.log(res.data); * * // Example response * // { - * // "allowQueueing": false, - * // "catchUp": false, - * // "createNotebookExecutionJobRequest": {}, - * // "createPipelineJobRequest": {}, - * // "createTime": "my_createTime", - * // "cron": "my_cron", - * // "displayName": "my_displayName", - * // "endTime": "my_endTime", - * // "lastPauseTime": "my_lastPauseTime", - * // "lastResumeTime": "my_lastResumeTime", - * // "lastScheduledRunResponse": {}, - * // "maxConcurrentRunCount": "my_maxConcurrentRunCount", - * // "maxRunCount": "my_maxRunCount", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "nextRunTime": "my_nextRunTime", - * // "startTime": "my_startTime", - * // "startedRunCount": "my_startedRunCount", - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -140639,57 +140668,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Schedules$Get, + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Schedules$Get, + delete( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Schedules$Get, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Schedules$Get, + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Schedules$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - get( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$Get; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Schedules$Get; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete; options = {}; } @@ -140703,7 +140733,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -140714,19 +140744,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists Schedules in a Location. + * Gets details of the specific Session. * @example * ```js * // Before running the sample: @@ -140755,24 +140783,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.list({ - * // Lists the Schedules that match the filter expression. The following fields are supported: * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `state`: Supports `=` and `!=` comparisons. * `request`: Supports existence of the check. (e.g. `create_pipeline_job_request:*` --\> Schedule has create_pipeline_job_request). * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `start_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, `\>=` comparisons and `:*` existence check. Values must be in RFC 3339 format. * `next_run_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. Filter expressions can be combined together using logical operators (`NOT`, `AND` & `OR`). The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `state="ACTIVE" AND display_name:"my_schedule_*"` * `NOT display_name="my_schedule"` * `create_time\>"2021-05-18T00:00:00Z"` * `end_time\>"2021-05-18T00:00:00Z" OR NOT end_time:*` * `create_pipeline_job_request:*` - * filter: 'placeholder-value', - * // A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided. For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order. If order_by is not specified, it will order by default with create_time in descending order. Supported fields: * `create_time` * `start_time` * `end_time` * `next_run_time` - * orderBy: 'placeholder-value', - * // The standard list page size. Default to 100 if not specified. - * pageSize: 'placeholder-value', - * // The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list the Schedules from. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * }); + * const res = await aiplatform.projects.locations.reasoningEngines.sessions.get( + * { + * // Required. The resource name of the session. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "schedules": [] + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "expireTime": "my_expireTime", + * // "labels": {}, + * // "name": "my_name", + * // "sessionState": {}, + * // "ttl": "my_ttl", + * // "updateTime": "my_updateTime", + * // "userId": "my_userId" * // } * } * @@ -140788,61 +140817,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Schedules$List, + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Schedules$List, + get( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Schedules$List, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Schedules$List, + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Schedules$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$List; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Schedules$List; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get; options = {}; } @@ -140855,34 +140881,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/schedules').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates an active or paused Schedule. When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled. + * Lists Sessions in a given reasoning engine. * @example * ```js * // Before running the sample: @@ -140911,61 +140934,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.patch({ - * // Immutable. The resource name of the Schedule. - * name: 'projects/my-project/locations/my-location/schedules/my-schedule', - * // Required. The update mask applies to the resource. See google.protobuf.FieldMask. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "allowQueueing": false, - * // "catchUp": false, - * // "createNotebookExecutionJobRequest": {}, - * // "createPipelineJobRequest": {}, - * // "createTime": "my_createTime", - * // "cron": "my_cron", - * // "displayName": "my_displayName", - * // "endTime": "my_endTime", - * // "lastPauseTime": "my_lastPauseTime", - * // "lastResumeTime": "my_lastResumeTime", - * // "lastScheduledRunResponse": {}, - * // "maxConcurrentRunCount": "my_maxConcurrentRunCount", - * // "maxRunCount": "my_maxRunCount", - * // "name": "my_name", - * // "nextRunTime": "my_nextRunTime", - * // "startTime": "my_startTime", - * // "startedRunCount": "my_startedRunCount", - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.reasoningEngines.sessions.list({ + * // Optional. The standard list filter. Supported fields: * `display_name` * `user_id` * `labels` Example: `display_name="abc"`, `user_id="123"`, `labels.key="value"`. + * filter: 'placeholder-value', + * // Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 100 sessions will be returned. + * pageSize: 'placeholder-value', + * // Optional. The next_page_token value returned from a previous list SessionService.ListSessions call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the location to list sessions from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * parent: + * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', + * }); * console.log(res.data); * * // Example response * // { - * // "allowQueueing": false, - * // "catchUp": false, - * // "createNotebookExecutionJobRequest": {}, - * // "createPipelineJobRequest": {}, - * // "createTime": "my_createTime", - * // "cron": "my_cron", - * // "displayName": "my_displayName", - * // "endTime": "my_endTime", - * // "lastPauseTime": "my_lastPauseTime", - * // "lastResumeTime": "my_lastResumeTime", - * // "lastScheduledRunResponse": {}, - * // "maxConcurrentRunCount": "my_maxConcurrentRunCount", - * // "maxRunCount": "my_maxRunCount", - * // "name": "my_name", - * // "nextRunTime": "my_nextRunTime", - * // "startTime": "my_startTime", - * // "startedRunCount": "my_startedRunCount", - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "nextPageToken": "my_nextPageToken", + * // "sessions": [] * // } * } * @@ -140981,57 +140969,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Schedules$Patch, + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$List, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Schedules$Patch, + list( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$List, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Schedules$Patch, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Schedules$Patch, + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Schedules$Patch, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$List, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - patch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sessions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$Patch; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Schedules$Patch; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$List; options = {}; } @@ -141044,31 +141037,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+parent}/sessions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled. + * Updates the specific Session. * @example * ```js * // Before running the sample: @@ -141097,20 +141093,43 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.pause({ - * // Required. The name of the Schedule resource to be paused. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` - * name: 'projects/my-project/locations/my-location/schedules/my-schedule', + * const res = + * await aiplatform.projects.locations.reasoningEngines.sessions.patch({ + * // Identifier. The resource name of the session. Format: 'projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}'. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session', + * // Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated. + * updateMask: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "expireTime": "my_expireTime", + * // "labels": {}, + * // "name": "my_name", + * // "sessionState": {}, + * // "ttl": "my_ttl", + * // "updateTime": "my_updateTime", + * // "userId": "my_userId" + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "expireTime": "my_expireTime", + * // "labels": {}, + * // "name": "my_name", + * // "sessionState": {}, + * // "ttl": "my_ttl", + * // "updateTime": "my_updateTime", + * // "userId": "my_userId" + * // } * } * * main().catch(e => { @@ -141125,53 +141144,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - pause( - params: Params$Resource$Projects$Locations$Schedules$Pause, + patch( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch, options: StreamMethodOptions ): Promise>; - pause( - params?: Params$Resource$Projects$Locations$Schedules$Pause, + patch( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch, options?: MethodOptions - ): Promise>; - pause( - params: Params$Resource$Projects$Locations$Schedules$Pause, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - pause( - params: Params$Resource$Projects$Locations$Schedules$Pause, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - pause( - params: Params$Resource$Projects$Locations$Schedules$Pause, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch, + callback: BodyResponseCallback ): void; - pause(callback: BodyResponseCallback): void; - pause( + patch( + callback: BodyResponseCallback + ): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$Pause - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$Pause; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Schedules$Pause; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch; options = {}; } @@ -141184,8 +141208,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:pause').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -141196,17 +141220,98 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent extends StandardParameters { /** - * Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catch_up is set up true, all missed runs will be scheduled for backfill first. + * Required. The resource name of the session to append event to. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1SessionEvent; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create extends StandardParameters { + /** + * Required. The resource name of the location to create the session in. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Session; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete extends StandardParameters { + /** + * Required. The resource name of the session. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get extends StandardParameters { + /** + * Required. The resource name of the session. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$List extends StandardParameters { + /** + * Optional. The standard list filter. Supported fields: * `display_name` * `user_id` * `labels` Example: `display_name="abc"`, `user_id="123"`, `labels.key="value"`. + */ + filter?: string; + /** + * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`. + */ + orderBy?: string; + /** + * Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 100 sessions will be returned. + */ + pageSize?: number; + /** + * Optional. The next_page_token value returned from a previous list SessionService.ListSessions call. + */ + pageToken?: string; + /** + * Required. The resource name of the location to list sessions from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch extends StandardParameters { + /** + * Identifier. The resource name of the session. Format: 'projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}'. + */ + name?: string; + /** + * Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Session; + } + + export class Resource$Projects$Locations$Reasoningengines$Sessions$Events { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists Events in a given session. * @example * ```js * // Before running the sample: @@ -141235,22 +141340,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.resume({ - * // Required. The name of the Schedule resource to be resumed. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` - * name: 'projects/my-project/locations/my-location/schedules/my-schedule', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "catchUp": false - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.reasoningEngines.sessions.events.list({ + * // Optional. The standard list filter. Supported fields: * `timestamp` range (i.e. `timestamp\>="2025-01-31T11:30:00-04:00"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160). + * filter: 'placeholder-value', + * // Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `timestamp` Example: `timestamp desc`. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. These events are ordered by timestamp in ascending order. + * pageSize: 'placeholder-value', + * // Optional. The next_page_token value returned from a previous list SessionService.ListEvents call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the session to list events from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` + * parent: + * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "nextPageToken": "my_nextPageToken", + * // "sessionEvents": [] + * // } * } * * main().catch(e => { @@ -141265,53 +141375,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - resume( - params: Params$Resource$Projects$Locations$Schedules$Resume, + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List, options: StreamMethodOptions ): Promise>; - resume( - params?: Params$Resource$Projects$Locations$Schedules$Resume, + list( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List, options?: MethodOptions - ): Promise>; - resume( - params: Params$Resource$Projects$Locations$Schedules$Resume, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - resume( - params: Params$Resource$Projects$Locations$Schedules$Resume, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - resume( - params: Params$Resource$Projects$Locations$Schedules$Resume, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List, + callback: BodyResponseCallback ): void; - resume(callback: BodyResponseCallback): void; - resume( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$Resume - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$Resume; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Schedules$Resume; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List; options = {}; } @@ -141324,112 +141443,57 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:resume').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+parent}/events').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Schedules$Create extends StandardParameters { - /** - * Required. The resource name of the Location to create the Schedule in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Schedule; - } - export interface Params$Resource$Projects$Locations$Schedules$Delete extends StandardParameters { - /** - * Required. The name of the Schedule resource to be deleted. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Schedules$Get extends StandardParameters { - /** - * Required. The name of the Schedule resource. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Schedules$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List extends StandardParameters { /** - * Lists the Schedules that match the filter expression. The following fields are supported: * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `state`: Supports `=` and `!=` comparisons. * `request`: Supports existence of the check. (e.g. `create_pipeline_job_request:*` --\> Schedule has create_pipeline_job_request). * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `start_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, `\>=` comparisons and `:*` existence check. Values must be in RFC 3339 format. * `next_run_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. Filter expressions can be combined together using logical operators (`NOT`, `AND` & `OR`). The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `state="ACTIVE" AND display_name:"my_schedule_*"` * `NOT display_name="my_schedule"` * `create_time\>"2021-05-18T00:00:00Z"` * `end_time\>"2021-05-18T00:00:00Z" OR NOT end_time:*` * `create_pipeline_job_request:*` + * Optional. The standard list filter. Supported fields: * `timestamp` range (i.e. `timestamp\>="2025-01-31T11:30:00-04:00"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160). */ filter?: string; /** - * A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided. For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order. If order_by is not specified, it will order by default with create_time in descending order. Supported fields: * `create_time` * `start_time` * `end_time` * `next_run_time` + * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `timestamp` Example: `timestamp desc`. */ orderBy?: string; /** - * The standard list page size. Default to 100 if not specified. + * Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. These events are ordered by timestamp in ascending order. */ pageSize?: number; /** - * The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call. + * Optional. The next_page_token value returned from a previous list SessionService.ListEvents call. */ pageToken?: string; /** - * Required. The resource name of the Location to list the Schedules from. Format: `projects/{project\}/locations/{location\}` + * Required. The resource name of the session to list events from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` */ parent?: string; } - export interface Params$Resource$Projects$Locations$Schedules$Patch extends StandardParameters { - /** - * Immutable. The resource name of the Schedule. - */ - name?: string; - /** - * Required. The update mask applies to the resource. See google.protobuf.FieldMask. - */ - updateMask?: string; - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Schedule; - } - export interface Params$Resource$Projects$Locations$Schedules$Pause extends StandardParameters { - /** - * Required. The name of the Schedule resource to be paused. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1PauseScheduleRequest; - } - export interface Params$Resource$Projects$Locations$Schedules$Resume extends StandardParameters { - /** - * Required. The name of the Schedule resource to be resumed. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ResumeScheduleRequest; - } - - export class Resource$Projects$Locations$Schedules$Operations { + export class Resource$Projects$Locations$Reasoningengines$Sessions$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -141465,10 +141529,13 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/schedules/my-schedule/operations/my-operation', - * }); + * const res = + * await aiplatform.projects.locations.reasoningEngines.sessions.operations.cancel( + * { + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -141488,31 +141555,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Schedules$Operations$Cancel, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Schedules$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Schedules$Operations$Cancel, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Schedules$Operations$Cancel, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Schedules$Operations$Cancel, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$Operations$Cancel + | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -141528,13 +141595,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Schedules$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel; options = {}; } @@ -141598,10 +141665,13 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/schedules/my-schedule/operations/my-operation', - * }); + * const res = + * await aiplatform.projects.locations.reasoningEngines.sessions.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -141621,31 +141691,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Schedules$Operations$Delete, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Schedules$Operations$Delete, + params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Schedules$Operations$Delete, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Schedules$Operations$Delete, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Schedules$Operations$Delete, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$Operations$Delete + | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -141661,13 +141731,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Schedules$Operations$Delete; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete; options = {}; } @@ -141731,10 +141801,13 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/schedules/my-schedule/operations/my-operation', - * }); + * const res = + * await aiplatform.projects.locations.reasoningEngines.sessions.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -141760,27 +141833,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Schedules$Operations$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Schedules$Operations$Get, + params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Schedules$Operations$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Schedules$Operations$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Schedules$Operations$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -141788,7 +141861,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$Operations$Get + | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -141804,13 +141877,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$Operations$Get; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Schedules$Operations$Get; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get; options = {}; } @@ -141874,18 +141947,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/schedules/my-schedule', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.reasoningEngines.sessions.operations.list( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response @@ -141909,29 +141985,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Schedules$Operations$List, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Schedules$Operations$List, + params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Schedules$Operations$List, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Schedules$Operations$List, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Schedules$Operations$List, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List, callback: BodyResponseCallback ): void; list( @@ -141939,7 +142015,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$Operations$List + | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -141957,13 +142033,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$Operations$List; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Schedules$Operations$List; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List; options = {}; } @@ -142032,12 +142108,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/schedules/my-schedule/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.reasoningEngines.sessions.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response @@ -142063,27 +142142,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Schedules$Operations$Wait, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Schedules$Operations$Wait, + params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Schedules$Operations$Wait, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Schedules$Operations$Wait, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Schedules$Operations$Wait, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -142091,7 +142170,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$Operations$Wait + | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -142107,13 +142186,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Schedules$Operations$Wait; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait; options = {}; } @@ -142148,25 +142227,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Schedules$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Schedules$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Schedules$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Schedules$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -142188,7 +142267,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Schedules$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -142199,19 +142278,18 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Specialistpools { + export class Resource$Projects$Locations$Schedules { context: APIRequestContext; - operations: Resource$Projects$Locations$Specialistpools$Operations; + operations: Resource$Projects$Locations$Schedules$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Specialistpools$Operations( - this.context - ); + this.operations = new Resource$Projects$Locations$Schedules$Operations( + this.context + ); } /** - * Creates a SpecialistPool. + * Creates a Schedule. * @example * ```js * // Before running the sample: @@ -142240,20 +142318,33 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.specialistPools.create({ - * // Required. The parent Project name for the new SpecialistPool. The form is `projects/{project\}/locations/{location\}`. + * const res = await aiplatform.projects.locations.schedules.create({ + * // Required. The resource name of the Location to create the Schedule in. Format: `projects/{project\}/locations/{location\}` * parent: 'projects/my-project/locations/my-location', * * // Request body metadata * requestBody: { * // request body parameters * // { + * // "allowQueueing": false, + * // "catchUp": false, + * // "createNotebookExecutionJobRequest": {}, + * // "createPipelineJobRequest": {}, + * // "createTime": "my_createTime", + * // "cron": "my_cron", * // "displayName": "my_displayName", + * // "endTime": "my_endTime", + * // "lastPauseTime": "my_lastPauseTime", + * // "lastResumeTime": "my_lastResumeTime", + * // "lastScheduledRunResponse": {}, + * // "maxConcurrentRunCount": "my_maxConcurrentRunCount", + * // "maxRunCount": "my_maxRunCount", * // "name": "my_name", - * // "pendingDataLabelingJobs": [], - * // "specialistManagerEmails": [], - * // "specialistManagersCount": 0, - * // "specialistWorkerEmails": [] + * // "nextRunTime": "my_nextRunTime", + * // "startTime": "my_startTime", + * // "startedRunCount": "my_startedRunCount", + * // "state": "my_state", + * // "updateTime": "my_updateTime" * // } * }, * }); @@ -142261,11 +142352,25 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "allowQueueing": false, + * // "catchUp": false, + * // "createNotebookExecutionJobRequest": {}, + * // "createPipelineJobRequest": {}, + * // "createTime": "my_createTime", + * // "cron": "my_cron", + * // "displayName": "my_displayName", + * // "endTime": "my_endTime", + * // "lastPauseTime": "my_lastPauseTime", + * // "lastResumeTime": "my_lastResumeTime", + * // "lastScheduledRunResponse": {}, + * // "maxConcurrentRunCount": "my_maxConcurrentRunCount", + * // "maxRunCount": "my_maxRunCount", * // "name": "my_name", - * // "response": {} + * // "nextRunTime": "my_nextRunTime", + * // "startTime": "my_startTime", + * // "startedRunCount": "my_startedRunCount", + * // "state": "my_state", + * // "updateTime": "my_updateTime" * // } * } * @@ -142282,57 +142387,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Specialistpools$Create, + params: Params$Resource$Projects$Locations$Schedules$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Specialistpools$Create, + params?: Params$Resource$Projects$Locations$Schedules$Create, options?: MethodOptions - ): Promise>; + ): Promise>; create( - params: Params$Resource$Projects$Locations$Specialistpools$Create, + params: Params$Resource$Projects$Locations$Schedules$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Specialistpools$Create, + params: Params$Resource$Projects$Locations$Schedules$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Specialistpools$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Schedules$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Specialistpools$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schedules$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Specialistpools$Create; + {}) as Params$Resource$Projects$Locations$Schedules$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Specialistpools$Create; + params = {} as Params$Resource$Projects$Locations$Schedules$Create; options = {}; } @@ -142345,7 +142449,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/specialistPools').replace( + url: (rootUrl + '/v1/{+parent}/schedules').replace( /([^:]\/)\/+/g, '$1' ), @@ -142360,17 +142464,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a SpecialistPool as well as all Specialists in the pool. + * Deletes a Schedule. * @example * ```js * // Before running the sample: @@ -142399,11 +142505,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.specialistPools.delete({ - * // If set to true, any specialist managers in this SpecialistPool will also be deleted. (Otherwise, the request will only work if the SpecialistPool has no specialist managers.) - * force: 'placeholder-value', - * // Required. The resource name of the SpecialistPool to delete. Format: `projects/{project\}/locations/{location\}/specialistPools/{specialist_pool\}` - * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool', + * const res = await aiplatform.projects.locations.schedules.delete({ + * // Required. The name of the Schedule resource to be deleted. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` + * name: 'projects/my-project/locations/my-location/schedules/my-schedule', * }); * console.log(res.data); * @@ -142430,27 +142534,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Specialistpools$Delete, + params: Params$Resource$Projects$Locations$Schedules$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Specialistpools$Delete, + params?: Params$Resource$Projects$Locations$Schedules$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Specialistpools$Delete, + params: Params$Resource$Projects$Locations$Schedules$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Specialistpools$Delete, + params: Params$Resource$Projects$Locations$Schedules$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Specialistpools$Delete, + params: Params$Resource$Projects$Locations$Schedules$Delete, callback: BodyResponseCallback ): void; delete( @@ -142458,7 +142562,7 @@ export namespace aiplatform_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Specialistpools$Delete + | Params$Resource$Projects$Locations$Schedules$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -142474,13 +142578,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Specialistpools$Delete; + {}) as Params$Resource$Projects$Locations$Schedules$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Specialistpools$Delete; + params = {} as Params$Resource$Projects$Locations$Schedules$Delete; options = {}; } @@ -142515,7 +142618,7 @@ export namespace aiplatform_v1 { } /** - * Gets a SpecialistPool. + * Gets a Schedule. * @example * ```js * // Before running the sample: @@ -142544,20 +142647,33 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.specialistPools.get({ - * // Required. The name of the SpecialistPool resource. The form is `projects/{project\}/locations/{location\}/specialistPools/{specialist_pool\}`. - * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool', + * const res = await aiplatform.projects.locations.schedules.get({ + * // Required. The name of the Schedule resource. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` + * name: 'projects/my-project/locations/my-location/schedules/my-schedule', * }); * console.log(res.data); * * // Example response * // { + * // "allowQueueing": false, + * // "catchUp": false, + * // "createNotebookExecutionJobRequest": {}, + * // "createPipelineJobRequest": {}, + * // "createTime": "my_createTime", + * // "cron": "my_cron", * // "displayName": "my_displayName", + * // "endTime": "my_endTime", + * // "lastPauseTime": "my_lastPauseTime", + * // "lastResumeTime": "my_lastResumeTime", + * // "lastScheduledRunResponse": {}, + * // "maxConcurrentRunCount": "my_maxConcurrentRunCount", + * // "maxRunCount": "my_maxRunCount", * // "name": "my_name", - * // "pendingDataLabelingJobs": [], - * // "specialistManagerEmails": [], - * // "specialistManagersCount": 0, - * // "specialistWorkerEmails": [] + * // "nextRunTime": "my_nextRunTime", + * // "startTime": "my_startTime", + * // "startedRunCount": "my_startedRunCount", + * // "state": "my_state", + * // "updateTime": "my_updateTime" * // } * } * @@ -142574,60 +142690,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Specialistpools$Get, + params: Params$Resource$Projects$Locations$Schedules$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Specialistpools$Get, + params?: Params$Resource$Projects$Locations$Schedules$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Specialistpools$Get, + params: Params$Resource$Projects$Locations$Schedules$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Specialistpools$Get, + params: Params$Resource$Projects$Locations$Schedules$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Specialistpools$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Schedules$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Specialistpools$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schedules$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Specialistpools$Get; + {}) as Params$Resource$Projects$Locations$Schedules$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Specialistpools$Get; + params = {} as Params$Resource$Projects$Locations$Schedules$Get; options = {}; } @@ -142652,19 +142764,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists SpecialistPools in a Location. + * Lists Schedules in a Location. * @example * ```js * // Before running the sample: @@ -142693,22 +142805,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.specialistPools.list({ - * // The standard list page size. + * const res = await aiplatform.projects.locations.schedules.list({ + * // Lists the Schedules that match the filter expression. The following fields are supported: * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `state`: Supports `=` and `!=` comparisons. * `request`: Supports existence of the check. (e.g. `create_pipeline_job_request:*` --\> Schedule has create_pipeline_job_request). * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `start_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, `\>=` comparisons and `:*` existence check. Values must be in RFC 3339 format. * `next_run_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. Filter expressions can be combined together using logical operators (`NOT`, `AND` & `OR`). The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `state="ACTIVE" AND display_name:"my_schedule_*"` * `NOT display_name="my_schedule"` * `create_time\>"2021-05-18T00:00:00Z"` * `end_time\>"2021-05-18T00:00:00Z" OR NOT end_time:*` * `create_pipeline_job_request:*` + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided. For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order. If order_by is not specified, it will order by default with create_time in descending order. Supported fields: * `create_time` * `start_time` * `end_time` * `next_run_time` + * orderBy: 'placeholder-value', + * // The standard list page size. Default to 100 if not specified. * pageSize: 'placeholder-value', - * // The standard list page token. Typically obtained by ListSpecialistPoolsResponse.next_page_token of the previous SpecialistPoolService.ListSpecialistPools call. Return first page if empty. + * // The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call. * pageToken: 'placeholder-value', - * // Required. The name of the SpecialistPool's parent resource. Format: `projects/{project\}/locations/{location\}` + * // Required. The resource name of the Location to list the Schedules from. Format: `projects/{project\}/locations/{location\}` * parent: 'projects/my-project/locations/my-location', - * // Mask specifying which fields to read. FieldMask represents a set of - * readMask: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "specialistPools": [] + * // "schedules": [] * // } * } * @@ -142725,60 +142839,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Specialistpools$List, + params: Params$Resource$Projects$Locations$Schedules$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Specialistpools$List, + params?: Params$Resource$Projects$Locations$Schedules$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Specialistpools$List, + params: Params$Resource$Projects$Locations$Schedules$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Specialistpools$List, + params: Params$Resource$Projects$Locations$Schedules$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Specialistpools$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Schedules$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Specialistpools$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schedules$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Specialistpools$List; + {}) as Params$Resource$Projects$Locations$Schedules$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Specialistpools$List; + params = {} as Params$Resource$Projects$Locations$Schedules$List; options = {}; } @@ -142791,7 +142905,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/specialistPools').replace( + url: (rootUrl + '/v1/{+parent}/schedules').replace( /([^:]\/)\/+/g, '$1' ), @@ -142806,19 +142920,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a SpecialistPool. + * Updates an active or paused Schedule. When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled. * @example * ```js * // Before running the sample: @@ -142847,22 +142961,35 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.specialistPools.patch({ - * // Required. The resource name of the SpecialistPool. - * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool', - * // Required. The update mask applies to the resource. + * const res = await aiplatform.projects.locations.schedules.patch({ + * // Immutable. The resource name of the Schedule. + * name: 'projects/my-project/locations/my-location/schedules/my-schedule', + * // Required. The update mask applies to the resource. See google.protobuf.FieldMask. * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { + * // "allowQueueing": false, + * // "catchUp": false, + * // "createNotebookExecutionJobRequest": {}, + * // "createPipelineJobRequest": {}, + * // "createTime": "my_createTime", + * // "cron": "my_cron", * // "displayName": "my_displayName", + * // "endTime": "my_endTime", + * // "lastPauseTime": "my_lastPauseTime", + * // "lastResumeTime": "my_lastResumeTime", + * // "lastScheduledRunResponse": {}, + * // "maxConcurrentRunCount": "my_maxConcurrentRunCount", + * // "maxRunCount": "my_maxRunCount", * // "name": "my_name", - * // "pendingDataLabelingJobs": [], - * // "specialistManagerEmails": [], - * // "specialistManagersCount": 0, - * // "specialistWorkerEmails": [] + * // "nextRunTime": "my_nextRunTime", + * // "startTime": "my_startTime", + * // "startedRunCount": "my_startedRunCount", + * // "state": "my_state", + * // "updateTime": "my_updateTime" * // } * }, * }); @@ -142870,11 +142997,25 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "allowQueueing": false, + * // "catchUp": false, + * // "createNotebookExecutionJobRequest": {}, + * // "createPipelineJobRequest": {}, + * // "createTime": "my_createTime", + * // "cron": "my_cron", + * // "displayName": "my_displayName", + * // "endTime": "my_endTime", + * // "lastPauseTime": "my_lastPauseTime", + * // "lastResumeTime": "my_lastResumeTime", + * // "lastScheduledRunResponse": {}, + * // "maxConcurrentRunCount": "my_maxConcurrentRunCount", + * // "maxRunCount": "my_maxRunCount", * // "name": "my_name", - * // "response": {} + * // "nextRunTime": "my_nextRunTime", + * // "startTime": "my_startTime", + * // "startedRunCount": "my_startedRunCount", + * // "state": "my_state", + * // "updateTime": "my_updateTime" * // } * } * @@ -142891,56 +143032,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Specialistpools$Patch, + params: Params$Resource$Projects$Locations$Schedules$Patch, options: StreamMethodOptions ): Promise>; patch( - params?: Params$Resource$Projects$Locations$Specialistpools$Patch, + params?: Params$Resource$Projects$Locations$Schedules$Patch, options?: MethodOptions - ): Promise>; + ): Promise>; patch( - params: Params$Resource$Projects$Locations$Specialistpools$Patch, + params: Params$Resource$Projects$Locations$Schedules$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Specialistpools$Patch, + params: Params$Resource$Projects$Locations$Schedules$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Specialistpools$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Schedules$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Specialistpools$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schedules$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Specialistpools$Patch; + {}) as Params$Resource$Projects$Locations$Schedules$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Specialistpools$Patch; + params = {} as Params$Resource$Projects$Locations$Schedules$Patch; options = {}; } @@ -142965,78 +143106,380 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); + } + } + + /** + * Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.schedules.pause({ + * // Required. The name of the Schedule resource to be paused. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` + * name: 'projects/my-project/locations/my-location/schedules/my-schedule', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + pause( + params: Params$Resource$Projects$Locations$Schedules$Pause, + options: StreamMethodOptions + ): Promise>; + pause( + params?: Params$Resource$Projects$Locations$Schedules$Pause, + options?: MethodOptions + ): Promise>; + pause( + params: Params$Resource$Projects$Locations$Schedules$Pause, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + pause( + params: Params$Resource$Projects$Locations$Schedules$Pause, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + pause( + params: Params$Resource$Projects$Locations$Schedules$Pause, + callback: BodyResponseCallback + ): void; + pause(callback: BodyResponseCallback): void; + pause( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schedules$Pause + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schedules$Pause; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Schedules$Pause; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:pause').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catch_up is set up true, all missed runs will be scheduled for backfill first. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.schedules.resume({ + * // Required. The name of the Schedule resource to be resumed. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` + * name: 'projects/my-project/locations/my-location/schedules/my-schedule', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "catchUp": false + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + resume( + params: Params$Resource$Projects$Locations$Schedules$Resume, + options: StreamMethodOptions + ): Promise>; + resume( + params?: Params$Resource$Projects$Locations$Schedules$Resume, + options?: MethodOptions + ): Promise>; + resume( + params: Params$Resource$Projects$Locations$Schedules$Resume, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resume( + params: Params$Resource$Projects$Locations$Schedules$Resume, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resume( + params: Params$Resource$Projects$Locations$Schedules$Resume, + callback: BodyResponseCallback + ): void; + resume(callback: BodyResponseCallback): void; + resume( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schedules$Resume + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schedules$Resume; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Schedules$Resume; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:resume').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Specialistpools$Create extends StandardParameters { + export interface Params$Resource$Projects$Locations$Schedules$Create extends StandardParameters { /** - * Required. The parent Project name for the new SpecialistPool. The form is `projects/{project\}/locations/{location\}`. + * Required. The resource name of the Location to create the Schedule in. Format: `projects/{project\}/locations/{location\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1SpecialistPool; + requestBody?: Schema$GoogleCloudAiplatformV1Schedule; } - export interface Params$Resource$Projects$Locations$Specialistpools$Delete extends StandardParameters { - /** - * If set to true, any specialist managers in this SpecialistPool will also be deleted. (Otherwise, the request will only work if the SpecialistPool has no specialist managers.) - */ - force?: boolean; + export interface Params$Resource$Projects$Locations$Schedules$Delete extends StandardParameters { /** - * Required. The resource name of the SpecialistPool to delete. Format: `projects/{project\}/locations/{location\}/specialistPools/{specialist_pool\}` + * Required. The name of the Schedule resource to be deleted. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Specialistpools$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Schedules$Get extends StandardParameters { /** - * Required. The name of the SpecialistPool resource. The form is `projects/{project\}/locations/{location\}/specialistPools/{specialist_pool\}`. + * Required. The name of the Schedule resource. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Specialistpools$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Schedules$List extends StandardParameters { /** - * The standard list page size. + * Lists the Schedules that match the filter expression. The following fields are supported: * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `state`: Supports `=` and `!=` comparisons. * `request`: Supports existence of the check. (e.g. `create_pipeline_job_request:*` --\> Schedule has create_pipeline_job_request). * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `start_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, `\>=` comparisons and `:*` existence check. Values must be in RFC 3339 format. * `next_run_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. Filter expressions can be combined together using logical operators (`NOT`, `AND` & `OR`). The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `state="ACTIVE" AND display_name:"my_schedule_*"` * `NOT display_name="my_schedule"` * `create_time\>"2021-05-18T00:00:00Z"` * `end_time\>"2021-05-18T00:00:00Z" OR NOT end_time:*` * `create_pipeline_job_request:*` + */ + filter?: string; + /** + * A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided. For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order. If order_by is not specified, it will order by default with create_time in descending order. Supported fields: * `create_time` * `start_time` * `end_time` * `next_run_time` + */ + orderBy?: string; + /** + * The standard list page size. Default to 100 if not specified. */ pageSize?: number; /** - * The standard list page token. Typically obtained by ListSpecialistPoolsResponse.next_page_token of the previous SpecialistPoolService.ListSpecialistPools call. Return first page if empty. + * The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call. */ pageToken?: string; /** - * Required. The name of the SpecialistPool's parent resource. Format: `projects/{project\}/locations/{location\}` + * Required. The resource name of the Location to list the Schedules from. Format: `projects/{project\}/locations/{location\}` */ parent?: string; + } + export interface Params$Resource$Projects$Locations$Schedules$Patch extends StandardParameters { /** - * Mask specifying which fields to read. FieldMask represents a set of + * Immutable. The resource name of the Schedule. */ - readMask?: string; + name?: string; + /** + * Required. The update mask applies to the resource. See google.protobuf.FieldMask. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Schedule; } - export interface Params$Resource$Projects$Locations$Specialistpools$Patch extends StandardParameters { + export interface Params$Resource$Projects$Locations$Schedules$Pause extends StandardParameters { /** - * Required. The resource name of the SpecialistPool. + * Required. The name of the Schedule resource to be paused. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` */ name?: string; + /** - * Required. The update mask applies to the resource. + * Request body metadata */ - updateMask?: string; + requestBody?: Schema$GoogleCloudAiplatformV1PauseScheduleRequest; + } + export interface Params$Resource$Projects$Locations$Schedules$Resume extends StandardParameters { + /** + * Required. The name of the Schedule resource to be resumed. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` + */ + name?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1SpecialistPool; + requestBody?: Schema$GoogleCloudAiplatformV1ResumeScheduleRequest; } - export class Resource$Projects$Locations$Specialistpools$Operations { + export class Resource$Projects$Locations$Schedules$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -143072,11 +143515,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.specialistPools.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.schedules.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/schedules/my-schedule/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -143096,31 +143538,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel, + params: Params$Resource$Projects$Locations$Schedules$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Schedules$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel, + params: Params$Resource$Projects$Locations$Schedules$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel, + params: Params$Resource$Projects$Locations$Schedules$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel, + params: Params$Resource$Projects$Locations$Schedules$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel + | Params$Resource$Projects$Locations$Schedules$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -143136,13 +143578,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Schedules$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Schedules$Operations$Cancel; options = {}; } @@ -143206,11 +143648,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.specialistPools.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.schedules.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/schedules/my-schedule/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -143230,31 +143671,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Delete, + params: Params$Resource$Projects$Locations$Schedules$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Specialistpools$Operations$Delete, + params?: Params$Resource$Projects$Locations$Schedules$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Delete, + params: Params$Resource$Projects$Locations$Schedules$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Delete, + params: Params$Resource$Projects$Locations$Schedules$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Delete, + params: Params$Resource$Projects$Locations$Schedules$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Specialistpools$Operations$Delete + | Params$Resource$Projects$Locations$Schedules$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -143270,13 +143711,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Specialistpools$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Schedules$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Specialistpools$Operations$Delete; + {} as Params$Resource$Projects$Locations$Schedules$Operations$Delete; options = {}; } @@ -143340,11 +143781,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.specialistPools.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.schedules.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/schedules/my-schedule/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -143370,27 +143810,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Get, + params: Params$Resource$Projects$Locations$Schedules$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Specialistpools$Operations$Get, + params?: Params$Resource$Projects$Locations$Schedules$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Get, + params: Params$Resource$Projects$Locations$Schedules$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Get, + params: Params$Resource$Projects$Locations$Schedules$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Get, + params: Params$Resource$Projects$Locations$Schedules$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -143398,7 +143838,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Specialistpools$Operations$Get + | Params$Resource$Projects$Locations$Schedules$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -143414,13 +143854,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Specialistpools$Operations$Get; + {}) as Params$Resource$Projects$Locations$Schedules$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Specialistpools$Operations$Get; + {} as Params$Resource$Projects$Locations$Schedules$Operations$Get; options = {}; } @@ -143484,19 +143924,18 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.specialistPools.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.schedules.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/schedules/my-schedule', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -143520,29 +143959,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$List, + params: Params$Resource$Projects$Locations$Schedules$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Specialistpools$Operations$List, + params?: Params$Resource$Projects$Locations$Schedules$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$List, + params: Params$Resource$Projects$Locations$Schedules$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$List, + params: Params$Resource$Projects$Locations$Schedules$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$List, + params: Params$Resource$Projects$Locations$Schedules$Operations$List, callback: BodyResponseCallback ): void; list( @@ -143550,7 +143989,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Specialistpools$Operations$List + | Params$Resource$Projects$Locations$Schedules$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -143568,13 +144007,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Specialistpools$Operations$List; + {}) as Params$Resource$Projects$Locations$Schedules$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Specialistpools$Operations$List; + {} as Params$Resource$Projects$Locations$Schedules$Operations$List; options = {}; } @@ -143643,13 +144082,12 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.specialistPools.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.schedules.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/schedules/my-schedule/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -143675,27 +144113,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Wait, + params: Params$Resource$Projects$Locations$Schedules$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Specialistpools$Operations$Wait, + params?: Params$Resource$Projects$Locations$Schedules$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Wait, + params: Params$Resource$Projects$Locations$Schedules$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Wait, + params: Params$Resource$Projects$Locations$Schedules$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Wait, + params: Params$Resource$Projects$Locations$Schedules$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -143703,7 +144141,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Specialistpools$Operations$Wait + | Params$Resource$Projects$Locations$Schedules$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -143719,13 +144157,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Specialistpools$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Schedules$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Specialistpools$Operations$Wait; + {} as Params$Resource$Projects$Locations$Schedules$Operations$Wait; options = {}; } @@ -143760,25 +144198,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Schedules$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Specialistpools$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Schedules$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Specialistpools$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Schedules$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Specialistpools$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Schedules$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -143800,7 +144238,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Specialistpools$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Schedules$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -143811,22 +144249,19 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Studies { + export class Resource$Projects$Locations$Specialistpools { context: APIRequestContext; - operations: Resource$Projects$Locations$Studies$Operations; - trials: Resource$Projects$Locations$Studies$Trials; + operations: Resource$Projects$Locations$Specialistpools$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = new Resource$Projects$Locations$Studies$Operations( - this.context - ); - this.trials = new Resource$Projects$Locations$Studies$Trials( - this.context - ); + this.operations = + new Resource$Projects$Locations$Specialistpools$Operations( + this.context + ); } /** - * Creates a Study. A resource name will be generated after creation of the Study. + * Creates a SpecialistPool. * @example * ```js * // Before running the sample: @@ -143855,20 +144290,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.create({ - * // Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project\}/locations/{location\}` + * const res = await aiplatform.projects.locations.specialistPools.create({ + * // Required. The parent Project name for the new SpecialistPool. The form is `projects/{project\}/locations/{location\}`. * parent: 'projects/my-project/locations/my-location', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "createTime": "my_createTime", * // "displayName": "my_displayName", - * // "inactiveReason": "my_inactiveReason", * // "name": "my_name", - * // "state": "my_state", - * // "studySpec": {} + * // "pendingDataLabelingJobs": [], + * // "specialistManagerEmails": [], + * // "specialistManagersCount": 0, + * // "specialistWorkerEmails": [] * // } * }, * }); @@ -143876,12 +144311,11 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "inactiveReason": "my_inactiveReason", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "state": "my_state", - * // "studySpec": {} + * // "response": {} * // } * } * @@ -143898,56 +144332,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Studies$Create, + params: Params$Resource$Projects$Locations$Specialistpools$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Studies$Create, + params?: Params$Resource$Projects$Locations$Specialistpools$Create, options?: MethodOptions - ): Promise>; + ): Promise>; create( - params: Params$Resource$Projects$Locations$Studies$Create, + params: Params$Resource$Projects$Locations$Specialistpools$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Studies$Create, + params: Params$Resource$Projects$Locations$Specialistpools$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Studies$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Specialistpools$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Specialistpools$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Create; + {}) as Params$Resource$Projects$Locations$Specialistpools$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Studies$Create; + params = + {} as Params$Resource$Projects$Locations$Specialistpools$Create; options = {}; } @@ -143960,7 +144395,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/studies').replace( + url: (rootUrl + '/v1/{+parent}/specialistPools').replace( /([^:]\/)\/+/g, '$1' ), @@ -143975,19 +144410,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a Study. + * Deletes a SpecialistPool as well as all Specialists in the pool. * @example * ```js * // Before running the sample: @@ -144016,14 +144449,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.delete({ - * // Required. The name of the Study resource to be deleted. Format: `projects/{project\}/locations/{location\}/studies/{study\}` - * name: 'projects/my-project/locations/my-location/studies/my-studie', + * const res = await aiplatform.projects.locations.specialistPools.delete({ + * // If set to true, any specialist managers in this SpecialistPool will also be deleted. (Otherwise, the request will only work if the SpecialistPool has no specialist managers.) + * force: 'placeholder-value', + * // Required. The resource name of the SpecialistPool to delete. Format: `projects/{project\}/locations/{location\}/specialistPools/{specialist_pool\}` + * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool', * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -144039,52 +144480,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Studies$Delete, + params: Params$Resource$Projects$Locations$Specialistpools$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Studies$Delete, + params?: Params$Resource$Projects$Locations$Specialistpools$Delete, options?: MethodOptions - ): Promise>; + ): Promise>; delete( - params: Params$Resource$Projects$Locations$Studies$Delete, + params: Params$Resource$Projects$Locations$Specialistpools$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Studies$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Specialistpools$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Studies$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Specialistpools$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Specialistpools$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Delete; + {}) as Params$Resource$Projects$Locations$Specialistpools$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Studies$Delete; + params = + {} as Params$Resource$Projects$Locations$Specialistpools$Delete; options = {}; } @@ -144109,17 +144555,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a Study by name. + * Gets a SpecialistPool. * @example * ```js * // Before running the sample: @@ -144148,20 +144594,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.get({ - * // Required. The name of the Study resource. Format: `projects/{project\}/locations/{location\}/studies/{study\}` - * name: 'projects/my-project/locations/my-location/studies/my-studie', + * const res = await aiplatform.projects.locations.specialistPools.get({ + * // Required. The name of the SpecialistPool resource. The form is `projects/{project\}/locations/{location\}/specialistPools/{specialist_pool\}`. + * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool', * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", * // "displayName": "my_displayName", - * // "inactiveReason": "my_inactiveReason", * // "name": "my_name", - * // "state": "my_state", - * // "studySpec": {} + * // "pendingDataLabelingJobs": [], + * // "specialistManagerEmails": [], + * // "specialistManagersCount": 0, + * // "specialistWorkerEmails": [] * // } * } * @@ -144178,56 +144624,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Studies$Get, + params: Params$Resource$Projects$Locations$Specialistpools$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Studies$Get, + params?: Params$Resource$Projects$Locations$Specialistpools$Get, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; get( - params: Params$Resource$Projects$Locations$Studies$Get, + params: Params$Resource$Projects$Locations$Specialistpools$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Studies$Get, + params: Params$Resource$Projects$Locations$Specialistpools$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Studies$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Specialistpools$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Specialistpools$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Get; + {}) as Params$Resource$Projects$Locations$Specialistpools$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Studies$Get; + params = {} as Params$Resource$Projects$Locations$Specialistpools$Get; options = {}; } @@ -144252,19 +144702,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all the studies in a region for an associated project. + * Lists SpecialistPools in a Location. * @example * ```js * // Before running the sample: @@ -144293,20 +144743,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.list({ - * // Optional. The maximum number of studies to return per "page" of results. If unspecified, service will pick an appropriate default. + * const res = await aiplatform.projects.locations.specialistPools.list({ + * // The standard list page size. * pageSize: 'placeholder-value', - * // Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages. + * // The standard list page token. Typically obtained by ListSpecialistPoolsResponse.next_page_token of the previous SpecialistPoolService.ListSpecialistPools call. Return first page if empty. * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list the Study from. Format: `projects/{project\}/locations/{location\}` + * // Required. The name of the SpecialistPool's parent resource. Format: `projects/{project\}/locations/{location\}` * parent: 'projects/my-project/locations/my-location', + * // Mask specifying which fields to read. FieldMask represents a set of + * readMask: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "studies": [] + * // "specialistPools": [] * // } * } * @@ -144323,60 +144775,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Studies$List, + params: Params$Resource$Projects$Locations$Specialistpools$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Studies$List, + params?: Params$Resource$Projects$Locations$Specialistpools$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Studies$List, + params: Params$Resource$Projects$Locations$Specialistpools$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Studies$List, + params: Params$Resource$Projects$Locations$Specialistpools$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Studies$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Specialistpools$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Specialistpools$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$List; + {}) as Params$Resource$Projects$Locations$Specialistpools$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Studies$List; + params = {} as Params$Resource$Projects$Locations$Specialistpools$List; options = {}; } @@ -144389,7 +144841,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/studies').replace( + url: (rootUrl + '/v1/{+parent}/specialistPools').replace( /([^:]\/)\/+/g, '$1' ), @@ -144404,19 +144856,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Looks a study up using the user-defined display_name field instead of the fully qualified resource name. + * Updates a SpecialistPool. * @example * ```js * // Before running the sample: @@ -144445,15 +144897,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.lookup({ - * // Required. The resource name of the Location to get the Study from. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = await aiplatform.projects.locations.specialistPools.patch({ + * // Required. The resource name of the SpecialistPool. + * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool', + * // Required. The update mask applies to the resource. + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "displayName": "my_displayName" + * // "displayName": "my_displayName", + * // "name": "my_name", + * // "pendingDataLabelingJobs": [], + * // "specialistManagerEmails": [], + * // "specialistManagersCount": 0, + * // "specialistWorkerEmails": [] * // } * }, * }); @@ -144461,12 +144920,11 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "inactiveReason": "my_inactiveReason", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "state": "my_state", - * // "studySpec": {} + * // "response": {} * // } * } * @@ -144482,57 +144940,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - lookup( - params: Params$Resource$Projects$Locations$Studies$Lookup, + patch( + params: Params$Resource$Projects$Locations$Specialistpools$Patch, options: StreamMethodOptions ): Promise>; - lookup( - params?: Params$Resource$Projects$Locations$Studies$Lookup, + patch( + params?: Params$Resource$Projects$Locations$Specialistpools$Patch, options?: MethodOptions - ): Promise>; - lookup( - params: Params$Resource$Projects$Locations$Studies$Lookup, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Specialistpools$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - lookup( - params: Params$Resource$Projects$Locations$Studies$Lookup, + patch( + params: Params$Resource$Projects$Locations$Specialistpools$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - lookup( - params: Params$Resource$Projects$Locations$Studies$Lookup, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Specialistpools$Patch, + callback: BodyResponseCallback ): void; - lookup( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - lookup( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Lookup - | BodyResponseCallback + | Params$Resource$Projects$Locations$Specialistpools$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Lookup; + {}) as Params$Resource$Projects$Locations$Specialistpools$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Studies$Lookup; + params = {} as Params$Resource$Projects$Locations$Specialistpools$Patch; options = {}; } @@ -144545,83 +145003,90 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/studies:lookup').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Studies$Create extends StandardParameters { + export interface Params$Resource$Projects$Locations$Specialistpools$Create extends StandardParameters { /** - * Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project\}/locations/{location\}` + * Required. The parent Project name for the new SpecialistPool. The form is `projects/{project\}/locations/{location\}`. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1Study; + requestBody?: Schema$GoogleCloudAiplatformV1SpecialistPool; } - export interface Params$Resource$Projects$Locations$Studies$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Specialistpools$Delete extends StandardParameters { /** - * Required. The name of the Study resource to be deleted. Format: `projects/{project\}/locations/{location\}/studies/{study\}` + * If set to true, any specialist managers in this SpecialistPool will also be deleted. (Otherwise, the request will only work if the SpecialistPool has no specialist managers.) + */ + force?: boolean; + /** + * Required. The resource name of the SpecialistPool to delete. Format: `projects/{project\}/locations/{location\}/specialistPools/{specialist_pool\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Studies$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Specialistpools$Get extends StandardParameters { /** - * Required. The name of the Study resource. Format: `projects/{project\}/locations/{location\}/studies/{study\}` + * Required. The name of the SpecialistPool resource. The form is `projects/{project\}/locations/{location\}/specialistPools/{specialist_pool\}`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Studies$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Specialistpools$List extends StandardParameters { /** - * Optional. The maximum number of studies to return per "page" of results. If unspecified, service will pick an appropriate default. + * The standard list page size. */ pageSize?: number; /** - * Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages. + * The standard list page token. Typically obtained by ListSpecialistPoolsResponse.next_page_token of the previous SpecialistPoolService.ListSpecialistPools call. Return first page if empty. */ pageToken?: string; /** - * Required. The resource name of the Location to list the Study from. Format: `projects/{project\}/locations/{location\}` + * Required. The name of the SpecialistPool's parent resource. Format: `projects/{project\}/locations/{location\}` */ parent?: string; + /** + * Mask specifying which fields to read. FieldMask represents a set of + */ + readMask?: string; } - export interface Params$Resource$Projects$Locations$Studies$Lookup extends StandardParameters { + export interface Params$Resource$Projects$Locations$Specialistpools$Patch extends StandardParameters { /** - * Required. The resource name of the Location to get the Study from. Format: `projects/{project\}/locations/{location\}` + * Required. The resource name of the SpecialistPool. */ - parent?: string; + name?: string; + /** + * Required. The update mask applies to the resource. + */ + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1LookupStudyRequest; + requestBody?: Schema$GoogleCloudAiplatformV1SpecialistPool; } - export class Resource$Projects$Locations$Studies$Operations { + export class Resource$Projects$Locations$Specialistpools$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -144657,10 +145122,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/studies/my-studie/operations/my-operation', - * }); + * const res = + * await aiplatform.projects.locations.specialistPools.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -144680,31 +145146,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Studies$Operations$Cancel, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Studies$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Studies$Operations$Cancel, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Studies$Operations$Cancel, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Studies$Operations$Cancel, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Operations$Cancel + | Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -144720,13 +145186,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Studies$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel; options = {}; } @@ -144790,10 +145256,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/studies/my-studie/operations/my-operation', - * }); + * const res = + * await aiplatform.projects.locations.specialistPools.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -144813,31 +145280,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Studies$Operations$Delete, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Studies$Operations$Delete, + params?: Params$Resource$Projects$Locations$Specialistpools$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Studies$Operations$Delete, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Studies$Operations$Delete, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Studies$Operations$Delete, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Operations$Delete + | Params$Resource$Projects$Locations$Specialistpools$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -144853,13 +145320,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Specialistpools$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Studies$Operations$Delete; + {} as Params$Resource$Projects$Locations$Specialistpools$Operations$Delete; options = {}; } @@ -144923,10 +145390,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/studies/my-studie/operations/my-operation', - * }); + * const res = + * await aiplatform.projects.locations.specialistPools.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -144952,27 +145420,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Studies$Operations$Get, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Studies$Operations$Get, + params?: Params$Resource$Projects$Locations$Specialistpools$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Studies$Operations$Get, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Studies$Operations$Get, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Studies$Operations$Get, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -144980,7 +145448,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Operations$Get + | Params$Resource$Projects$Locations$Specialistpools$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -144996,13 +145464,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Operations$Get; + {}) as Params$Resource$Projects$Locations$Specialistpools$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Studies$Operations$Get; + {} as Params$Resource$Projects$Locations$Specialistpools$Operations$Get; options = {}; } @@ -145066,18 +145534,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/studies/my-studie', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.specialistPools.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -145101,29 +145570,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Studies$Operations$List, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Studies$Operations$List, + params?: Params$Resource$Projects$Locations$Specialistpools$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Studies$Operations$List, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Studies$Operations$List, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Studies$Operations$List, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$List, callback: BodyResponseCallback ): void; list( @@ -145131,7 +145600,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Operations$List + | Params$Resource$Projects$Locations$Specialistpools$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -145149,13 +145618,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Operations$List; + {}) as Params$Resource$Projects$Locations$Specialistpools$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Studies$Operations$List; + {} as Params$Resource$Projects$Locations$Specialistpools$Operations$List; options = {}; } @@ -145224,12 +145693,13 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/studies/my-studie/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.specialistPools.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -145255,27 +145725,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Studies$Operations$Wait, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Studies$Operations$Wait, + params?: Params$Resource$Projects$Locations$Specialistpools$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Studies$Operations$Wait, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Studies$Operations$Wait, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Studies$Operations$Wait, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -145283,7 +145753,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Operations$Wait + | Params$Resource$Projects$Locations$Specialistpools$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -145299,13 +145769,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Specialistpools$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Studies$Operations$Wait; + {} as Params$Resource$Projects$Locations$Specialistpools$Operations$Wait; options = {}; } @@ -145340,25 +145810,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Studies$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Studies$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Specialistpools$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Studies$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Specialistpools$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Studies$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Specialistpools$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -145380,7 +145850,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Studies$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Specialistpools$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -145391,17 +145861,22 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Studies$Trials { + export class Resource$Projects$Locations$Studies { context: APIRequestContext; - operations: Resource$Projects$Locations$Studies$Trials$Operations; + operations: Resource$Projects$Locations$Studies$Operations; + trials: Resource$Projects$Locations$Studies$Trials; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Studies$Trials$Operations(this.context); + this.operations = new Resource$Projects$Locations$Studies$Operations( + this.context + ); + this.trials = new Resource$Projects$Locations$Studies$Trials( + this.context + ); } /** - * Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete. + * Creates a Study. A resource name will be generated after creation of the Study. * @example * ```js * // Before running the sample: @@ -145430,36 +145905,33 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.studies.trials.addTrialMeasurement({ - * // Required. The name of the trial to add measurement. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` - * trialName: - * 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', + * const res = await aiplatform.projects.locations.studies.create({ + * // Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "measurement": {} - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "inactiveReason": "my_inactiveReason", + * // "name": "my_name", + * // "state": "my_state", + * // "studySpec": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "clientId": "my_clientId", - * // "customJob": "my_customJob", - * // "endTime": "my_endTime", - * // "finalMeasurement": {}, - * // "id": "my_id", - * // "infeasibleReason": "my_infeasibleReason", - * // "measurements": [], + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "inactiveReason": "my_inactiveReason", * // "name": "my_name", - * // "parameters": [], - * // "startTime": "my_startTime", * // "state": "my_state", - * // "webAccessUris": {} + * // "studySpec": {} * // } * } * @@ -145475,58 +145947,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - addTrialMeasurement( - params: Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement, + create( + params: Params$Resource$Projects$Locations$Studies$Create, options: StreamMethodOptions ): Promise>; - addTrialMeasurement( - params?: Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement, + create( + params?: Params$Resource$Projects$Locations$Studies$Create, options?: MethodOptions - ): Promise>; - addTrialMeasurement( - params: Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Studies$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addTrialMeasurement( - params: Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement, + create( + params: Params$Resource$Projects$Locations$Studies$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - addTrialMeasurement( - params: Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Studies$Create, + callback: BodyResponseCallback ): void; - addTrialMeasurement( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - addTrialMeasurement( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement; + {}) as Params$Resource$Projects$Locations$Studies$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement; + params = {} as Params$Resource$Projects$Locations$Studies$Create; options = {}; } @@ -145539,7 +146010,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+trialName}:addTrialMeasurement').replace( + url: (rootUrl + '/v1/{+parent}/studies').replace( /([^:]\/)\/+/g, '$1' ), @@ -145549,24 +146020,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['trialName'], - pathParams: ['trialName'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse. + * Deletes a Study. * @example * ```js * // Before running the sample: @@ -145595,30 +146066,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.studies.trials.checkTrialEarlyStoppingState( - * { - * // Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` - * trialName: - * 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }, - * ); + * const res = await aiplatform.projects.locations.studies.delete({ + * // Required. The name of the Study resource to be deleted. Format: `projects/{project\}/locations/{location\}/studies/{study\}` + * name: 'projects/my-project/locations/my-location/studies/my-studie', + * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -145633,58 +146088,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - checkTrialEarlyStoppingState( - params: Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate, + delete( + params: Params$Resource$Projects$Locations$Studies$Delete, options: StreamMethodOptions ): Promise>; - checkTrialEarlyStoppingState( - params?: Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate, + delete( + params?: Params$Resource$Projects$Locations$Studies$Delete, options?: MethodOptions - ): Promise>; - checkTrialEarlyStoppingState( - params: Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Studies$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - checkTrialEarlyStoppingState( - params: Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - checkTrialEarlyStoppingState( - params: Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Studies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - checkTrialEarlyStoppingState( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Studies$Delete, + callback: BodyResponseCallback ): void; - checkTrialEarlyStoppingState( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate; + {}) as Params$Resource$Projects$Locations$Studies$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate; + params = {} as Params$Resource$Projects$Locations$Studies$Delete; options = {}; } @@ -145697,31 +146147,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+trialName}:checkTrialEarlyStoppingState' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['trialName'], - pathParams: ['trialName'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Marks a Trial as complete. + * Gets a Study by name. * @example * ```js * // Before running the sample: @@ -145750,36 +146198,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.trials.complete({ - * // Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` - * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "finalMeasurement": {}, - * // "infeasibleReason": "my_infeasibleReason", - * // "trialInfeasible": false - * // } - * }, + * const res = await aiplatform.projects.locations.studies.get({ + * // Required. The name of the Study resource. Format: `projects/{project\}/locations/{location\}/studies/{study\}` + * name: 'projects/my-project/locations/my-location/studies/my-studie', * }); * console.log(res.data); * * // Example response * // { - * // "clientId": "my_clientId", - * // "customJob": "my_customJob", - * // "endTime": "my_endTime", - * // "finalMeasurement": {}, - * // "id": "my_id", - * // "infeasibleReason": "my_infeasibleReason", - * // "measurements": [], + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "inactiveReason": "my_inactiveReason", * // "name": "my_name", - * // "parameters": [], - * // "startTime": "my_startTime", * // "state": "my_state", - * // "webAccessUris": {} + * // "studySpec": {} * // } * } * @@ -145795,58 +146227,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - complete( - params: Params$Resource$Projects$Locations$Studies$Trials$Complete, + get( + params: Params$Resource$Projects$Locations$Studies$Get, options: StreamMethodOptions ): Promise>; - complete( - params?: Params$Resource$Projects$Locations$Studies$Trials$Complete, + get( + params?: Params$Resource$Projects$Locations$Studies$Get, options?: MethodOptions - ): Promise>; - complete( - params: Params$Resource$Projects$Locations$Studies$Trials$Complete, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Studies$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - complete( - params: Params$Resource$Projects$Locations$Studies$Trials$Complete, + get( + params: Params$Resource$Projects$Locations$Studies$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - complete( - params: Params$Resource$Projects$Locations$Studies$Trials$Complete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Studies$Get, + callback: BodyResponseCallback ): void; - complete( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - complete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Complete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Complete; + {}) as Params$Resource$Projects$Locations$Studies$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Studies$Trials$Complete; + params = {} as Params$Resource$Projects$Locations$Studies$Get; options = {}; } @@ -145859,11 +146290,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:complete').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -145874,19 +146302,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Adds a user provided Trial to a Study. + * Lists all the studies in a region for an associated project. * @example * ```js * // Before running the sample: @@ -145915,45 +146343,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.trials.create({ - * // Required. The resource name of the Study to create the Trial in. Format: `projects/{project\}/locations/{location\}/studies/{study\}` - * parent: 'projects/my-project/locations/my-location/studies/my-studie', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "clientId": "my_clientId", - * // "customJob": "my_customJob", - * // "endTime": "my_endTime", - * // "finalMeasurement": {}, - * // "id": "my_id", - * // "infeasibleReason": "my_infeasibleReason", - * // "measurements": [], - * // "name": "my_name", - * // "parameters": [], - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "webAccessUris": {} - * // } - * }, + * const res = await aiplatform.projects.locations.studies.list({ + * // Optional. The maximum number of studies to return per "page" of results. If unspecified, service will pick an appropriate default. + * pageSize: 'placeholder-value', + * // Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list the Study from. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); * * // Example response * // { - * // "clientId": "my_clientId", - * // "customJob": "my_customJob", - * // "endTime": "my_endTime", - * // "finalMeasurement": {}, - * // "id": "my_id", - * // "infeasibleReason": "my_infeasibleReason", - * // "measurements": [], - * // "name": "my_name", - * // "parameters": [], - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "webAccessUris": {} + * // "nextPageToken": "my_nextPageToken", + * // "studies": [] * // } * } * @@ -145969,57 +146372,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Studies$Trials$Create, + list( + params: Params$Resource$Projects$Locations$Studies$List, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Studies$Trials$Create, + list( + params?: Params$Resource$Projects$Locations$Studies$List, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Studies$Trials$Create, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Studies$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Studies$Trials$Create, + list( + params: Params$Resource$Projects$Locations$Studies$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Studies$Trials$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Studies$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Create; + {}) as Params$Resource$Projects$Locations$Studies$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Studies$Trials$Create; + params = {} as Params$Resource$Projects$Locations$Studies$List; options = {}; } @@ -146032,11 +146439,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/trials').replace( + url: (rootUrl + '/v1/{+parent}/studies').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -146047,19 +146454,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a Trial. + * Looks a study up using the user-defined display_name field instead of the fully qualified resource name. * @example * ```js * // Before running the sample: @@ -146088,14 +146495,29 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.trials.delete({ - * // Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` - * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', + * const res = await aiplatform.projects.locations.studies.lookup({ + * // Required. The resource name of the Location to get the Study from. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "displayName": "my_displayName" + * // } + * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "inactiveReason": "my_inactiveReason", + * // "name": "my_name", + * // "state": "my_state", + * // "studySpec": {} + * // } * } * * main().catch(e => { @@ -146110,53 +146532,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Studies$Trials$Delete, + lookup( + params: Params$Resource$Projects$Locations$Studies$Lookup, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Studies$Trials$Delete, + lookup( + params?: Params$Resource$Projects$Locations$Studies$Lookup, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Studies$Trials$Delete, + ): Promise>; + lookup( + params: Params$Resource$Projects$Locations$Studies$Lookup, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Studies$Trials$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + lookup( + params: Params$Resource$Projects$Locations$Studies$Lookup, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Studies$Trials$Delete, - callback: BodyResponseCallback + lookup( + params: Params$Resource$Projects$Locations$Studies$Lookup, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + lookup( + callback: BodyResponseCallback + ): void; + lookup( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Lookup + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Delete; + {}) as Params$Resource$Projects$Locations$Studies$Lookup; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Studies$Trials$Delete; + params = {} as Params$Resource$Projects$Locations$Studies$Lookup; options = {}; } @@ -146169,29 +146595,90 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/studies:lookup').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Studies$Create extends StandardParameters { /** - * Gets a Trial. + * Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Study; + } + export interface Params$Resource$Projects$Locations$Studies$Delete extends StandardParameters { + /** + * Required. The name of the Study resource to be deleted. Format: `projects/{project\}/locations/{location\}/studies/{study\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Studies$Get extends StandardParameters { + /** + * Required. The name of the Study resource. Format: `projects/{project\}/locations/{location\}/studies/{study\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Studies$List extends StandardParameters { + /** + * Optional. The maximum number of studies to return per "page" of results. If unspecified, service will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list the Study from. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Studies$Lookup extends StandardParameters { + /** + * Required. The resource name of the Location to get the Study from. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1LookupStudyRequest; + } + + export class Resource$Projects$Locations$Studies$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -146220,27 +146707,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.trials.get({ - * // Required. The name of the Trial resource. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` - * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', + * const res = await aiplatform.projects.locations.studies.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/studies/my-studie/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "clientId": "my_clientId", - * // "customJob": "my_customJob", - * // "endTime": "my_endTime", - * // "finalMeasurement": {}, - * // "id": "my_id", - * // "infeasibleReason": "my_infeasibleReason", - * // "measurements": [], - * // "name": "my_name", - * // "parameters": [], - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "webAccessUris": {} - * // } + * // {} * } * * main().catch(e => { @@ -146255,57 +146729,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Studies$Trials$Get, + cancel( + params: Params$Resource$Projects$Locations$Studies$Operations$Cancel, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Studies$Trials$Get, + cancel( + params?: Params$Resource$Projects$Locations$Studies$Operations$Cancel, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Studies$Trials$Get, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Studies$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Studies$Trials$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Studies$Trials$Get, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Studies$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Studies$Operations$Cancel, + callback: BodyResponseCallback ): void; - get( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Get; + {}) as Params$Resource$Projects$Locations$Studies$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Studies$Trials$Get; + params = + {} as Params$Resource$Projects$Locations$Studies$Operations$Cancel; options = {}; } @@ -146318,8 +146789,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -146330,19 +146801,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists the Trials associated with a Study. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -146371,21 +146840,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.trials.list({ - * // Optional. The number of Trials to retrieve per "page" of results. If unspecified, the service will pick an appropriate default. - * pageSize: 'placeholder-value', - * // Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Study to list the Trial from. Format: `projects/{project\}/locations/{location\}/studies/{study\}` - * parent: 'projects/my-project/locations/my-location/studies/my-studie', + * const res = await aiplatform.projects.locations.studies.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/studies/my-studie/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "nextPageToken": "my_nextPageToken", - * // "trials": [] - * // } + * // {} * } * * main().catch(e => { @@ -146400,61 +146862,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Studies$Trials$List, + delete( + params: Params$Resource$Projects$Locations$Studies$Operations$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Studies$Trials$List, + delete( + params?: Params$Resource$Projects$Locations$Studies$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Studies$Trials$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Studies$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Studies$Trials$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Studies$Trials$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Studies$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Studies$Operations$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$List; + {}) as Params$Resource$Projects$Locations$Studies$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Studies$Trials$List; + params = + {} as Params$Resource$Projects$Locations$Studies$Operations$Delete; options = {}; } @@ -146467,34 +146922,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/trials').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -146523,22 +146973,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.studies.trials.listOptimalTrials({ - * // Required. The name of the Study that the optimal Trial belongs to. - * parent: 'projects/my-project/locations/my-location/studies/my-studie', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }); + * const res = await aiplatform.projects.locations.studies.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/studies/my-studie/operations/my-operation', + * }); * console.log(res.data); * * // Example response * // { - * // "optimalTrials": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -146554,62 +147001,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listOptimalTrials( - params: Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials, + get( + params: Params$Resource$Projects$Locations$Studies$Operations$Get, options: StreamMethodOptions ): Promise>; - listOptimalTrials( - params?: Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials, + get( + params?: Params$Resource$Projects$Locations$Studies$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - listOptimalTrials( - params: Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Studies$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listOptimalTrials( - params: Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials, + get( + params: Params$Resource$Projects$Locations$Studies$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listOptimalTrials( - params: Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Studies$Operations$Get, + callback: BodyResponseCallback ): void; - listOptimalTrials( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - listOptimalTrials( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials; + {}) as Params$Resource$Projects$Locations$Studies$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials; + {} as Params$Resource$Projects$Locations$Studies$Operations$Get; options = {}; } @@ -146622,34 +147065,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/trials:listOptimalTrials').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Stops a Trial. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -146678,32 +147116,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.trials.stop({ - * // Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` - * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, + * const res = await aiplatform.projects.locations.studies.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/studies/my-studie', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientId": "my_clientId", - * // "customJob": "my_customJob", - * // "endTime": "my_endTime", - * // "finalMeasurement": {}, - * // "id": "my_id", - * // "infeasibleReason": "my_infeasibleReason", - * // "measurements": [], - * // "name": "my_name", - * // "parameters": [], - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "webAccessUris": {} + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -146719,57 +147150,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - stop( - params: Params$Resource$Projects$Locations$Studies$Trials$Stop, + list( + params: Params$Resource$Projects$Locations$Studies$Operations$List, options: StreamMethodOptions ): Promise>; - stop( - params?: Params$Resource$Projects$Locations$Studies$Trials$Stop, + list( + params?: Params$Resource$Projects$Locations$Studies$Operations$List, options?: MethodOptions - ): Promise>; - stop( - params: Params$Resource$Projects$Locations$Studies$Trials$Stop, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Studies$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - stop( - params: Params$Resource$Projects$Locations$Studies$Trials$Stop, + list( + params: Params$Resource$Projects$Locations$Studies$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - stop( - params: Params$Resource$Projects$Locations$Studies$Trials$Stop, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Studies$Operations$List, + callback: BodyResponseCallback ): void; - stop( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - stop( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Stop - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Stop; + {}) as Params$Resource$Projects$Locations$Studies$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Studies$Trials$Stop; + params = + {} as Params$Resource$Projects$Locations$Studies$Operations$List; options = {}; } @@ -146782,8 +147218,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:stop').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -146794,19 +147233,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -146835,19 +147274,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.trials.suggest({ - * // Required. The project and location that the Study belongs to. Format: `projects/{project\}/locations/{location\}/studies/{study\}` - * parent: 'projects/my-project/locations/my-location/studies/my-studie', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "clientId": "my_clientId", - * // "contexts": [], - * // "suggestionCount": 0 - * // } - * }, + * const res = await aiplatform.projects.locations.studies.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/studies/my-studie/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * @@ -146873,36 +147304,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - suggest( - params: Params$Resource$Projects$Locations$Studies$Trials$Suggest, + wait( + params: Params$Resource$Projects$Locations$Studies$Operations$Wait, options: StreamMethodOptions ): Promise>; - suggest( - params?: Params$Resource$Projects$Locations$Studies$Trials$Suggest, + wait( + params?: Params$Resource$Projects$Locations$Studies$Operations$Wait, options?: MethodOptions ): Promise>; - suggest( - params: Params$Resource$Projects$Locations$Studies$Trials$Suggest, + wait( + params: Params$Resource$Projects$Locations$Studies$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - suggest( - params: Params$Resource$Projects$Locations$Studies$Trials$Suggest, + wait( + params: Params$Resource$Projects$Locations$Studies$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - suggest( - params: Params$Resource$Projects$Locations$Studies$Trials$Suggest, + wait( + params: Params$Resource$Projects$Locations$Studies$Operations$Wait, callback: BodyResponseCallback ): void; - suggest( + wait( callback: BodyResponseCallback ): void; - suggest( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Suggest + | Params$Resource$Projects$Locations$Studies$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -146918,13 +147349,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Suggest; + {}) as Params$Resource$Projects$Locations$Studies$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Studies$Trials$Suggest; + {} as Params$Resource$Projects$Locations$Studies$Operations$Wait; options = {}; } @@ -146937,18 +147368,15 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/trials:suggest').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -146962,118 +147390,68 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement extends StandardParameters { - /** - * Required. The name of the trial to add measurement. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` - */ - trialName?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1AddTrialMeasurementRequest; - } - export interface Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate extends StandardParameters { - /** - * Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` - */ - trialName?: string; - + export interface Params$Resource$Projects$Locations$Studies$Operations$Cancel extends StandardParameters { /** - * Request body metadata + * The name of the operation resource to be cancelled. */ - requestBody?: Schema$GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest; + name?: string; } - export interface Params$Resource$Projects$Locations$Studies$Trials$Complete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Studies$Operations$Delete extends StandardParameters { /** - * Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + * The name of the operation resource to be deleted. */ name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CompleteTrialRequest; } - export interface Params$Resource$Projects$Locations$Studies$Trials$Create extends StandardParameters { - /** - * Required. The resource name of the Study to create the Trial in. Format: `projects/{project\}/locations/{location\}/studies/{study\}` - */ - parent?: string; - + export interface Params$Resource$Projects$Locations$Studies$Operations$Get extends StandardParameters { /** - * Request body metadata + * The name of the operation resource. */ - requestBody?: Schema$GoogleCloudAiplatformV1Trial; + name?: string; } - export interface Params$Resource$Projects$Locations$Studies$Trials$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Studies$Operations$List extends StandardParameters { /** - * Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + * The standard list filter. */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Studies$Trials$Get extends StandardParameters { + filter?: string; /** - * Required. The name of the Trial resource. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + * The name of the operation's parent resource. */ name?: string; - } - export interface Params$Resource$Projects$Locations$Studies$Trials$List extends StandardParameters { /** - * Optional. The number of Trials to retrieve per "page" of results. If unspecified, the service will pick an appropriate default. + * The standard list page size. */ pageSize?: number; /** - * Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the Study to list the Trial from. Format: `projects/{project\}/locations/{location\}/studies/{study\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials extends StandardParameters { - /** - * Required. The name of the Study that the optimal Trial belongs to. - */ - parent?: string; - - /** - * Request body metadata + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - requestBody?: Schema$GoogleCloudAiplatformV1ListOptimalTrialsRequest; + returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Studies$Trials$Stop extends StandardParameters { + export interface Params$Resource$Projects$Locations$Studies$Operations$Wait extends StandardParameters { /** - * Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + * The name of the operation resource to wait on. */ name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1StopTrialRequest; - } - export interface Params$Resource$Projects$Locations$Studies$Trials$Suggest extends StandardParameters { - /** - * Required. The project and location that the Study belongs to. Format: `projects/{project\}/locations/{location\}/studies/{study\}` - */ - parent?: string; - /** - * Request body metadata + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - requestBody?: Schema$GoogleCloudAiplatformV1SuggestTrialsRequest; + timeout?: string; } - export class Resource$Projects$Locations$Studies$Trials$Operations { + export class Resource$Projects$Locations$Studies$Trials { context: APIRequestContext; + operations: Resource$Projects$Locations$Studies$Trials$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Studies$Trials$Operations(this.context); } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete. * @example * ```js * // Before running the sample: @@ -147103,14 +147481,36 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.studies.trials.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial/operations/my-operation', + * await aiplatform.projects.locations.studies.trials.addTrialMeasurement({ + * // Required. The name of the trial to add measurement. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + * trialName: + * 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "measurement": {} + * // } + * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "clientId": "my_clientId", + * // "customJob": "my_customJob", + * // "endTime": "my_endTime", + * // "finalMeasurement": {}, + * // "id": "my_id", + * // "infeasibleReason": "my_infeasibleReason", + * // "measurements": [], + * // "name": "my_name", + * // "parameters": [], + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "webAccessUris": {} + * // } * } * * main().catch(e => { @@ -147125,54 +147525,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel, + addTrialMeasurement( + params: Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel, + addTrialMeasurement( + params?: Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel, + ): Promise>; + addTrialMeasurement( + params: Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + addTrialMeasurement( + params: Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel, - callback: BodyResponseCallback + addTrialMeasurement( + params: Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel - | BodyResponseCallback + addTrialMeasurement( + callback: BodyResponseCallback + ): void; + addTrialMeasurement( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement; options = {}; } @@ -147185,29 +147589,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+trialName}:addTrialMeasurement').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['trialName'], + pathParams: ['trialName'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse. * @example * ```js * // Before running the sample: @@ -147237,14 +147646,29 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.studies.trials.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial/operations/my-operation', - * }); + * await aiplatform.projects.locations.studies.trials.checkTrialEarlyStoppingState( + * { + * // Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + * trialName: + * 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }, + * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -147259,54 +147683,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete, + checkTrialEarlyStoppingState( + params: Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete, + checkTrialEarlyStoppingState( + params?: Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete, + ): Promise>; + checkTrialEarlyStoppingState( + params: Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + checkTrialEarlyStoppingState( + params: Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete, - callback: BodyResponseCallback + checkTrialEarlyStoppingState( + params: Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + checkTrialEarlyStoppingState( + callback: BodyResponseCallback + ): void; + checkTrialEarlyStoppingState( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete; + {} as Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate; options = {}; } @@ -147319,29 +147747,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: ( + rootUrl + '/v1/{+trialName}:checkTrialEarlyStoppingState' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['trialName'], + pathParams: ['trialName'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Marks a Trial as complete. * @example * ```js * // Before running the sample: @@ -147370,21 +147800,36 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.trials.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial/operations/my-operation', + * const res = await aiplatform.projects.locations.studies.trials.complete({ + * // Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "finalMeasurement": {}, + * // "infeasibleReason": "my_infeasibleReason", + * // "trialInfeasible": false + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "clientId": "my_clientId", + * // "customJob": "my_customJob", + * // "endTime": "my_endTime", + * // "finalMeasurement": {}, + * // "id": "my_id", + * // "infeasibleReason": "my_infeasibleReason", + * // "measurements": [], * // "name": "my_name", - * // "response": {} + * // "parameters": [], + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "webAccessUris": {} * // } * } * @@ -147400,58 +147845,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Get, + complete( + params: Params$Resource$Projects$Locations$Studies$Trials$Complete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Studies$Trials$Operations$Get, + complete( + params?: Params$Resource$Projects$Locations$Studies$Trials$Complete, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Get, + ): Promise>; + complete( + params: Params$Resource$Projects$Locations$Studies$Trials$Complete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Get, + complete( + params: Params$Resource$Projects$Locations$Studies$Trials$Complete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Get, - callback: BodyResponseCallback + complete( + params: Params$Resource$Projects$Locations$Studies$Trials$Complete, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + complete( + callback: BodyResponseCallback ): void; - get( + complete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Trials$Complete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Operations$Get; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Complete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Studies$Trials$Operations$Get; + {} as Params$Resource$Projects$Locations$Studies$Trials$Complete; options = {}; } @@ -147464,8 +147909,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:complete').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -147476,17 +147924,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Adds a user provided Trial to a Study. * @example * ```js * // Before running the sample: @@ -147515,26 +147965,45 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.studies.trials.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.studies.trials.create({ + * // Required. The resource name of the Study to create the Trial in. Format: `projects/{project\}/locations/{location\}/studies/{study\}` + * parent: 'projects/my-project/locations/my-location/studies/my-studie', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "clientId": "my_clientId", + * // "customJob": "my_customJob", + * // "endTime": "my_endTime", + * // "finalMeasurement": {}, + * // "id": "my_id", + * // "infeasibleReason": "my_infeasibleReason", + * // "measurements": [], + * // "name": "my_name", + * // "parameters": [], + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "webAccessUris": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "clientId": "my_clientId", + * // "customJob": "my_customJob", + * // "endTime": "my_endTime", + * // "finalMeasurement": {}, + * // "id": "my_id", + * // "infeasibleReason": "my_infeasibleReason", + * // "measurements": [], + * // "name": "my_name", + * // "parameters": [], + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "webAccessUris": {} * // } * } * @@ -147550,62 +148019,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$List, + create( + params: Params$Resource$Projects$Locations$Studies$Trials$Create, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Studies$Trials$Operations$List, + create( + params?: Params$Resource$Projects$Locations$Studies$Trials$Create, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$List, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Studies$Trials$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$List, + create( + params: Params$Resource$Projects$Locations$Studies$Trials$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Studies$Trials$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Trials$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Operations$List; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Studies$Trials$Operations$List; + params = {} as Params$Resource$Projects$Locations$Studies$Trials$Create; options = {}; } @@ -147618,34 +148082,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+parent}/trials').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Deletes a Trial. * @example * ```js * // Before running the sample: @@ -147674,23 +148138,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.studies.trials.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.studies.trials.delete({ + * // Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', + * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -147705,58 +148160,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait, + delete( + params: Params$Resource$Projects$Locations$Studies$Trials$Delete, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait, + delete( + params?: Params$Resource$Projects$Locations$Studies$Trials$Delete, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Studies$Trials$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - wait( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Studies$Trials$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Studies$Trials$Delete, + callback: BodyResponseCallback ): void; - wait( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Trials$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait; + params = {} as Params$Resource$Projects$Locations$Studies$Trials$Delete; options = {}; } @@ -147769,8 +148219,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -147781,82 +148231,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Studies$Trials$Operations$Get extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Studies$Trials$Operations$List extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Tensorboards { - context: APIRequestContext; - experiments: Resource$Projects$Locations$Tensorboards$Experiments; - operations: Resource$Projects$Locations$Tensorboards$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.experiments = - new Resource$Projects$Locations$Tensorboards$Experiments(this.context); - this.operations = new Resource$Projects$Locations$Tensorboards$Operations( - this.context - ); - } /** - * Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned. + * Gets a Trial. * @example * ```js * // Before running the sample: @@ -147885,18 +148270,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.batchRead({ - * // Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}`. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard. - * tensorboard: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', - * // Required. The resource names of the TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` - * timeSeries: 'placeholder-value', + * const res = await aiplatform.projects.locations.studies.trials.get({ + * // Required. The name of the Trial resource. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', * }); * console.log(res.data); * * // Example response * // { - * // "timeSeriesData": [] + * // "clientId": "my_clientId", + * // "customJob": "my_customJob", + * // "endTime": "my_endTime", + * // "finalMeasurement": {}, + * // "id": "my_id", + * // "infeasibleReason": "my_infeasibleReason", + * // "measurements": [], + * // "name": "my_name", + * // "parameters": [], + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "webAccessUris": {} * // } * } * @@ -147912,62 +148305,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchRead( - params: Params$Resource$Projects$Locations$Tensorboards$Batchread, + get( + params: Params$Resource$Projects$Locations$Studies$Trials$Get, options: StreamMethodOptions ): Promise>; - batchRead( - params?: Params$Resource$Projects$Locations$Tensorboards$Batchread, + get( + params?: Params$Resource$Projects$Locations$Studies$Trials$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - batchRead( - params: Params$Resource$Projects$Locations$Tensorboards$Batchread, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Studies$Trials$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchRead( - params: Params$Resource$Projects$Locations$Tensorboards$Batchread, + get( + params: Params$Resource$Projects$Locations$Studies$Trials$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchRead( - params: Params$Resource$Projects$Locations$Tensorboards$Batchread, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Studies$Trials$Get, + callback: BodyResponseCallback ): void; - batchRead( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - batchRead( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Batchread - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Trials$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Batchread; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Batchread; + params = {} as Params$Resource$Projects$Locations$Studies$Trials$Get; options = {}; } @@ -147980,34 +148368,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+tensorboard}:batchRead').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['tensorboard'], - pathParams: ['tensorboard'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Creates a Tensorboard. + * Lists the Trials associated with a Study. * @example * ```js * // Before running the sample: @@ -148036,39 +148421,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.create({ - * // Required. The resource name of the Location to create the Tensorboard in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "blobStoragePathPrefix": "my_blobStoragePathPrefix", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "isDefault": false, - * // "labels": {}, - * // "name": "my_name", - * // "runCount": 0, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" - * // } - * }, + * const res = await aiplatform.projects.locations.studies.trials.list({ + * // Optional. The number of Trials to retrieve per "page" of results. If unspecified, the service will pick an appropriate default. + * pageSize: 'placeholder-value', + * // Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Study to list the Trial from. Format: `projects/{project\}/locations/{location\}/studies/{study\}` + * parent: 'projects/my-project/locations/my-location/studies/my-studie', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "trials": [] * // } * } * @@ -148084,57 +148450,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Tensorboards$Create, + list( + params: Params$Resource$Projects$Locations$Studies$Trials$List, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Tensorboards$Create, + list( + params?: Params$Resource$Projects$Locations$Studies$Trials$List, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Tensorboards$Create, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Studies$Trials$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Tensorboards$Create, + list( + params: Params$Resource$Projects$Locations$Studies$Trials$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Tensorboards$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Studies$Trials$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Trials$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Create; + {}) as Params$Resource$Projects$Locations$Studies$Trials$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Tensorboards$Create; + params = {} as Params$Resource$Projects$Locations$Studies$Trials$List; options = {}; } @@ -148147,11 +148517,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/tensorboards').replace( + url: (rootUrl + '/v1/{+parent}/trials').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -148162,17 +148532,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a Tensorboard. + * Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency * @example * ```js * // Before running the sample: @@ -148201,19 +148573,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.delete({ - * // Required. The name of the Tensorboard to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', - * }); + * const res = + * await aiplatform.projects.locations.studies.trials.listOptimalTrials({ + * // Required. The name of the Study that the optimal Trial belongs to. + * parent: 'projects/my-project/locations/my-location/studies/my-studie', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "optimalTrials": [] * // } * } * @@ -148229,57 +148604,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Delete, + listOptimalTrials( + params: Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Tensorboards$Delete, + listOptimalTrials( + params?: Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + listOptimalTrials( + params: Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Delete, + listOptimalTrials( + params: Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Delete, - callback: BodyResponseCallback + listOptimalTrials( + params: Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + listOptimalTrials( + callback: BodyResponseCallback ): void; - delete( + listOptimalTrials( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Delete; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Tensorboards$Delete; + params = + {} as Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials; options = {}; } @@ -148292,29 +148672,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/trials:listOptimalTrials').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a Tensorboard. + * Stops a Trial. * @example * ```js * // Before running the sample: @@ -148335,10 +148720,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -148346,27 +148728,32 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.get({ - * // Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', + * const res = await aiplatform.projects.locations.studies.trials.stop({ + * // Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, * }); * console.log(res.data); * * // Example response * // { - * // "blobStoragePathPrefix": "my_blobStoragePathPrefix", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "isDefault": false, - * // "labels": {}, + * // "clientId": "my_clientId", + * // "customJob": "my_customJob", + * // "endTime": "my_endTime", + * // "finalMeasurement": {}, + * // "id": "my_id", + * // "infeasibleReason": "my_infeasibleReason", + * // "measurements": [], * // "name": "my_name", - * // "runCount": 0, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" + * // "parameters": [], + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "webAccessUris": {} * // } * } * @@ -148382,61 +148769,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Tensorboards$Get, + stop( + params: Params$Resource$Projects$Locations$Studies$Trials$Stop, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Tensorboards$Get, + stop( + params?: Params$Resource$Projects$Locations$Studies$Trials$Stop, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Get, + ): Promise>; + stop( + params: Params$Resource$Projects$Locations$Studies$Trials$Stop, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Get, + stop( + params: Params$Resource$Projects$Locations$Studies$Trials$Stop, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Get, - callback: BodyResponseCallback + stop( + params: Params$Resource$Projects$Locations$Studies$Trials$Stop, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + stop( + callback: BodyResponseCallback ): void; - get( + stop( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Trials$Stop + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Get; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Stop; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Tensorboards$Get; + params = {} as Params$Resource$Projects$Locations$Studies$Trials$Stop; options = {}; } @@ -148449,8 +148832,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:stop').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -148461,19 +148844,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists Tensorboards in a Location. + * Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse. * @example * ```js * // Before running the sample: @@ -148494,10 +148877,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -148505,26 +148885,29 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.list({ - * // Lists the Tensorboards that match the filter expression. - * filter: 'placeholder-value', - * // Field to use to sort the list. - * orderBy: 'placeholder-value', - * // The maximum number of Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards are returned. The maximum value is 100; values above 100 are coerced to 100. - * pageSize: 'placeholder-value', - * // A page token, received from a previous TensorboardService.ListTensorboards call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboards must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list Tensorboards. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', + * const res = await aiplatform.projects.locations.studies.trials.suggest({ + * // Required. The project and location that the Study belongs to. Format: `projects/{project\}/locations/{location\}/studies/{study\}` + * parent: 'projects/my-project/locations/my-location/studies/my-studie', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "clientId": "my_clientId", + * // "contexts": [], + * // "suggestionCount": 0 + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "tensorboards": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -148540,61 +148923,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Tensorboards$List, + suggest( + params: Params$Resource$Projects$Locations$Studies$Trials$Suggest, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Tensorboards$List, + suggest( + params?: Params$Resource$Projects$Locations$Studies$Trials$Suggest, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Tensorboards$List, + ): Promise>; + suggest( + params: Params$Resource$Projects$Locations$Studies$Trials$Suggest, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Tensorboards$List, + suggest( + params: Params$Resource$Projects$Locations$Studies$Trials$Suggest, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Tensorboards$List, - callback: BodyResponseCallback + suggest( + params: Params$Resource$Projects$Locations$Studies$Trials$Suggest, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + suggest( + callback: BodyResponseCallback ): void; - list( + suggest( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Trials$Suggest + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$List; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Suggest; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Tensorboards$List; + params = + {} as Params$Resource$Projects$Locations$Studies$Trials$Suggest; options = {}; } @@ -148607,11 +148987,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/tensorboards').replace( + url: (rootUrl + '/v1/{+parent}/trials:suggest').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -148622,73 +149002,430 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement extends StandardParameters { /** - * Updates a Tensorboard. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.patch({ - * // Output only. Name of the Tensorboard. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', - * // Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "blobStoragePathPrefix": "my_blobStoragePathPrefix", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "isDefault": false, - * // "labels": {}, - * // "name": "my_name", - * // "runCount": 0, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" - * // } - * }, + * Required. The name of the trial to add measurement. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + */ + trialName?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1AddTrialMeasurementRequest; + } + export interface Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate extends StandardParameters { + /** + * Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + */ + trialName?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest; + } + export interface Params$Resource$Projects$Locations$Studies$Trials$Complete extends StandardParameters { + /** + * Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CompleteTrialRequest; + } + export interface Params$Resource$Projects$Locations$Studies$Trials$Create extends StandardParameters { + /** + * Required. The resource name of the Study to create the Trial in. Format: `projects/{project\}/locations/{location\}/studies/{study\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Trial; + } + export interface Params$Resource$Projects$Locations$Studies$Trials$Delete extends StandardParameters { + /** + * Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Studies$Trials$Get extends StandardParameters { + /** + * Required. The name of the Trial resource. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Studies$Trials$List extends StandardParameters { + /** + * Optional. The number of Trials to retrieve per "page" of results. If unspecified, the service will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages. + */ + pageToken?: string; + /** + * Required. The resource name of the Study to list the Trial from. Format: `projects/{project\}/locations/{location\}/studies/{study\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials extends StandardParameters { + /** + * Required. The name of the Study that the optimal Trial belongs to. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ListOptimalTrialsRequest; + } + export interface Params$Resource$Projects$Locations$Studies$Trials$Stop extends StandardParameters { + /** + * Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1StopTrialRequest; + } + export interface Params$Resource$Projects$Locations$Studies$Trials$Suggest extends StandardParameters { + /** + * Required. The project and location that the Study belongs to. Format: `projects/{project\}/locations/{location\}/studies/{study\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1SuggestTrialsRequest; + } + + export class Resource$Projects$Locations$Studies$Trials$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.studies.trials.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.studies.trials.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.studies.trials.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -148713,36 +149450,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Patch, + get( + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Get, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Tensorboards$Patch, + get( + params?: Params$Resource$Projects$Locations$Studies$Trials$Operations$Get, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Patch, + get( + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Patch, + get( + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Patch, + get( + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Get, callback: BodyResponseCallback ): void; - patch( + get( callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Patch + | Params$Resource$Projects$Locations$Studies$Trials$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -148758,12 +149495,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Patch; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Tensorboards$Patch; + params = + {} as Params$Resource$Projects$Locations$Studies$Trials$Operations$Get; options = {}; } @@ -148777,7 +149515,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -148798,7 +149536,7 @@ export namespace aiplatform_v1 { } /** - * Returns the storage size for a given TensorBoard instance. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -148827,16 +149565,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.readSize({ - * // Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` - * tensorboard: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', - * }); + * const res = + * await aiplatform.projects.locations.studies.trials.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "storageSizeByte": "my_storageSizeByte" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -148852,61 +149600,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - readSize( - params: Params$Resource$Projects$Locations$Tensorboards$Readsize, + list( + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$List, options: StreamMethodOptions ): Promise>; - readSize( - params?: Params$Resource$Projects$Locations$Tensorboards$Readsize, + list( + params?: Params$Resource$Projects$Locations$Studies$Trials$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - readSize( - params: Params$Resource$Projects$Locations$Tensorboards$Readsize, + list( + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - readSize( - params: Params$Resource$Projects$Locations$Tensorboards$Readsize, + list( + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - readSize( - params: Params$Resource$Projects$Locations$Tensorboards$Readsize, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$List, + callback: BodyResponseCallback ): void; - readSize( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - readSize( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Readsize - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Trials$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Readsize; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Tensorboards$Readsize; + params = + {} as Params$Resource$Projects$Locations$Studies$Trials$Operations$List; options = {}; } @@ -148919,7 +149668,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+tensorboard}:readSize').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -148929,24 +149678,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['tensorboard'], - pathParams: ['tensorboard'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Returns a list of monthly active users for a given TensorBoard instance. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -148975,16 +149724,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.readUsage({ - * // Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` - * tensorboard: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', - * }); + * const res = + * await aiplatform.projects.locations.studies.trials.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "monthlyUsageData": {} + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -149000,62 +149755,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - readUsage( - params: Params$Resource$Projects$Locations$Tensorboards$Readusage, + wait( + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait, options: StreamMethodOptions ): Promise>; - readUsage( - params?: Params$Resource$Projects$Locations$Tensorboards$Readusage, + wait( + params?: Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - readUsage( - params: Params$Resource$Projects$Locations$Tensorboards$Readusage, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - readUsage( - params: Params$Resource$Projects$Locations$Tensorboards$Readusage, + wait( + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - readUsage( - params: Params$Resource$Projects$Locations$Tensorboards$Readusage, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait, + callback: BodyResponseCallback ): void; - readUsage( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - readUsage( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Readusage - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Readusage; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Readusage; + {} as Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait; options = {}; } @@ -149068,137 +149819,94 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+tensorboard}:readUsage').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['tensorboard'], - pathParams: ['tensorboard'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Tensorboards$Batchread extends StandardParameters { - /** - * Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}`. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard. - */ - tensorboard?: string; - /** - * Required. The resource names of the TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` - */ - timeSeries?: string[]; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Create extends StandardParameters { - /** - * Required. The resource name of the Location to create the Tensorboard in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - + export interface Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel extends StandardParameters { /** - * Request body metadata + * The name of the operation resource to be cancelled. */ - requestBody?: Schema$GoogleCloudAiplatformV1Tensorboard; + name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete extends StandardParameters { /** - * Required. The name of the Tensorboard to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Studies$Trials$Operations$Get extends StandardParameters { /** - * Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Studies$Trials$Operations$List extends StandardParameters { /** - * Lists the Tensorboards that match the filter expression. + * The standard list filter. */ filter?: string; /** - * Field to use to sort the list. + * The name of the operation's parent resource. */ - orderBy?: string; + name?: string; /** - * The maximum number of Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards are returned. The maximum value is 100; values above 100 are coerced to 100. + * The standard list page size. */ pageSize?: number; /** - * A page token, received from a previous TensorboardService.ListTensorboards call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboards must match the call that provided the page token. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the Location to list Tensorboards. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - readMask?: string; + returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Tensorboards$Patch extends StandardParameters { + export interface Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait extends StandardParameters { /** - * Output only. Name of the Tensorboard. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * The name of the operation resource to wait on. */ name?: string; /** - * Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Tensorboard; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Readsize extends StandardParameters { - /** - * Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` - */ - tensorboard?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Readusage extends StandardParameters { - /** - * Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - tensorboard?: string; + timeout?: string; } - export class Resource$Projects$Locations$Tensorboards$Experiments { + export class Resource$Projects$Locations$Tensorboards { context: APIRequestContext; - operations: Resource$Projects$Locations$Tensorboards$Experiments$Operations; - runs: Resource$Projects$Locations$Tensorboards$Experiments$Runs; + experiments: Resource$Projects$Locations$Tensorboards$Experiments; + operations: Resource$Projects$Locations$Tensorboards$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Tensorboards$Experiments$Operations( - this.context - ); - this.runs = new Resource$Projects$Locations$Tensorboards$Experiments$Runs( + this.experiments = + new Resource$Projects$Locations$Tensorboards$Experiments(this.context); + this.operations = new Resource$Projects$Locations$Tensorboards$Operations( this.context ); } /** - * Batch create TensorboardTimeSeries that belong to a TensorboardExperiment. + * Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned. * @example * ```js * // Before running the sample: @@ -149227,25 +149935,18 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.batchCreate({ - * // Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment. - * parent: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "requests": [] - * // } - * }, - * }); + * const res = await aiplatform.projects.locations.tensorboards.batchRead({ + * // Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}`. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard. + * tensorboard: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', + * // Required. The resource names of the TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + * timeSeries: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "tensorboardTimeSeries": [] + * // "timeSeriesData": [] * // } * } * @@ -149261,62 +149962,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchCreate( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate, + batchRead( + params: Params$Resource$Projects$Locations$Tensorboards$Batchread, options: StreamMethodOptions ): Promise>; - batchCreate( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate, + batchRead( + params?: Params$Resource$Projects$Locations$Tensorboards$Batchread, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - batchCreate( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate, + batchRead( + params: Params$Resource$Projects$Locations$Tensorboards$Batchread, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate, + batchRead( + params: Params$Resource$Projects$Locations$Tensorboards$Batchread, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate, - callback: BodyResponseCallback + batchRead( + params: Params$Resource$Projects$Locations$Tensorboards$Batchread, + callback: BodyResponseCallback ): void; - batchCreate( - callback: BodyResponseCallback + batchRead( + callback: BodyResponseCallback ): void; - batchCreate( + batchRead( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Batchread + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate; + {}) as Params$Resource$Projects$Locations$Tensorboards$Batchread; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate; + {} as Params$Resource$Projects$Locations$Tensorboards$Batchread; options = {}; } @@ -149329,34 +150030,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}:batchCreate').replace( + url: (rootUrl + '/v1/{+tensorboard}:batchRead').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['tensorboard'], + pathParams: ['tensorboard'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Creates a TensorboardExperiment. + * Creates a Tensorboard. * @example * ```js * // Before running the sample: @@ -149385,41 +150086,39 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.create({ - * // Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` - * parent: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', - * // Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`. - * tensorboardExperimentId: 'placeholder-value', + * const res = await aiplatform.projects.locations.tensorboards.create({ + * // Required. The resource name of the Location to create the Tensorboard in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "source": "my_source", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "blobStoragePathPrefix": "my_blobStoragePathPrefix", + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "isDefault": false, + * // "labels": {}, + * // "name": "my_name", + * // "runCount": 0, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "source": "my_source", - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -149436,61 +150135,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Create, + params: Params$Resource$Projects$Locations$Tensorboards$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Create, + params?: Params$Resource$Projects$Locations$Tensorboards$Create, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Create, + params: Params$Resource$Projects$Locations$Tensorboards$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Create, + params: Params$Resource$Projects$Locations$Tensorboards$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Tensorboards$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Create; + {}) as Params$Resource$Projects$Locations$Tensorboards$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Create; + params = {} as Params$Resource$Projects$Locations$Tensorboards$Create; options = {}; } @@ -149503,7 +150197,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/experiments').replace( + url: (rootUrl + '/v1/{+parent}/tensorboards').replace( /([^:]\/)\/+/g, '$1' ), @@ -149518,19 +150212,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a TensorboardExperiment. + * Deletes a Tensorboard. * @example * ```js * // Before running the sample: @@ -149559,11 +150251,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.delete({ - * // Required. The name of the TensorboardExperiment to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', - * }); + * const res = await aiplatform.projects.locations.tensorboards.delete({ + * // Required. The name of the Tensorboard to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', + * }); * console.log(res.data); * * // Example response @@ -149589,27 +150280,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete, + params?: Params$Resource$Projects$Locations$Tensorboards$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Delete, callback: BodyResponseCallback ): void; delete( @@ -149617,7 +150308,7 @@ export namespace aiplatform_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete + | Params$Resource$Projects$Locations$Tensorboards$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -149633,13 +150324,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete; + {}) as Params$Resource$Projects$Locations$Tensorboards$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete; + params = {} as Params$Resource$Projects$Locations$Tensorboards$Delete; options = {}; } @@ -149674,7 +150364,7 @@ export namespace aiplatform_v1 { } /** - * Gets a TensorboardExperiment. + * Gets a Tensorboard. * @example * ```js * // Before running the sample: @@ -149706,21 +150396,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.experiments.get({ - * // Required. The name of the TensorboardExperiment resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', + * const res = await aiplatform.projects.locations.tensorboards.get({ + * // Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', * }); * console.log(res.data); * * // Example response * // { + * // "blobStoragePathPrefix": "my_blobStoragePathPrefix", * // "createTime": "my_createTime", * // "description": "my_description", * // "displayName": "my_displayName", + * // "encryptionSpec": {}, * // "etag": "my_etag", + * // "isDefault": false, * // "labels": {}, * // "name": "my_name", - * // "source": "my_source", + * // "runCount": 0, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, * // "updateTime": "my_updateTime" * // } * } @@ -149738,61 +150433,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Get, + params?: Params$Resource$Projects$Locations$Tensorboards$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Tensorboards$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Get; + {}) as Params$Resource$Projects$Locations$Tensorboards$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Get; + params = {} as Params$Resource$Projects$Locations$Tensorboards$Get; options = {}; } @@ -149817,19 +150511,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists TensorboardExperiments in a Location. + * Lists Tensorboards in a Location. * @example * ```js * // Before running the sample: @@ -149861,29 +150555,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.experiments.list( - * { - * // Lists the TensorboardExperiments that match the filter expression. - * filter: 'placeholder-value', - * // Field to use to sort the list. - * orderBy: 'placeholder-value', - * // The maximum number of TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments are returned. The maximum value is 1000; values above 1000 are coerced to 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous TensorboardService.ListTensorboardExperiments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardExperiments must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` - * parent: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.projects.locations.tensorboards.list({ + * // Lists the Tensorboards that match the filter expression. + * filter: 'placeholder-value', + * // Field to use to sort the list. + * orderBy: 'placeholder-value', + * // The maximum number of Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards are returned. The maximum value is 100; values above 100 are coerced to 100. + * pageSize: 'placeholder-value', + * // A page token, received from a previous TensorboardService.ListTensorboards call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboards must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list Tensorboards. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "tensorboardExperiments": [] + * // "tensorboards": [] * // } * } * @@ -149900,61 +150591,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$List, + params: Params$Resource$Projects$Locations$Tensorboards$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$List, + params?: Params$Resource$Projects$Locations$Tensorboards$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$List, + params: Params$Resource$Projects$Locations$Tensorboards$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$List, + params: Params$Resource$Projects$Locations$Tensorboards$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Tensorboards$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$List; + {}) as Params$Resource$Projects$Locations$Tensorboards$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$List; + params = {} as Params$Resource$Projects$Locations$Tensorboards$List; options = {}; } @@ -149967,7 +150657,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/experiments').replace( + url: (rootUrl + '/v1/{+parent}/tensorboards').replace( /([^:]\/)\/+/g, '$1' ), @@ -149982,19 +150672,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a TensorboardExperiment. + * Updates a Tensorboard. * @example * ```js * // Before running the sample: @@ -150023,40 +150713,41 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.patch({ - * // Output only. Name of the TensorboardExperiment. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', - * // Required. Field mask is used to specify the fields to be overwritten in the TensorboardExperiment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. - * updateMask: 'placeholder-value', + * const res = await aiplatform.projects.locations.tensorboards.patch({ + * // Output only. Name of the Tensorboard. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', + * // Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. + * updateMask: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "source": "my_source", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "blobStoragePathPrefix": "my_blobStoragePathPrefix", + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "isDefault": false, + * // "labels": {}, + * // "name": "my_name", + * // "runCount": 0, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "source": "my_source", - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -150073,61 +150764,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch, + params: Params$Resource$Projects$Locations$Tensorboards$Patch, options: StreamMethodOptions ): Promise>; patch( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch, + params?: Params$Resource$Projects$Locations$Tensorboards$Patch, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch, + params: Params$Resource$Projects$Locations$Tensorboards$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch, + params: Params$Resource$Projects$Locations$Tensorboards$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Tensorboards$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch; + {}) as Params$Resource$Projects$Locations$Tensorboards$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch; + params = {} as Params$Resource$Projects$Locations$Tensorboards$Patch; options = {}; } @@ -150152,19 +150838,165 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest(parameters); + } + } + + /** + * Returns the storage size for a given TensorBoard instance. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.tensorboards.readSize({ + * // Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * tensorboard: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "storageSizeByte": "my_storageSizeByte" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + readSize( + params: Params$Resource$Projects$Locations$Tensorboards$Readsize, + options: StreamMethodOptions + ): Promise>; + readSize( + params?: Params$Resource$Projects$Locations$Tensorboards$Readsize, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + readSize( + params: Params$Resource$Projects$Locations$Tensorboards$Readsize, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + readSize( + params: Params$Resource$Projects$Locations$Tensorboards$Readsize, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + readSize( + params: Params$Resource$Projects$Locations$Tensorboards$Readsize, + callback: BodyResponseCallback + ): void; + readSize( + callback: BodyResponseCallback + ): void; + readSize( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Tensorboards$Readsize + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Tensorboards$Readsize; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Tensorboards$Readsize; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+tensorboard}:readSize').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['tensorboard'], + pathParams: ['tensorboard'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( parameters ); } } /** - * Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned. + * Returns a list of monthly active users for a given TensorBoard instance. * @example * ```js * // Before running the sample: @@ -150193,24 +151025,17 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.write({ - * // Required. The resource name of the TensorboardExperiment to write data to. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` - * tensorboardExperiment: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "writeRunDataRequests": [] - * // } - * }, - * }); + * const res = await aiplatform.projects.locations.tensorboards.readUsage({ + * // Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * tensorboard: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "monthlyUsageData": {} + * // } * } * * main().catch(e => { @@ -150225,62 +151050,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - write( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Write, + readUsage( + params: Params$Resource$Projects$Locations$Tensorboards$Readusage, options: StreamMethodOptions ): Promise>; - write( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Write, + readUsage( + params?: Params$Resource$Projects$Locations$Tensorboards$Readusage, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - write( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Write, + readUsage( + params: Params$Resource$Projects$Locations$Tensorboards$Readusage, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - write( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Write, + readUsage( + params: Params$Resource$Projects$Locations$Tensorboards$Readusage, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - write( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Write, - callback: BodyResponseCallback + readUsage( + params: Params$Resource$Projects$Locations$Tensorboards$Readusage, + callback: BodyResponseCallback ): void; - write( - callback: BodyResponseCallback + readUsage( + callback: BodyResponseCallback ): void; - write( + readUsage( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Write - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Readusage + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Write; + {}) as Params$Resource$Projects$Locations$Tensorboards$Readusage; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Write; + {} as Params$Resource$Projects$Locations$Tensorboards$Readusage; options = {}; } @@ -150293,74 +151118,69 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+tensorboardExperiment}:write').replace( + url: (rootUrl + '/v1/{+tensorboard}:readUsage').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['tensorboardExperiment'], - pathParams: ['tensorboardExperiment'], + requiredParams: ['tensorboard'], + pathParams: ['tensorboard'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Batchread extends StandardParameters { /** - * Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment. + * Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}`. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard. */ - parent?: string; - + tensorboard?: string; /** - * Request body metadata + * Required. The resource names of the TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` */ - requestBody?: Schema$GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest; + timeSeries?: string[]; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Create extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Create extends StandardParameters { /** - * Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * Required. The resource name of the Location to create the Tensorboard in. Format: `projects/{project\}/locations/{location\}` */ parent?: string; - /** - * Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`. - */ - tensorboardExperimentId?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1TensorboardExperiment; + requestBody?: Schema$GoogleCloudAiplatformV1Tensorboard; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Delete extends StandardParameters { /** - * Required. The name of the TensorboardExperiment to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + * Required. The name of the Tensorboard to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Get extends StandardParameters { /** - * Required. The name of the TensorboardExperiment resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + * Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$List extends StandardParameters { /** - * Lists the TensorboardExperiments that match the filter expression. + * Lists the Tensorboards that match the filter expression. */ filter?: string; /** @@ -150368,15 +151188,15 @@ export namespace aiplatform_v1 { */ orderBy?: string; /** - * The maximum number of TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments are returned. The maximum value is 1000; values above 1000 are coerced to 1000. + * The maximum number of Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards are returned. The maximum value is 100; values above 100 are coerced to 100. */ pageSize?: number; /** - * A page token, received from a previous TensorboardService.ListTensorboardExperiments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardExperiments must match the call that provided the page token. + * A page token, received from a previous TensorboardService.ListTensorboards call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboards must match the call that provided the page token. */ pageToken?: string; /** - * Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * Required. The resource name of the Location to list Tensorboards. Format: `projects/{project\}/locations/{location\}` */ parent?: string; /** @@ -150384,41 +151204,51 @@ export namespace aiplatform_v1 { */ readMask?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Patch extends StandardParameters { /** - * Output only. Name of the TensorboardExperiment. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + * Output only. Name of the Tensorboard. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` */ name?: string; /** - * Required. Field mask is used to specify the fields to be overwritten in the TensorboardExperiment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. + * Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1TensorboardExperiment; + requestBody?: Schema$GoogleCloudAiplatformV1Tensorboard; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Write extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Readsize extends StandardParameters { /** - * Required. The resource name of the TensorboardExperiment to write data to. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + * Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` */ - tensorboardExperiment?: string; - + tensorboard?: string; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Readusage extends StandardParameters { /** - * Request body metadata + * Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` */ - requestBody?: Schema$GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest; + tensorboard?: string; } - export class Resource$Projects$Locations$Tensorboards$Experiments$Operations { + export class Resource$Projects$Locations$Tensorboards$Experiments { context: APIRequestContext; + operations: Resource$Projects$Locations$Tensorboards$Experiments$Operations; + runs: Resource$Projects$Locations$Tensorboards$Experiments$Runs; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Tensorboards$Experiments$Operations( + this.context + ); + this.runs = new Resource$Projects$Locations$Tensorboards$Experiments$Runs( + this.context + ); } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Batch create TensorboardTimeSeries that belong to a TensorboardExperiment. * @example * ```js * // Before running the sample: @@ -150448,16 +151278,25 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.operations.cancel( - * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/operations/my-operation', + * await aiplatform.projects.locations.tensorboards.experiments.batchCreate({ + * // Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment. + * parent: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "requests": [] + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "tensorboardTimeSeries": [] + * // } * } * * main().catch(e => { @@ -150472,54 +151311,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel, + batchCreate( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel, + batchCreate( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel, + ): Promise< + GaxiosResponseWithHTTP2 + >; + batchCreate( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + batchCreate( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel, - callback: BodyResponseCallback + batchCreate( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + batchCreate( + callback: BodyResponseCallback + ): void; + batchCreate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate; options = {}; } @@ -150532,29 +151379,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}:batchCreate').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Creates a TensorboardExperiment. * @example * ```js * // Before running the sample: @@ -150584,16 +151436,41 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/operations/my-operation', + * await aiplatform.projects.locations.tensorboards.experiments.create({ + * // Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * parent: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', + * // Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`. + * tensorboardExperimentId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "source": "my_source", + * // "updateTime": "my_updateTime" + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "source": "my_source", + * // "updateTime": "my_updateTime" + * // } * } * * main().catch(e => { @@ -150608,54 +151485,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete, + create( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Create, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete, + create( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Create, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Create, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Create; options = {}; } @@ -150668,29 +151553,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/experiments').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Deletes a TensorboardExperiment. * @example * ```js * // Before running the sample: @@ -150720,12 +151610,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/operations/my-operation', - * }, - * ); + * await aiplatform.projects.locations.tensorboards.experiments.delete({ + * // Required. The name of the TensorboardExperiment to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', + * }); * console.log(res.data); * * // Example response @@ -150750,36 +151638,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get, + delete( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete, options?: MethodOptions ): Promise>; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete, callback: BodyResponseCallback ): void; - get( + delete( callback: BodyResponseCallback ): void; - get( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -150795,13 +151683,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete; options = {}; } @@ -150815,7 +151703,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -150836,7 +151724,7 @@ export namespace aiplatform_v1 { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Gets a TensorboardExperiment. * @example * ```js * // Before running the sample: @@ -150857,7 +151745,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -150865,28 +151756,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.projects.locations.tensorboards.experiments.get({ + * // Required. The name of the TensorboardExperiment resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "source": "my_source", + * // "updateTime": "my_updateTime" * // } * } * @@ -150902,62 +151787,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List, + get( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Get; options = {}; } @@ -150970,10 +151855,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -150985,19 +151867,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Lists TensorboardExperiments in a Location. * @example * ```js * // Before running the sample: @@ -151018,7 +151900,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -151026,24 +151911,29 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.projects.locations.tensorboards.experiments.list( + * { + * // Lists the TensorboardExperiments that match the filter expression. + * filter: 'placeholder-value', + * // Field to use to sort the list. + * orderBy: 'placeholder-value', + * // The maximum number of TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments are returned. The maximum value is 1000; values above 1000 are coerced to 1000. + * pageSize: 'placeholder-value', + * // A page token, received from a previous TensorboardService.ListTensorboardExperiments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardExperiments must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * parent: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "tensorboardExperiments": [] * // } * } * @@ -151059,58 +151949,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait, + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$List, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait, + list( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$List, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait, + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$List, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - wait( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$List; options = {}; } @@ -151123,97 +152017,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+parent}/experiments').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Tensorboards$Experiments$Runs { - context: APIRequestContext; - operations: Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations; - timeSeries: Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations( - this.context - ); - this.timeSeries = - new Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries( - this.context + return createAPIRequest( + parameters ); + } } /** - * Batch create TensorboardRuns. + * Updates a TensorboardExperiment. * @example * ```js * // Before running the sample: @@ -151243,26 +152074,39 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.batchCreate( - * { - * // Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` The parent field in the CreateTensorboardRunRequest messages must match this field. - * parent: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', + * await aiplatform.projects.locations.tensorboards.experiments.patch({ + * // Output only. Name of the TensorboardExperiment. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', + * // Required. Field mask is used to specify the fields to be overwritten in the TensorboardExperiment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. + * updateMask: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "requests": [] - * // } - * }, + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "source": "my_source", + * // "updateTime": "my_updateTime" + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response * // { - * // "tensorboardRuns": [] + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "source": "my_source", + * // "updateTime": "my_updateTime" * // } * } * @@ -151278,62 +152122,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchCreate( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate, + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch, options: StreamMethodOptions ): Promise>; - batchCreate( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate, + patch( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - batchCreate( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate, + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate, + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchCreate( - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch, + callback: BodyResponseCallback ): void; - batchCreate( + patch( + callback: BodyResponseCallback + ): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch; options = {}; } @@ -151346,34 +152190,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/runs:batchCreate').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Creates a TensorboardRun. + * Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned. * @example * ```js * // Before running the sample: @@ -151403,39 +152244,23 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.create({ - * // Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` - * parent: + * await aiplatform.projects.locations.tensorboards.experiments.write({ + * // Required. The resource name of the TensorboardExperiment to write data to. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + * tensorboardExperiment: * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', - * // Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`. - * tensorboardRunId: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "updateTime": "my_updateTime" + * // "writeRunDataRequests": [] * // } * }, * }); * console.log(res.data); * * // Example response - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "updateTime": "my_updateTime" - * // } + * // {} * } * * main().catch(e => { @@ -151450,62 +152275,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create, + write( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Write, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create, + write( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Write, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create, + write( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Write, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create, + write( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Write, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create, - callback: BodyResponseCallback + write( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Write, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + write( + callback: BodyResponseCallback ): void; - create( + write( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Write + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Write; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Write; options = {}; } @@ -151518,31 +152343,132 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/runs').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+tensorboardExperiment}:write').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['tensorboardExperiment'], + pathParams: ['tensorboardExperiment'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate extends StandardParameters { + /** + * Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Create extends StandardParameters { + /** + * Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + */ + parent?: string; + /** + * Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`. + */ + tensorboardExperimentId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1TensorboardExperiment; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete extends StandardParameters { + /** + * Required. The name of the TensorboardExperiment to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Get extends StandardParameters { + /** + * Required. The name of the TensorboardExperiment resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$List extends StandardParameters { + /** + * Lists the TensorboardExperiments that match the filter expression. + */ + filter?: string; + /** + * Field to use to sort the list. + */ + orderBy?: string; + /** + * The maximum number of TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments are returned. The maximum value is 1000; values above 1000 are coerced to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous TensorboardService.ListTensorboardExperiments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardExperiments must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch extends StandardParameters { + /** + * Output only. Name of the TensorboardExperiment. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + */ + name?: string; + /** + * Required. Field mask is used to specify the fields to be overwritten in the TensorboardExperiment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1TensorboardExperiment; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Write extends StandardParameters { + /** + * Required. The resource name of the TensorboardExperiment to write data to. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + */ + tensorboardExperiment?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest; + } + + export class Resource$Projects$Locations$Tensorboards$Experiments$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Deletes a TensorboardRun. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -151572,20 +152498,16 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.delete({ - * // Required. The name of the TensorboardRun to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', - * }); + * await aiplatform.projects.locations.tensorboards.experiments.operations.cancel( + * { + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -151600,58 +152522,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete, + cancel( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete, + cancel( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel, + callback: BodyResponseCallback ): void; - delete( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel; options = {}; } @@ -151664,8 +152582,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -151676,17 +152594,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a TensorboardRun. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -151707,10 +152625,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -151719,22 +152634,16 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.get({ - * // Required. The name of the TensorboardRun resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', - * }); + * await aiplatform.projects.locations.tensorboards.experiments.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "updateTime": "my_updateTime" - * // } + * // {} * } * * main().catch(e => { @@ -151749,62 +152658,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get, + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get, + delete( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete, + callback: BodyResponseCallback ): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete; options = {}; } @@ -151818,7 +152719,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -151829,19 +152730,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists TensorboardRuns in a Location. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -151862,10 +152761,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -151874,27 +152770,21 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.list({ - * // Lists the TensorboardRuns that match the filter expression. - * filter: 'placeholder-value', - * // Field to use to sort the list. - * orderBy: 'placeholder-value', - * // The maximum number of TensorboardRuns to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardRuns are returned. The maximum value is 1000; values above 1000 are coerced to 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` - * parent: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }); + * await aiplatform.projects.locations.tensorboards.experiments.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "tensorboardRuns": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -151910,62 +152800,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List, + get( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get; options = {}; } @@ -151978,31 +152864,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/runs').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a TensorboardRun. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -152032,37 +152916,27 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.patch({ - * // Output only. Name of the TensorboardRun. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', - * // Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "updateTime": "my_updateTime" - * // } + * await aiplatform.projects.locations.tensorboards.experiments.operations.list( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, - * }); + * ); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "updateTime": "my_updateTime" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -152078,62 +152952,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch, + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch, + list( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch, + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch, + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - patch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List; options = {}; } @@ -152146,8 +153020,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -152158,19 +153035,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -152200,24 +153077,24 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.write({ - * // Required. The resource name of the TensorboardRun to write data to. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` - * tensorboardRun: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "tensorboardRun": "my_tensorboardRun", - * // "timeSeriesData": [] - * // } + * await aiplatform.projects.locations.tensorboards.experiments.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }, - * }); + * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -152232,62 +153109,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - write( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write, + wait( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait, options: StreamMethodOptions ): Promise>; - write( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write, + wait( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - write( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - write( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write, + wait( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - write( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait, + callback: BodyResponseCallback ): void; - write( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - write( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait; options = {}; } @@ -152300,132 +153173,97 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+tensorboardRun}:write').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['tensorboardRun'], - pathParams: ['tensorboardRun'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate extends StandardParameters { - /** - * Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` The parent field in the CreateTensorboardRunRequest messages must match this field. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create extends StandardParameters { - /** - * Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` - */ - parent?: string; - /** - * Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`. - */ - tensorboardRunId?: string; - + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel extends StandardParameters { /** - * Request body metadata + * The name of the operation resource to be cancelled. */ - requestBody?: Schema$GoogleCloudAiplatformV1TensorboardRun; + name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete extends StandardParameters { /** - * Required. The name of the TensorboardRun to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get extends StandardParameters { /** - * Required. The name of the TensorboardRun resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List extends StandardParameters { /** - * Lists the TensorboardRuns that match the filter expression. + * The standard list filter. */ filter?: string; /** - * Field to use to sort the list. + * The name of the operation's parent resource. */ - orderBy?: string; + name?: string; /** - * The maximum number of TensorboardRuns to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardRuns are returned. The maximum value is 1000; values above 1000 are coerced to 1000. + * The standard list page size. */ pageSize?: number; /** - * A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns must match the call that provided the page token. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - readMask?: string; + returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait extends StandardParameters { /** - * Output only. Name of the TensorboardRun. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` + * The name of the operation resource to wait on. */ name?: string; /** - * Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1TensorboardRun; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write extends StandardParameters { - /** - * Required. The resource name of the TensorboardRun to write data to. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` - */ - tensorboardRun?: string; - - /** - * Request body metadata + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - requestBody?: Schema$GoogleCloudAiplatformV1WriteTensorboardRunDataRequest; + timeout?: string; } - export class Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations { + export class Resource$Projects$Locations$Tensorboards$Experiments$Runs { context: APIRequestContext; + operations: Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations; + timeSeries: Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations( + this.context + ); + this.timeSeries = + new Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries( + this.context + ); } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Batch create TensorboardRuns. * @example * ```js * // Before running the sample: @@ -152455,16 +153293,27 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.operations.cancel( + * await aiplatform.projects.locations.tensorboards.experiments.runs.batchCreate( * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/operations/my-operation', + * // Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` The parent field in the CreateTensorboardRunRequest messages must match this field. + * parent: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "requests": [] + * // } + * }, * }, * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "tensorboardRuns": [] + * // } * } * * main().catch(e => { @@ -152479,54 +153328,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel, + batchCreate( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel, + batchCreate( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel, + ): Promise< + GaxiosResponseWithHTTP2 + >; + batchCreate( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + batchCreate( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel, - callback: BodyResponseCallback + batchCreate( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + batchCreate( + callback: BodyResponseCallback + ): void; + batchCreate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate; options = {}; } @@ -152539,29 +153396,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/runs:batchCreate').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Creates a TensorboardRun. * @example * ```js * // Before running the sample: @@ -152591,16 +153453,39 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/operations/my-operation', + * await aiplatform.projects.locations.tensorboards.experiments.runs.create({ + * // Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + * parent: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', + * // Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`. + * tensorboardRunId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } * } * * main().catch(e => { @@ -152615,54 +153500,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete, + create( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete, + create( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create; options = {}; } @@ -152675,29 +153568,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/runs').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Deletes a TensorboardRun. * @example * ```js * // Before running the sample: @@ -152727,12 +153622,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/operations/my-operation', - * }, - * ); + * await aiplatform.projects.locations.tensorboards.experiments.runs.delete({ + * // Required. The name of the TensorboardRun to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', + * }); * console.log(res.data); * * // Example response @@ -152757,36 +153650,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get, + delete( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete, options?: MethodOptions ): Promise>; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete, callback: BodyResponseCallback ): void; - get( + delete( callback: BodyResponseCallback ): void; - get( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -152802,13 +153695,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete; options = {}; } @@ -152822,7 +153715,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -152843,7 +153736,7 @@ export namespace aiplatform_v1 { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Gets a TensorboardRun. * @example * ```js * // Before running the sample: @@ -152864,8 +153757,11 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], + * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); @@ -152873,27 +153769,21 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * await aiplatform.projects.locations.tensorboards.experiments.runs.get({ + * // Required. The name of the TensorboardRun resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" * // } * } * @@ -152909,62 +153799,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List, + get( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get; options = {}; } @@ -152977,10 +153867,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -152992,19 +153879,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Lists TensorboardRuns in a Location. * @example * ```js * // Before running the sample: @@ -153025,7 +153912,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -153034,23 +153924,27 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }, - * ); + * await aiplatform.projects.locations.tensorboards.experiments.runs.list({ + * // Lists the TensorboardRuns that match the filter expression. + * filter: 'placeholder-value', + * // Field to use to sort the list. + * orderBy: 'placeholder-value', + * // The maximum number of TensorboardRuns to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardRuns are returned. The maximum value is 1000; values above 1000 are coerced to 1000. + * pageSize: 'placeholder-value', + * // A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + * parent: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "tensorboardRuns": [] * // } * } * @@ -153066,58 +153960,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait, + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait, + list( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait, + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - wait( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List; options = {}; } @@ -153130,92 +154028,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+parent}/runs').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries { - context: APIRequestContext; - operations: Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations( - this.context + return createAPIRequest( + parameters ); + } } /** - * Creates a TensorboardTimeSeries. + * Updates a TensorboardRun. * @example * ```js * // Before running the sample: @@ -153245,32 +154082,26 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.create( - * { - * // Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` - * parent: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', - * // Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match "a-z0-9{0, 127\}" - * tensorboardTimeSeriesId: 'placeholder-value', + * await aiplatform.projects.locations.tensorboards.experiments.runs.patch({ + * // Output only. Name of the TensorboardRun. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', + * // Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. + * updateMask: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "metadata": {}, - * // "name": "my_name", - * // "pluginData": "my_pluginData", - * // "pluginName": "my_pluginName", - * // "updateTime": "my_updateTime", - * // "valueType": "my_valueType" - * // } - * }, + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response @@ -153279,12 +154110,9 @@ export namespace aiplatform_v1 { * // "description": "my_description", * // "displayName": "my_displayName", * // "etag": "my_etag", - * // "metadata": {}, + * // "labels": {}, * // "name": "my_name", - * // "pluginData": "my_pluginData", - * // "pluginName": "my_pluginName", - * // "updateTime": "my_updateTime", - * // "valueType": "my_valueType" + * // "updateTime": "my_updateTime" * // } * } * @@ -153300,62 +154128,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create, + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create, + patch( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create, + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create, + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - create( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch; options = {}; } @@ -153368,34 +154196,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/timeSeries').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a TensorboardTimeSeries. + * Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned. * @example * ```js * // Before running the sample: @@ -153425,22 +154250,24 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete( - * { - * // Required. The name of the TensorboardTimeSeries to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', + * await aiplatform.projects.locations.tensorboards.experiments.runs.write({ + * // Required. The resource name of the TensorboardRun to write data to. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` + * tensorboardRun: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "tensorboardRun": "my_tensorboardRun", + * // "timeSeriesData": [] + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -153455,58 +154282,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete, + write( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete, + write( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + write( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete, + write( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete, - callback: BodyResponseCallback + write( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + write( + callback: BodyResponseCallback ): void; - delete( + write( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write; options = {}; } @@ -153519,29 +154350,132 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+tensorboardRun}:write').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['tensorboardRun'], + pathParams: ['tensorboardRun'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate extends StandardParameters { /** - * Exports a TensorboardTimeSeries' data. Data is returned in paginated responses. + * Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` The parent field in the CreateTensorboardRunRequest messages must match this field. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create extends StandardParameters { + /** + * Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + */ + parent?: string; + /** + * Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`. + */ + tensorboardRunId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1TensorboardRun; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete extends StandardParameters { + /** + * Required. The name of the TensorboardRun to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get extends StandardParameters { + /** + * Required. The name of the TensorboardRun resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List extends StandardParameters { + /** + * Lists the TensorboardRuns that match the filter expression. + */ + filter?: string; + /** + * Field to use to sort the list. + */ + orderBy?: string; + /** + * The maximum number of TensorboardRuns to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardRuns are returned. The maximum value is 1000; values above 1000 are coerced to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch extends StandardParameters { + /** + * Output only. Name of the TensorboardRun. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` + */ + name?: string; + /** + * Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1TensorboardRun; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write extends StandardParameters { + /** + * Required. The resource name of the TensorboardRun to write data to. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` + */ + tensorboardRun?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1WriteTensorboardRunDataRequest; + } + + export class Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -153571,31 +154505,16 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.exportTensorboardTimeSeries( + * await aiplatform.projects.locations.tensorboards.experiments.runs.operations.cancel( * { - * // Required. The resource name of the TensorboardTimeSeries to export data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` - * tensorboardTimeSeries: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "filter": "my_filter", - * // "orderBy": "my_orderBy", - * // "pageSize": 0, - * // "pageToken": "my_pageToken" - * // } - * }, + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/operations/my-operation', * }, * ); * console.log(res.data); * * // Example response - * // { - * // "nextPageToken": "my_nextPageToken", - * // "timeSeriesDataPoints": [] - * // } + * // {} * } * * main().catch(e => { @@ -153610,62 +154529,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - exportTensorboardTimeSeries( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries, + cancel( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel, options: StreamMethodOptions ): Promise>; - exportTensorboardTimeSeries( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries, + cancel( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - exportTensorboardTimeSeries( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - exportTensorboardTimeSeries( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - exportTensorboardTimeSeries( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - exportTensorboardTimeSeries( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel, + callback: BodyResponseCallback ): void; - exportTensorboardTimeSeries( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel; options = {}; } @@ -153678,34 +154589,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + - '/v1/{+tensorboardTimeSeries}:exportTensorboardTimeSeries' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['tensorboardTimeSeries'], - pathParams: ['tensorboardTimeSeries'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets a TensorboardTimeSeries. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -153726,10 +154632,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -153738,27 +154641,16 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.get( + * await aiplatform.projects.locations.tensorboards.experiments.runs.operations.delete( * { - * // Required. The name of the TensorboardTimeSeries resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/operations/my-operation', * }, * ); * console.log(res.data); * * // Example response - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "metadata": {}, - * // "name": "my_name", - * // "pluginData": "my_pluginData", - * // "pluginName": "my_pluginName", - * // "updateTime": "my_updateTime", - * // "valueType": "my_valueType" - * // } + * // {} * } * * main().catch(e => { @@ -153773,62 +154665,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get, + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get, + delete( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete, + callback: BodyResponseCallback ): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete; options = {}; } @@ -153842,7 +154726,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -153853,19 +154737,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists TensorboardTimeSeries in a Location. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -153886,10 +154768,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -153898,29 +154777,21 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.list( + * await aiplatform.projects.locations.tensorboards.experiments.runs.operations.get( * { - * // Lists the TensorboardTimeSeries that match the filter expression. - * filter: 'placeholder-value', - * // Field to use to sort the list. - * orderBy: 'placeholder-value', - * // The maximum number of TensorboardTimeSeries to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardTimeSeries are returned. The maximum value is 1000; values above 1000 are coerced to 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous TensorboardService.ListTensorboardTimeSeries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardTimeSeries must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` - * parent: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/operations/my-operation', * }, * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "tensorboardTimeSeries": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -153936,62 +154807,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List, + get( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get; options = {}; } @@ -154004,34 +154871,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/timeSeries').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a TensorboardTimeSeries. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -154061,45 +154923,27 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch( + * await aiplatform.projects.locations.tensorboards.experiments.runs.operations.list( * { - * // Output only. Name of the TensorboardTimeSeries. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', - * // Required. Field mask is used to specify the fields to be overwritten in the TensorboardTimeSeries resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "metadata": {}, - * // "name": "my_name", - * // "pluginData": "my_pluginData", - * // "pluginName": "my_pluginName", - * // "updateTime": "my_updateTime", - * // "valueType": "my_valueType" - * // } - * }, + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "metadata": {}, - * // "name": "my_name", - * // "pluginData": "my_pluginData", - * // "pluginName": "my_pluginName", - * // "updateTime": "my_updateTime", - * // "valueType": "my_valueType" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -154115,62 +154959,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch, + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch, + list( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch, + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch, + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - patch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List; options = {}; } @@ -154183,8 +155027,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -154195,19 +155042,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -154228,10 +155075,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -154240,22 +155084,23 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.read( + * await aiplatform.projects.locations.tensorboards.experiments.runs.operations.wait( * { - * // Reads the TensorboardTimeSeries' data that match the filter expression. - * filter: 'placeholder-value', - * // The maximum number of TensorboardTimeSeries' data to return. This value should be a positive integer. This value can be set to -1 to return all data. - * maxDataPoints: 'placeholder-value', - * // Required. The resource name of the TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` - * tensorboardTimeSeries: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }, * ); * console.log(res.data); * * // Example response * // { - * // "timeSeriesData": {} + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -154271,62 +155116,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - read( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read, + wait( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait, options: StreamMethodOptions ): Promise>; - read( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read, + wait( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - read( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - read( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read, + wait( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - read( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait, + callback: BodyResponseCallback ): void; - read( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - read( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait; options = {}; } @@ -154339,34 +155180,92 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+tensorboardTimeSeries}:read').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['tensorboardTimeSeries'], - pathParams: ['tensorboardTimeSeries'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel extends StandardParameters { /** - * Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries { + context: APIRequestContext; + operations: Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations( + this.context + ); + } + + /** + * Creates a TensorboardTimeSeries. * @example * ```js * // Before running the sample: @@ -154387,10 +155286,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -154399,20 +155295,46 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.readBlobData( + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.create( * { - * // IDs of the blobs to read. - * blobIds: 'placeholder-value', - * // Required. The resource name of the TensorboardTimeSeries to list Blobs. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` - * timeSeries: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', + * // Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` + * parent: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', + * // Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match "a-z0-9{0, 127\}" + * tensorboardTimeSeriesId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "metadata": {}, + * // "name": "my_name", + * // "pluginData": "my_pluginData", + * // "pluginName": "my_pluginName", + * // "updateTime": "my_updateTime", + * // "valueType": "my_valueType" + * // } + * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "blobs": [] + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "metadata": {}, + * // "name": "my_name", + * // "pluginData": "my_pluginData", + * // "pluginName": "my_pluginName", + * // "updateTime": "my_updateTime", + * // "valueType": "my_valueType" * // } * } * @@ -154428,62 +155350,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - readBlobData( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata, + create( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create, options: StreamMethodOptions ): Promise>; - readBlobData( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata, + create( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - readBlobData( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata, + create( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - readBlobData( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata, + create( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - readBlobData( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create, + callback: BodyResponseCallback ): void; - readBlobData( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - readBlobData( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create; options = {}; } @@ -154496,145 +155418,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+timeSeries}:readBlobData').replace( + url: (rootUrl + '/v1/{+parent}/timeSeries').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['timeSeries'], - pathParams: ['timeSeries'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create extends StandardParameters { - /** - * Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` - */ - parent?: string; - /** - * Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match "a-z0-9{0, 127\}" - */ - tensorboardTimeSeriesId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1TensorboardTimeSeries; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete extends StandardParameters { - /** - * Required. The name of the TensorboardTimeSeries to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries extends StandardParameters { - /** - * Required. The resource name of the TensorboardTimeSeries to export data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` - */ - tensorboardTimeSeries?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get extends StandardParameters { - /** - * Required. The name of the TensorboardTimeSeries resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List extends StandardParameters { - /** - * Lists the TensorboardTimeSeries that match the filter expression. - */ - filter?: string; - /** - * Field to use to sort the list. - */ - orderBy?: string; - /** - * The maximum number of TensorboardTimeSeries to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardTimeSeries are returned. The maximum value is 1000; values above 1000 are coerced to 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous TensorboardService.ListTensorboardTimeSeries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardTimeSeries must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch extends StandardParameters { - /** - * Output only. Name of the TensorboardTimeSeries. - */ - name?: string; - /** - * Required. Field mask is used to specify the fields to be overwritten in the TensorboardTimeSeries resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1TensorboardTimeSeries; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read extends StandardParameters { - /** - * Reads the TensorboardTimeSeries' data that match the filter expression. - */ - filter?: string; - /** - * The maximum number of TensorboardTimeSeries' data to return. This value should be a positive integer. This value can be set to -1 to return all data. - */ - maxDataPoints?: number; - /** - * Required. The resource name of the TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` - */ - tensorboardTimeSeries?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata extends StandardParameters { - /** - * IDs of the blobs to read. - */ - blobIds?: string[]; - /** - * Required. The resource name of the TensorboardTimeSeries to list Blobs. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` - */ - timeSeries?: string; - } - - export class Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Deletes a TensorboardTimeSeries. * @example * ```js * // Before running the sample: @@ -154664,16 +155475,22 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.cancel( + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete( * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie/operations/my-operation', + * // Required. The name of the TensorboardTimeSeries to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', * }, * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -154688,54 +155505,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, + delete( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + delete( + callback: BodyResponseCallback + ): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete; options = {}; } @@ -154748,8 +155569,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -154760,17 +155581,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Exports a TensorboardTimeSeries' data. Data is returned in paginated responses. * @example * ```js * // Before running the sample: @@ -154800,16 +155621,31 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.delete( + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.exportTensorboardTimeSeries( * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie/operations/my-operation', + * // Required. The resource name of the TensorboardTimeSeries to export data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + * tensorboardTimeSeries: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "filter": "my_filter", + * // "orderBy": "my_orderBy", + * // "pageSize": 0, + * // "pageToken": "my_pageToken" + * // } + * }, * }, * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "nextPageToken": "my_nextPageToken", + * // "timeSeriesDataPoints": [] + * // } * } * * main().catch(e => { @@ -154824,54 +155660,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, + exportTensorboardTimeSeries( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, + exportTensorboardTimeSeries( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + exportTensorboardTimeSeries( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + exportTensorboardTimeSeries( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, - callback: BodyResponseCallback + exportTensorboardTimeSeries( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + exportTensorboardTimeSeries( + callback: BodyResponseCallback + ): void; + exportTensorboardTimeSeries( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries; options = {}; } @@ -154884,29 +155728,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: ( + rootUrl + + '/v1/{+tensorboardTimeSeries}:exportTensorboardTimeSeries' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['tensorboardTimeSeries'], + pathParams: ['tensorboardTimeSeries'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Gets a TensorboardTimeSeries. * @example * ```js * // Before running the sample: @@ -154927,7 +155776,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -154936,21 +155788,26 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.get( + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.get( * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie/operations/my-operation', + * // Required. The name of the TensorboardTimeSeries resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', * }, * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", * // "metadata": {}, * // "name": "my_name", - * // "response": {} + * // "pluginData": "my_pluginData", + * // "pluginName": "my_pluginName", + * // "updateTime": "my_updateTime", + * // "valueType": "my_valueType" * // } * } * @@ -154967,57 +155824,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get; options = {}; } @@ -155042,17 +155903,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Lists TensorboardTimeSeries in a Location. * @example * ```js * // Before running the sample: @@ -155073,7 +155936,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -155082,18 +155948,21 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.list( + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.list( * { - * // The standard list filter. + * // Lists the TensorboardTimeSeries that match the filter expression. * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', - * // The standard list page size. + * // Field to use to sort the list. + * orderBy: 'placeholder-value', + * // The maximum number of TensorboardTimeSeries to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardTimeSeries are returned. The maximum value is 1000; values above 1000 are coerced to 1000. * pageSize: 'placeholder-value', - * // The standard list page token. + * // A page token, received from a previous TensorboardService.ListTensorboardTimeSeries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardTimeSeries must match the call that provided the page token. * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * // Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` + * parent: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', * }, * ); * console.log(res.data); @@ -155101,8 +155970,7 @@ export namespace aiplatform_v1 { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "tensorboardTimeSeries": [] * // } * } * @@ -155119,61 +155987,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List; options = {}; } @@ -155186,7 +156054,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+parent}/timeSeries').replace( /([^:]\/)\/+/g, '$1' ), @@ -155196,24 +156064,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Updates a TensorboardTimeSeries. * @example * ```js * // Before running the sample: @@ -155243,23 +156111,45 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.wait( + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch( * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', + * // Output only. Name of the TensorboardTimeSeries. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', + * // Required. Field mask is used to specify the fields to be overwritten in the TensorboardTimeSeries resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "metadata": {}, + * // "name": "my_name", + * // "pluginData": "my_pluginData", + * // "pluginName": "my_pluginName", + * // "updateTime": "my_updateTime", + * // "valueType": "my_valueType" + * // } + * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", * // "metadata": {}, * // "name": "my_name", - * // "response": {} + * // "pluginData": "my_pluginData", + * // "pluginName": "my_pluginName", + * // "updateTime": "my_updateTime", + * // "valueType": "my_valueType" * // } * } * @@ -155275,58 +156165,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, + patch( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - wait( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch; options = {}; } @@ -155339,8 +156233,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -155351,75 +156245,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Tensorboards$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k. * @example * ```js * // Before running the sample: @@ -155440,7 +156278,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -155449,14 +156290,23 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/operations/my-operation', - * }); + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.read( + * { + * // Reads the TensorboardTimeSeries' data that match the filter expression. + * filter: 'placeholder-value', + * // The maximum number of TensorboardTimeSeries' data to return. This value should be a positive integer. This value can be set to -1 to return all data. + * maxDataPoints: 'placeholder-value', + * // Required. The resource name of the TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + * tensorboardTimeSeries: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', + * }, + * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "timeSeriesData": {} + * // } * } * * main().catch(e => { @@ -155471,54 +156321,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel, + read( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel, + read( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel, + ): Promise< + GaxiosResponseWithHTTP2 + >; + read( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + read( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel, - callback: BodyResponseCallback + read( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + read( + callback: BodyResponseCallback + ): void; + read( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read; options = {}; } @@ -155531,29 +156389,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+tensorboardTimeSeries}:read').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['tensorboardTimeSeries'], + pathParams: ['tensorboardTimeSeries'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission. * @example * ```js * // Before running the sample: @@ -155574,7 +156437,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -155583,14 +156449,21 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/operations/my-operation', - * }); + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.readBlobData( + * { + * // IDs of the blobs to read. + * blobIds: 'placeholder-value', + * // Required. The resource name of the TensorboardTimeSeries to list Blobs. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + * timeSeries: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', + * }, + * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "blobs": [] + * // } * } * * main().catch(e => { @@ -155605,54 +156478,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Delete, + readBlobData( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Tensorboards$Operations$Delete, + readBlobData( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + readBlobData( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + readBlobData( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Delete, - callback: BodyResponseCallback + readBlobData( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + readBlobData( + callback: BodyResponseCallback + ): void; + readBlobData( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Operations$Delete; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata; options = {}; } @@ -155665,107 +156546,498 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+timeSeries}:readBlobData').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['timeSeries'], + pathParams: ['timeSeries'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create extends StandardParameters { /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/operations/my-operation', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. + * Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` + */ + parent?: string; + /** + * Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match "a-z0-9{0, 127\}" + */ + tensorboardTimeSeriesId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1TensorboardTimeSeries; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete extends StandardParameters { + /** + * Required. The name of the TensorboardTimeSeries to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries extends StandardParameters { + /** + * Required. The resource name of the TensorboardTimeSeries to export data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + */ + tensorboardTimeSeries?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get extends StandardParameters { + /** + * Required. The name of the TensorboardTimeSeries resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List extends StandardParameters { + /** + * Lists the TensorboardTimeSeries that match the filter expression. + */ + filter?: string; + /** + * Field to use to sort the list. + */ + orderBy?: string; + /** + * The maximum number of TensorboardTimeSeries to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardTimeSeries are returned. The maximum value is 1000; values above 1000 are coerced to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous TensorboardService.ListTensorboardTimeSeries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardTimeSeries must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch extends StandardParameters { + /** + * Output only. Name of the TensorboardTimeSeries. + */ + name?: string; + /** + * Required. Field mask is used to specify the fields to be overwritten in the TensorboardTimeSeries resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1TensorboardTimeSeries; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read extends StandardParameters { + /** + * Reads the TensorboardTimeSeries' data that match the filter expression. + */ + filter?: string; + /** + * The maximum number of TensorboardTimeSeries' data to return. This value should be a positive integer. This value can be set to -1 to return all data. + */ + maxDataPoints?: number; + /** + * Required. The resource name of the TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + */ + tensorboardTimeSeries?: string; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata extends StandardParameters { + /** + * IDs of the blobs to read. + */ + blobIds?: string[]; + /** + * Required. The resource name of the TensorboardTimeSeries to list Blobs. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + */ + timeSeries?: string; + } + + export class Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.cancel( + * { + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie/operations/my-operation', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie/operations/my-operation', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie/operations/my-operation', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Tensorboards$Operations$Get, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -155773,7 +157045,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Operations$Get + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -155789,13 +157061,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Operations$Get; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Operations$Get; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get; options = {}; } @@ -155859,18 +157131,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.list( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response @@ -155894,29 +157169,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$List, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Tensorboards$Operations$List, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$List, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$List, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$List, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List, callback: BodyResponseCallback ): void; list( @@ -155924,7 +157199,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Operations$List + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -155942,13 +157217,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Operations$List; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Operations$List; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List; options = {}; } @@ -156017,12 +157292,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response @@ -156048,27 +157326,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Wait, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Tensorboards$Operations$Wait, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Wait, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Wait, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Wait, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -156076,7 +157354,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Operations$Wait + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -156092,13 +157370,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Operations$Wait; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait; options = {}; } @@ -156133,25 +157411,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -156173,7 +157451,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Tensorboards$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -156184,19 +157462,14 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Trainingpipelines { + export class Resource$Projects$Locations$Tensorboards$Operations { context: APIRequestContext; - operations: Resource$Projects$Locations$Trainingpipelines$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Trainingpipelines$Operations( - this.context - ); } /** - * Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetTrainingPipeline or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a TrainingPipeline.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TrainingPipeline.state is set to `CANCELLED`. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -156225,16 +157498,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.trainingPipelines.cancel({ - * // Required. The name of the TrainingPipeline to cancel. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` - * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }); + * const res = + * await aiplatform.projects.locations.tensorboards.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -156254,31 +157522,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Trainingpipelines$Cancel, + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Trainingpipelines$Cancel, + params?: Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Trainingpipelines$Cancel, + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Trainingpipelines$Cancel, + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Trainingpipelines$Cancel, + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Trainingpipelines$Cancel + | Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -156294,13 +157562,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Trainingpipelines$Cancel; + {}) as Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Trainingpipelines$Cancel; + {} as Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel; options = {}; } @@ -156335,7 +157603,7 @@ export namespace aiplatform_v1 { } /** - * Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -156364,56 +157632,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.trainingPipelines.create({ - * // Required. The resource name of the Location to create the TrainingPipeline in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "inputDataConfig": {}, - * // "labels": {}, - * // "modelId": "my_modelId", - * // "modelToUpload": {}, - * // "name": "my_name", - * // "parentModel": "my_parentModel", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "trainingTaskDefinition": "my_trainingTaskDefinition", - * // "trainingTaskInputs": {}, - * // "trainingTaskMetadata": {}, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.tensorboards.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "inputDataConfig": {}, - * // "labels": {}, - * // "modelId": "my_modelId", - * // "modelToUpload": {}, - * // "name": "my_name", - * // "parentModel": "my_parentModel", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "trainingTaskDefinition": "my_trainingTaskDefinition", - * // "trainingTaskInputs": {}, - * // "trainingTaskMetadata": {}, - * // "updateTime": "my_updateTime" - * // } + * // {} * } * * main().catch(e => { @@ -156428,62 +157655,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Trainingpipelines$Create, + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Delete, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Trainingpipelines$Create, + delete( + params?: Params$Resource$Projects$Locations$Tensorboards$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - create( - params: Params$Resource$Projects$Locations$Trainingpipelines$Create, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Trainingpipelines$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Trainingpipelines$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Delete, + callback: BodyResponseCallback ): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Trainingpipelines$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Trainingpipelines$Create; + {}) as Params$Resource$Projects$Locations$Tensorboards$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Trainingpipelines$Create; + {} as Params$Resource$Projects$Locations$Tensorboards$Operations$Delete; options = {}; } @@ -156496,34 +157715,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/trainingPipelines').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a TrainingPipeline. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -156552,9 +157766,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.trainingPipelines.delete({ - * // Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` - * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline', + * const res = await aiplatform.projects.locations.tensorboards.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/operations/my-operation', * }); * console.log(res.data); * @@ -156580,36 +157794,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Trainingpipelines$Delete, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Trainingpipelines$Delete, + get( + params?: Params$Resource$Projects$Locations$Tensorboards$Operations$Get, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Trainingpipelines$Delete, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Trainingpipelines$Delete, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Trainingpipelines$Delete, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Get, callback: BodyResponseCallback ): void; - delete( + get( callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Trainingpipelines$Delete + | Params$Resource$Projects$Locations$Tensorboards$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -156625,13 +157839,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Trainingpipelines$Delete; + {}) as Params$Resource$Projects$Locations$Tensorboards$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Trainingpipelines$Delete; + {} as Params$Resource$Projects$Locations$Tensorboards$Operations$Get; options = {}; } @@ -156645,7 +157859,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -156666,7 +157880,7 @@ export namespace aiplatform_v1 { } /** - * Gets a TrainingPipeline. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -156695,31 +157909,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.trainingPipelines.get({ - * // Required. The name of the TrainingPipeline resource. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` - * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline', + * const res = await aiplatform.projects.locations.tensorboards.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "inputDataConfig": {}, - * // "labels": {}, - * // "modelId": "my_modelId", - * // "modelToUpload": {}, - * // "name": "my_name", - * // "parentModel": "my_parentModel", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "trainingTaskDefinition": "my_trainingTaskDefinition", - * // "trainingTaskInputs": {}, - * // "trainingTaskMetadata": {}, - * // "updateTime": "my_updateTime" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -156735,61 +157943,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Trainingpipelines$Get, + list( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Trainingpipelines$Get, + list( + params?: Params$Resource$Projects$Locations$Tensorboards$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Trainingpipelines$Get, + list( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Trainingpipelines$Get, + list( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Trainingpipelines$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Trainingpipelines$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Trainingpipelines$Get; + {}) as Params$Resource$Projects$Locations$Tensorboards$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Trainingpipelines$Get; + params = + {} as Params$Resource$Projects$Locations$Tensorboards$Operations$List; options = {}; } @@ -156802,7 +158011,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -156814,19 +158026,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists TrainingPipelines in a Location. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -156855,24 +158067,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.trainingPipelines.list({ - * // The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="PIPELINE_STATE_SUCCEEDED" AND display_name:"my_pipeline_*"` * `state!="PIPELINE_STATE_FAILED" OR display_name="my_pipeline"` * `NOT display_name="my_pipeline"` * `create_time\>"2021-05-18T00:00:00Z"` * `training_task_definition:"*automl_text_classification*"` - * filter: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list the TrainingPipelines from. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', + * const res = await aiplatform.projects.locations.tensorboards.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "trainingPipelines": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -156888,62 +158097,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Trainingpipelines$List, + wait( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Wait, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Trainingpipelines$List, + wait( + params?: Params$Resource$Projects$Locations$Tensorboards$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Trainingpipelines$List, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Trainingpipelines$List, + wait( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Trainingpipelines$List, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Wait, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - list( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Trainingpipelines$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Trainingpipelines$List; + {}) as Params$Resource$Projects$Locations$Tensorboards$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Trainingpipelines$List; + {} as Params$Resource$Projects$Locations$Tensorboards$Operations$Wait; options = {}; } @@ -156956,98 +158161,92 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/trainingPipelines').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Trainingpipelines$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel extends StandardParameters { /** - * Required. The name of the TrainingPipeline to cancel. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` + * The name of the operation resource to be cancelled. */ name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CancelTrainingPipelineRequest; - } - export interface Params$Resource$Projects$Locations$Trainingpipelines$Create extends StandardParameters { - /** - * Required. The resource name of the Location to create the TrainingPipeline in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1TrainingPipeline; } - export interface Params$Resource$Projects$Locations$Trainingpipelines$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Operations$Delete extends StandardParameters { /** - * Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Trainingpipelines$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Operations$Get extends StandardParameters { /** - * Required. The name of the TrainingPipeline resource. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Trainingpipelines$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Operations$List extends StandardParameters { /** - * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="PIPELINE_STATE_SUCCEEDED" AND display_name:"my_pipeline_*"` * `state!="PIPELINE_STATE_FAILED" OR display_name="my_pipeline"` * `NOT display_name="my_pipeline"` * `create_time\>"2021-05-18T00:00:00Z"` * `training_task_definition:"*automl_text_classification*"` + * The standard list filter. */ filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; /** * The standard list page size. */ pageSize?: number; /** - * The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the Location to list the TrainingPipelines from. Format: `projects/{project\}/locations/{location\}` + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - parent?: string; + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Operations$Wait extends StandardParameters { /** - * Mask specifying which fields to read. + * The name of the operation resource to wait on. */ - readMask?: string; + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; } - export class Resource$Projects$Locations$Trainingpipelines$Operations { + export class Resource$Projects$Locations$Trainingpipelines { context: APIRequestContext; + operations: Resource$Projects$Locations$Trainingpipelines$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Trainingpipelines$Operations( + this.context + ); } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetTrainingPipeline or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a TrainingPipeline.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TrainingPipeline.state is set to `CANCELLED`. * @example * ```js * // Before running the sample: @@ -157076,11 +158275,16 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.trainingPipelines.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.trainingPipelines.cancel({ + * // Required. The name of the TrainingPipeline to cancel. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` + * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); * console.log(res.data); * * // Example response @@ -157100,31 +158304,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel, + params: Params$Resource$Projects$Locations$Trainingpipelines$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Trainingpipelines$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel, + params: Params$Resource$Projects$Locations$Trainingpipelines$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel, + params: Params$Resource$Projects$Locations$Trainingpipelines$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel, + params: Params$Resource$Projects$Locations$Trainingpipelines$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel + | Params$Resource$Projects$Locations$Trainingpipelines$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -157140,13 +158344,859 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Trainingpipelines$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Trainingpipelines$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.trainingPipelines.create({ + * // Required. The resource name of the Location to create the TrainingPipeline in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "inputDataConfig": {}, + * // "labels": {}, + * // "modelId": "my_modelId", + * // "modelToUpload": {}, + * // "name": "my_name", + * // "parentModel": "my_parentModel", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "trainingTaskDefinition": "my_trainingTaskDefinition", + * // "trainingTaskInputs": {}, + * // "trainingTaskMetadata": {}, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "inputDataConfig": {}, + * // "labels": {}, + * // "modelId": "my_modelId", + * // "modelToUpload": {}, + * // "name": "my_name", + * // "parentModel": "my_parentModel", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "trainingTaskDefinition": "my_trainingTaskDefinition", + * // "trainingTaskInputs": {}, + * // "trainingTaskMetadata": {}, + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Trainingpipelines$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Trainingpipelines$Create, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Trainingpipelines$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Trainingpipelines$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Trainingpipelines$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Trainingpipelines$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Trainingpipelines$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Trainingpipelines$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/trainingPipelines').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes a TrainingPipeline. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.trainingPipelines.delete({ + * // Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` + * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Trainingpipelines$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Trainingpipelines$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Trainingpipelines$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Trainingpipelines$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Trainingpipelines$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Trainingpipelines$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Trainingpipelines$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Trainingpipelines$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a TrainingPipeline. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.trainingPipelines.get({ + * // Required. The name of the TrainingPipeline resource. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` + * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "inputDataConfig": {}, + * // "labels": {}, + * // "modelId": "my_modelId", + * // "modelToUpload": {}, + * // "name": "my_name", + * // "parentModel": "my_parentModel", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "trainingTaskDefinition": "my_trainingTaskDefinition", + * // "trainingTaskInputs": {}, + * // "trainingTaskMetadata": {}, + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Trainingpipelines$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Trainingpipelines$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Trainingpipelines$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Trainingpipelines$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Trainingpipelines$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Trainingpipelines$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Trainingpipelines$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Trainingpipelines$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists TrainingPipelines in a Location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.trainingPipelines.list({ + * // The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="PIPELINE_STATE_SUCCEEDED" AND display_name:"my_pipeline_*"` * `state!="PIPELINE_STATE_FAILED" OR display_name="my_pipeline"` * `NOT display_name="my_pipeline"` * `create_time\>"2021-05-18T00:00:00Z"` * `training_task_definition:"*automl_text_classification*"` + * filter: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list the TrainingPipelines from. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "trainingPipelines": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Trainingpipelines$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Trainingpipelines$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Trainingpipelines$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Trainingpipelines$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Trainingpipelines$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Trainingpipelines$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Trainingpipelines$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Trainingpipelines$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/trainingPipelines').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Trainingpipelines$Cancel extends StandardParameters { + /** + * Required. The name of the TrainingPipeline to cancel. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CancelTrainingPipelineRequest; + } + export interface Params$Resource$Projects$Locations$Trainingpipelines$Create extends StandardParameters { + /** + * Required. The resource name of the Location to create the TrainingPipeline in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1TrainingPipeline; + } + export interface Params$Resource$Projects$Locations$Trainingpipelines$Delete extends StandardParameters { + /** + * Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Trainingpipelines$Get extends StandardParameters { + /** + * Required. The name of the TrainingPipeline resource. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Trainingpipelines$List extends StandardParameters { + /** + * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="PIPELINE_STATE_SUCCEEDED" AND display_name:"my_pipeline_*"` * `state!="PIPELINE_STATE_FAILED" OR display_name="my_pipeline"` * `NOT display_name="my_pipeline"` * `create_time\>"2021-05-18T00:00:00Z"` * `training_task_definition:"*automl_text_classification*"` + */ + filter?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list the TrainingPipelines from. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + + export class Resource$Projects$Locations$Trainingpipelines$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.trainingPipelines.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel; options = {}; } @@ -159247,76 +161297,1756 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Tuningjobs$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Tuningjobs$Operations$List extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + + export class Resource$Publishers { + context: APIRequestContext; + models: Resource$Publishers$Models; + constructor(context: APIRequestContext) { + this.context = context; + this.models = new Resource$Publishers$Models(this.context); + } + } + + export class Resource$Publishers$Models { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Return a list of tokens based on the input text. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.publishers.models.computeTokens({ + * // Required. The name of the Endpoint requested to get lists of tokens and token ids. + * endpoint: 'publishers/my-publisher/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contents": [], + * // "instances": [], + * // "model": "my_model" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "tokensInfo": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + computeTokens( + params: Params$Resource$Publishers$Models$Computetokens, + options: StreamMethodOptions + ): Promise>; + computeTokens( + params?: Params$Resource$Publishers$Models$Computetokens, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + computeTokens( + params: Params$Resource$Publishers$Models$Computetokens, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + computeTokens( + params: Params$Resource$Publishers$Models$Computetokens, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + computeTokens( + params: Params$Resource$Publishers$Models$Computetokens, + callback: BodyResponseCallback + ): void; + computeTokens( + callback: BodyResponseCallback + ): void; + computeTokens( + paramsOrCallback?: + | Params$Resource$Publishers$Models$Computetokens + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Publishers$Models$Computetokens; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Publishers$Models$Computetokens; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}:computeTokens').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Perform a token counting. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.publishers.models.countTokens({ + * // Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'publishers/my-publisher/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contents": [], + * // "generationConfig": {}, + * // "instances": [], + * // "model": "my_model", + * // "systemInstruction": {}, + * // "tools": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "promptTokensDetails": [], + * // "totalBillableCharacters": 0, + * // "totalTokens": 0 + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + countTokens( + params: Params$Resource$Publishers$Models$Counttokens, + options: StreamMethodOptions + ): Promise>; + countTokens( + params?: Params$Resource$Publishers$Models$Counttokens, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + countTokens( + params: Params$Resource$Publishers$Models$Counttokens, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + countTokens( + params: Params$Resource$Publishers$Models$Counttokens, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + countTokens( + params: Params$Resource$Publishers$Models$Counttokens, + callback: BodyResponseCallback + ): void; + countTokens( + callback: BodyResponseCallback + ): void; + countTokens( + paramsOrCallback?: + | Params$Resource$Publishers$Models$Counttokens + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Publishers$Models$Counttokens; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Publishers$Models$Counttokens; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}:countTokens').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Fetch an asynchronous online prediction operation. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.publishers.models.fetchPredictOperation({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + * endpoint: 'publishers/my-publisher/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "operationName": "my_operationName" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + fetchPredictOperation( + params: Params$Resource$Publishers$Models$Fetchpredictoperation, + options: StreamMethodOptions + ): Promise>; + fetchPredictOperation( + params?: Params$Resource$Publishers$Models$Fetchpredictoperation, + options?: MethodOptions + ): Promise>; + fetchPredictOperation( + params: Params$Resource$Publishers$Models$Fetchpredictoperation, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchPredictOperation( + params: Params$Resource$Publishers$Models$Fetchpredictoperation, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchPredictOperation( + params: Params$Resource$Publishers$Models$Fetchpredictoperation, + callback: BodyResponseCallback + ): void; + fetchPredictOperation( + callback: BodyResponseCallback + ): void; + fetchPredictOperation( + paramsOrCallback?: + | Params$Resource$Publishers$Models$Fetchpredictoperation + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Publishers$Models$Fetchpredictoperation; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Publishers$Models$Fetchpredictoperation; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}:fetchPredictOperation').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Generate content with multimodal inputs. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.publishers.models.generateContent({ + * // Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * model: 'publishers/my-publisher/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "cachedContent": "my_cachedContent", + * // "contents": [], + * // "generationConfig": {}, + * // "labels": {}, + * // "modelArmorConfig": {}, + * // "safetySettings": [], + * // "systemInstruction": {}, + * // "toolConfig": {}, + * // "tools": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "candidates": [], + * // "createTime": "my_createTime", + * // "modelVersion": "my_modelVersion", + * // "promptFeedback": {}, + * // "responseId": "my_responseId", + * // "usageMetadata": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + generateContent( + params: Params$Resource$Publishers$Models$Generatecontent, + options: StreamMethodOptions + ): Promise>; + generateContent( + params?: Params$Resource$Publishers$Models$Generatecontent, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + generateContent( + params: Params$Resource$Publishers$Models$Generatecontent, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateContent( + params: Params$Resource$Publishers$Models$Generatecontent, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateContent( + params: Params$Resource$Publishers$Models$Generatecontent, + callback: BodyResponseCallback + ): void; + generateContent( + callback: BodyResponseCallback + ): void; + generateContent( + paramsOrCallback?: + | Params$Resource$Publishers$Models$Generatecontent + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Publishers$Models$Generatecontent; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Publishers$Models$Generatecontent; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+model}:generateContent').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['model'], + pathParams: ['model'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets a Model Garden publisher model. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.publishers.models.get({ + * // Optional. Token used to access Hugging Face gated models. + * huggingFaceToken: 'placeholder-value', + * // Optional. Boolean indicates whether the requested model is a Hugging Face model. + * isHuggingFaceModel: 'placeholder-value', + * // Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in. + * languageCode: 'placeholder-value', + * // Required. The name of the PublisherModel resource. Format: `publishers/{publisher\}/models/{publisher_model\}` + * name: 'publishers/my-publisher/models/my-model', + * // Optional. PublisherModel view specifying which fields to read. + * view: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "frameworks": [], + * // "launchStage": "my_launchStage", + * // "name": "my_name", + * // "openSourceCategory": "my_openSourceCategory", + * // "predictSchemata": {}, + * // "publisherModelTemplate": "my_publisherModelTemplate", + * // "supportedActions": {}, + * // "versionId": "my_versionId", + * // "versionState": "my_versionState" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Publishers$Models$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Publishers$Models$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Publishers$Models$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Publishers$Models$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Publishers$Models$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Publishers$Models$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Publishers$Models$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Publishers$Models$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Perform an online prediction. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.publishers.models.predict({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'publishers/my-publisher/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "instances": [], + * // "labels": {}, + * // "parameters": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "deployedModelId": "my_deployedModelId", + * // "metadata": {}, + * // "model": "my_model", + * // "modelDisplayName": "my_modelDisplayName", + * // "modelVersionId": "my_modelVersionId", + * // "predictions": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + predict( + params: Params$Resource$Publishers$Models$Predict, + options: StreamMethodOptions + ): Promise>; + predict( + params?: Params$Resource$Publishers$Models$Predict, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + predict( + params: Params$Resource$Publishers$Models$Predict, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + predict( + params: Params$Resource$Publishers$Models$Predict, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + predict( + params: Params$Resource$Publishers$Models$Predict, + callback: BodyResponseCallback + ): void; + predict( + callback: BodyResponseCallback + ): void; + predict( + paramsOrCallback?: + | Params$Resource$Publishers$Models$Predict + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Publishers$Models$Predict; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Publishers$Models$Predict; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}:predict').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.publishers.models.predictLongRunning({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + * endpoint: 'publishers/my-publisher/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "instances": [], + * // "parameters": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + predictLongRunning( + params: Params$Resource$Publishers$Models$Predictlongrunning, + options: StreamMethodOptions + ): Promise>; + predictLongRunning( + params?: Params$Resource$Publishers$Models$Predictlongrunning, + options?: MethodOptions + ): Promise>; + predictLongRunning( + params: Params$Resource$Publishers$Models$Predictlongrunning, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + predictLongRunning( + params: Params$Resource$Publishers$Models$Predictlongrunning, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + predictLongRunning( + params: Params$Resource$Publishers$Models$Predictlongrunning, + callback: BodyResponseCallback + ): void; + predictLongRunning( + callback: BodyResponseCallback + ): void; + predictLongRunning( + paramsOrCallback?: + | Params$Resource$Publishers$Models$Predictlongrunning + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Publishers$Models$Predictlongrunning; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Publishers$Models$Predictlongrunning; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}:predictLongRunning').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Generate content with multimodal inputs with streaming support. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.publishers.models.streamGenerateContent({ + * // Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * model: 'publishers/my-publisher/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "cachedContent": "my_cachedContent", + * // "contents": [], + * // "generationConfig": {}, + * // "labels": {}, + * // "modelArmorConfig": {}, + * // "safetySettings": [], + * // "systemInstruction": {}, + * // "toolConfig": {}, + * // "tools": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "candidates": [], + * // "createTime": "my_createTime", + * // "modelVersion": "my_modelVersion", + * // "promptFeedback": {}, + * // "responseId": "my_responseId", + * // "usageMetadata": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + streamGenerateContent( + params: Params$Resource$Publishers$Models$Streamgeneratecontent, + options: StreamMethodOptions + ): Promise>; + streamGenerateContent( + params?: Params$Resource$Publishers$Models$Streamgeneratecontent, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + streamGenerateContent( + params: Params$Resource$Publishers$Models$Streamgeneratecontent, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + streamGenerateContent( + params: Params$Resource$Publishers$Models$Streamgeneratecontent, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + streamGenerateContent( + params: Params$Resource$Publishers$Models$Streamgeneratecontent, + callback: BodyResponseCallback + ): void; + streamGenerateContent( + callback: BodyResponseCallback + ): void; + streamGenerateContent( + paramsOrCallback?: + | Params$Resource$Publishers$Models$Streamgeneratecontent + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Publishers$Models$Streamgeneratecontent; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Publishers$Models$Streamgeneratecontent; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+model}:streamGenerateContent').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['model'], + pathParams: ['model'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Publishers$Models$Computetokens extends StandardParameters { + /** + * Required. The name of the Endpoint requested to get lists of tokens and token ids. + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ComputeTokensRequest; + } + export interface Params$Resource$Publishers$Models$Counttokens extends StandardParameters { + /** + * Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CountTokensRequest; + } + export interface Params$Resource$Publishers$Models$Fetchpredictoperation extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1FetchPredictOperationRequest; + } + export interface Params$Resource$Publishers$Models$Generatecontent extends StandardParameters { + /** + * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + model?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; + } + export interface Params$Resource$Publishers$Models$Get extends StandardParameters { + /** + * Optional. Token used to access Hugging Face gated models. + */ + huggingFaceToken?: string; + /** + * Optional. Boolean indicates whether the requested model is a Hugging Face model. + */ + isHuggingFaceModel?: boolean; + /** + * Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in. + */ + languageCode?: string; + /** + * Required. The name of the PublisherModel resource. Format: `publishers/{publisher\}/models/{publisher_model\}` + */ + name?: string; + /** + * Optional. PublisherModel view specifying which fields to read. + */ + view?: string; + } + export interface Params$Resource$Publishers$Models$Predict extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1PredictRequest; + } + export interface Params$Resource$Publishers$Models$Predictlongrunning extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1PredictLongRunningRequest; + } + export interface Params$Resource$Publishers$Models$Streamgeneratecontent extends StandardParameters { + /** + * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + model?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; + } + + export class Resource$Ragcorpora { + context: APIRequestContext; + operations: Resource$Ragcorpora$Operations; + ragFiles: Resource$Ragcorpora$Ragfiles; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Ragcorpora$Operations(this.context); + this.ragFiles = new Resource$Ragcorpora$Ragfiles(this.context); + } + } + + export class Resource$Ragcorpora$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.ragCorpora.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'ragCorpora/[^/]+/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Ragcorpora$Operations$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Ragcorpora$Operations$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Ragcorpora$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Ragcorpora$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Ragcorpora$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Ragcorpora$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Ragcorpora$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Ragcorpora$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.ragCorpora.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'ragCorpora/[^/]+/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Ragcorpora$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Ragcorpora$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Ragcorpora$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Ragcorpora$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Ragcorpora$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Ragcorpora$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Ragcorpora$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Ragcorpora$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tuningjobs$Operations$Get extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tuningjobs$Operations$List extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - - export class Resource$Publishers { - context: APIRequestContext; - models: Resource$Publishers$Models; - constructor(context: APIRequestContext) { - this.context = context; - this.models = new Resource$Publishers$Models(this.context); - } - } - - export class Resource$Publishers$Models { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Return a list of tokens based on the input text. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -159345,25 +163075,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.publishers.models.computeTokens({ - * // Required. The name of the Endpoint requested to get lists of tokens and token ids. - * endpoint: 'publishers/my-publisher/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contents": [], - * // "instances": [], - * // "model": "my_model" - * // } - * }, + * const res = await aiplatform.ragCorpora.operations.get({ + * // The name of the operation resource. + * name: 'ragCorpora/[^/]+/operations/my-operation', * }); * console.log(res.data); * * // Example response * // { - * // "tokensInfo": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -159379,61 +163103,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - computeTokens( - params: Params$Resource$Publishers$Models$Computetokens, + get( + params: Params$Resource$Ragcorpora$Operations$Get, options: StreamMethodOptions ): Promise>; - computeTokens( - params?: Params$Resource$Publishers$Models$Computetokens, + get( + params?: Params$Resource$Ragcorpora$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - computeTokens( - params: Params$Resource$Publishers$Models$Computetokens, + ): Promise>; + get( + params: Params$Resource$Ragcorpora$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - computeTokens( - params: Params$Resource$Publishers$Models$Computetokens, + get( + params: Params$Resource$Ragcorpora$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - computeTokens( - params: Params$Resource$Publishers$Models$Computetokens, - callback: BodyResponseCallback + get( + params: Params$Resource$Ragcorpora$Operations$Get, + callback: BodyResponseCallback ): void; - computeTokens( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - computeTokens( + get( paramsOrCallback?: - | Params$Resource$Publishers$Models$Computetokens - | BodyResponseCallback + | Params$Resource$Ragcorpora$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publishers$Models$Computetokens; + {}) as Params$Resource$Ragcorpora$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publishers$Models$Computetokens; + params = {} as Params$Resource$Ragcorpora$Operations$Get; options = {}; } @@ -159446,34 +163166,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:computeTokens').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Perform a token counting. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -159502,30 +163217,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.publishers.models.countTokens({ - * // Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'publishers/my-publisher/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contents": [], - * // "generationConfig": {}, - * // "instances": [], - * // "model": "my_model", - * // "systemInstruction": {}, - * // "tools": [] - * // } - * }, + * const res = await aiplatform.ragCorpora.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'ragCorpora/[^/]+', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "promptTokensDetails": [], - * // "totalBillableCharacters": 0, - * // "totalTokens": 0 + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -159541,61 +163251,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - countTokens( - params: Params$Resource$Publishers$Models$Counttokens, + list( + params: Params$Resource$Ragcorpora$Operations$List, options: StreamMethodOptions ): Promise>; - countTokens( - params?: Params$Resource$Publishers$Models$Counttokens, + list( + params?: Params$Resource$Ragcorpora$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - countTokens( - params: Params$Resource$Publishers$Models$Counttokens, + list( + params: Params$Resource$Ragcorpora$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - countTokens( - params: Params$Resource$Publishers$Models$Counttokens, + list( + params: Params$Resource$Ragcorpora$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - countTokens( - params: Params$Resource$Publishers$Models$Counttokens, - callback: BodyResponseCallback + list( + params: Params$Resource$Ragcorpora$Operations$List, + callback: BodyResponseCallback ): void; - countTokens( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - countTokens( + list( paramsOrCallback?: - | Params$Resource$Publishers$Models$Counttokens - | BodyResponseCallback + | Params$Resource$Ragcorpora$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publishers$Models$Counttokens; + {}) as Params$Resource$Ragcorpora$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publishers$Models$Counttokens; + params = {} as Params$Resource$Ragcorpora$Operations$List; options = {}; } @@ -159608,34 +163318,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:countTokens').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Fetch an asynchronous online prediction operation. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -159656,10 +163366,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -159667,17 +163374,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.publishers.models.fetchPredictOperation({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - * endpoint: 'publishers/my-publisher/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "operationName": "my_operationName" - * // } - * }, + * const res = await aiplatform.ragCorpora.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'ragCorpora/[^/]+/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * @@ -159703,36 +163404,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - fetchPredictOperation( - params: Params$Resource$Publishers$Models$Fetchpredictoperation, + wait( + params: Params$Resource$Ragcorpora$Operations$Wait, options: StreamMethodOptions ): Promise>; - fetchPredictOperation( - params?: Params$Resource$Publishers$Models$Fetchpredictoperation, + wait( + params?: Params$Resource$Ragcorpora$Operations$Wait, options?: MethodOptions ): Promise>; - fetchPredictOperation( - params: Params$Resource$Publishers$Models$Fetchpredictoperation, + wait( + params: Params$Resource$Ragcorpora$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fetchPredictOperation( - params: Params$Resource$Publishers$Models$Fetchpredictoperation, + wait( + params: Params$Resource$Ragcorpora$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fetchPredictOperation( - params: Params$Resource$Publishers$Models$Fetchpredictoperation, + wait( + params: Params$Resource$Ragcorpora$Operations$Wait, callback: BodyResponseCallback ): void; - fetchPredictOperation( + wait( callback: BodyResponseCallback ): void; - fetchPredictOperation( + wait( paramsOrCallback?: - | Params$Resource$Publishers$Models$Fetchpredictoperation + | Params$Resource$Ragcorpora$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -159748,12 +163449,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publishers$Models$Fetchpredictoperation; + {}) as Params$Resource$Ragcorpora$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publishers$Models$Fetchpredictoperation; + params = {} as Params$Resource$Ragcorpora$Operations$Wait; options = {}; } @@ -159766,18 +163467,15 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:fetchPredictOperation').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -159789,9 +163487,78 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Ragcorpora$Operations$Cancel extends StandardParameters { /** - * Generate content with multimodal inputs. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Ragcorpora$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Ragcorpora$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Ragcorpora$Operations$List extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Ragcorpora$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Ragcorpora$Ragfiles { + context: APIRequestContext; + operations: Resource$Ragcorpora$Ragfiles$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Ragcorpora$Ragfiles$Operations( + this.context + ); + } + } + + export class Resource$Ragcorpora$Ragfiles$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -159812,10 +163579,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -159823,37 +163587,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.publishers.models.generateContent({ - * // Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * model: 'publishers/my-publisher/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "cachedContent": "my_cachedContent", - * // "contents": [], - * // "generationConfig": {}, - * // "labels": {}, - * // "modelArmorConfig": {}, - * // "safetySettings": [], - * // "systemInstruction": {}, - * // "toolConfig": {}, - * // "tools": [] - * // } - * }, + * const res = await aiplatform.ragCorpora.ragFiles.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "candidates": [], - * // "createTime": "my_createTime", - * // "modelVersion": "my_modelVersion", - * // "promptFeedback": {}, - * // "responseId": "my_responseId", - * // "usageMetadata": {} - * // } + * // {} * } * * main().catch(e => { @@ -159868,61 +163609,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - generateContent( - params: Params$Resource$Publishers$Models$Generatecontent, + cancel( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel, options: StreamMethodOptions ): Promise>; - generateContent( - params?: Params$Resource$Publishers$Models$Generatecontent, + cancel( + params?: Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - generateContent( - params: Params$Resource$Publishers$Models$Generatecontent, + ): Promise>; + cancel( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - generateContent( - params: Params$Resource$Publishers$Models$Generatecontent, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - generateContent( - params: Params$Resource$Publishers$Models$Generatecontent, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - generateContent( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel, + callback: BodyResponseCallback ): void; - generateContent( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Publishers$Models$Generatecontent - | BodyResponseCallback + | Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publishers$Models$Generatecontent; + {}) as Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publishers$Models$Generatecontent; + params = {} as Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel; options = {}; } @@ -159935,34 +163668,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+model}:generateContent').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['model'], - pathParams: ['model'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets a Model Garden publisher model. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -159991,32 +163719,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.publishers.models.get({ - * // Optional. Token used to access Hugging Face gated models. - * huggingFaceToken: 'placeholder-value', - * // Optional. Boolean indicates whether the requested model is a Hugging Face model. - * isHuggingFaceModel: 'placeholder-value', - * // Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in. - * languageCode: 'placeholder-value', - * // Required. The name of the PublisherModel resource. Format: `publishers/{publisher\}/models/{publisher_model\}` - * name: 'publishers/my-publisher/models/my-model', - * // Optional. PublisherModel view specifying which fields to read. - * view: 'placeholder-value', + * const res = await aiplatform.ragCorpora.ragFiles.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "frameworks": [], - * // "launchStage": "my_launchStage", - * // "name": "my_name", - * // "openSourceCategory": "my_openSourceCategory", - * // "predictSchemata": {}, - * // "publisherModelTemplate": "my_publisherModelTemplate", - * // "supportedActions": {}, - * // "versionId": "my_versionId", - * // "versionState": "my_versionState" - * // } + * // {} * } * * main().catch(e => { @@ -160031,61 +163741,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Publishers$Models$Get, + delete( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Publishers$Models$Get, + delete( + params?: Params$Resource$Ragcorpora$Ragfiles$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Publishers$Models$Get, + ): Promise>; + delete( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Publishers$Models$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Publishers$Models$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Delete, + callback: BodyResponseCallback ): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Publishers$Models$Get - | BodyResponseCallback + | Params$Resource$Ragcorpora$Ragfiles$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publishers$Models$Get; + {}) as Params$Resource$Ragcorpora$Ragfiles$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publishers$Models$Get; + params = {} as Params$Resource$Ragcorpora$Ragfiles$Operations$Delete; options = {}; } @@ -160099,7 +163801,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -160110,19 +163812,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Perform an online prediction. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -160143,10 +163843,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -160154,30 +163851,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.publishers.models.predict({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'publishers/my-publisher/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "instances": [], - * // "labels": {}, - * // "parameters": {} - * // } - * }, + * const res = await aiplatform.ragCorpora.ragFiles.operations.get({ + * // The name of the operation resource. + * name: 'ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', * }); * console.log(res.data); * * // Example response * // { - * // "deployedModelId": "my_deployedModelId", + * // "done": false, + * // "error": {}, * // "metadata": {}, - * // "model": "my_model", - * // "modelDisplayName": "my_modelDisplayName", - * // "modelVersionId": "my_modelVersionId", - * // "predictions": [] + * // "name": "my_name", + * // "response": {} * // } * } * @@ -160193,61 +163879,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - predict( - params: Params$Resource$Publishers$Models$Predict, + get( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Get, options: StreamMethodOptions ): Promise>; - predict( - params?: Params$Resource$Publishers$Models$Predict, + get( + params?: Params$Resource$Ragcorpora$Ragfiles$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - predict( - params: Params$Resource$Publishers$Models$Predict, + ): Promise>; + get( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - predict( - params: Params$Resource$Publishers$Models$Predict, + get( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - predict( - params: Params$Resource$Publishers$Models$Predict, - callback: BodyResponseCallback + get( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Get, + callback: BodyResponseCallback ): void; - predict( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - predict( + get( paramsOrCallback?: - | Params$Resource$Publishers$Models$Predict - | BodyResponseCallback + | Params$Resource$Ragcorpora$Ragfiles$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publishers$Models$Predict; + {}) as Params$Resource$Ragcorpora$Ragfiles$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publishers$Models$Predict; + params = {} as Params$Resource$Ragcorpora$Ragfiles$Operations$Get; options = {}; } @@ -160260,33 +163942,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:predict').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -160307,10 +163985,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -160318,28 +163993,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.publishers.models.predictLongRunning({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - * endpoint: 'publishers/my-publisher/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "instances": [], - * // "parameters": {} - * // } - * }, + * const res = await aiplatform.ragCorpora.ragFiles.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'ragCorpora/[^/]+/ragFiles/my-ragFile', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -160355,57 +164027,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - predictLongRunning( - params: Params$Resource$Publishers$Models$Predictlongrunning, + list( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$List, options: StreamMethodOptions ): Promise>; - predictLongRunning( - params?: Params$Resource$Publishers$Models$Predictlongrunning, + list( + params?: Params$Resource$Ragcorpora$Ragfiles$Operations$List, options?: MethodOptions - ): Promise>; - predictLongRunning( - params: Params$Resource$Publishers$Models$Predictlongrunning, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - predictLongRunning( - params: Params$Resource$Publishers$Models$Predictlongrunning, + list( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - predictLongRunning( - params: Params$Resource$Publishers$Models$Predictlongrunning, - callback: BodyResponseCallback + list( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$List, + callback: BodyResponseCallback ): void; - predictLongRunning( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - predictLongRunning( + list( paramsOrCallback?: - | Params$Resource$Publishers$Models$Predictlongrunning - | BodyResponseCallback + | Params$Resource$Ragcorpora$Ragfiles$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publishers$Models$Predictlongrunning; + {}) as Params$Resource$Ragcorpora$Ragfiles$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publishers$Models$Predictlongrunning; + params = {} as Params$Resource$Ragcorpora$Ragfiles$Operations$List; options = {}; } @@ -160418,32 +164094,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:predictLongRunning').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Generate content with multimodal inputs with streaming support. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -160464,10 +164142,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -160475,36 +164150,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.publishers.models.streamGenerateContent({ - * // Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * model: 'publishers/my-publisher/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "cachedContent": "my_cachedContent", - * // "contents": [], - * // "generationConfig": {}, - * // "labels": {}, - * // "modelArmorConfig": {}, - * // "safetySettings": [], - * // "systemInstruction": {}, - * // "toolConfig": {}, - * // "tools": [] - * // } - * }, + * const res = await aiplatform.ragCorpora.ragFiles.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "candidates": [], - * // "createTime": "my_createTime", - * // "modelVersion": "my_modelVersion", - * // "promptFeedback": {}, - * // "responseId": "my_responseId", - * // "usageMetadata": {} + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -160520,61 +164180,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - streamGenerateContent( - params: Params$Resource$Publishers$Models$Streamgeneratecontent, + wait( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Wait, options: StreamMethodOptions ): Promise>; - streamGenerateContent( - params?: Params$Resource$Publishers$Models$Streamgeneratecontent, + wait( + params?: Params$Resource$Ragcorpora$Ragfiles$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - streamGenerateContent( - params: Params$Resource$Publishers$Models$Streamgeneratecontent, + ): Promise>; + wait( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamGenerateContent( - params: Params$Resource$Publishers$Models$Streamgeneratecontent, + wait( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamGenerateContent( - params: Params$Resource$Publishers$Models$Streamgeneratecontent, - callback: BodyResponseCallback + wait( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Wait, + callback: BodyResponseCallback ): void; - streamGenerateContent( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - streamGenerateContent( + wait( paramsOrCallback?: - | Params$Resource$Publishers$Models$Streamgeneratecontent - | BodyResponseCallback + | Params$Resource$Ragcorpora$Ragfiles$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publishers$Models$Streamgeneratecontent; + {}) as Params$Resource$Ragcorpora$Ragfiles$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publishers$Models$Streamgeneratecontent; + params = {} as Params$Resource$Ragcorpora$Ragfiles$Operations$Wait; options = {}; } @@ -160587,145 +164243,89 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+model}:streamGenerateContent').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['model'], - pathParams: ['model'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Publishers$Models$Computetokens extends StandardParameters { - /** - * Required. The name of the Endpoint requested to get lists of tokens and token ids. - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ComputeTokensRequest; - } - export interface Params$Resource$Publishers$Models$Counttokens extends StandardParameters { - /** - * Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - + export interface Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel extends StandardParameters { /** - * Request body metadata + * The name of the operation resource to be cancelled. */ - requestBody?: Schema$GoogleCloudAiplatformV1CountTokensRequest; + name?: string; } - export interface Params$Resource$Publishers$Models$Fetchpredictoperation extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - */ - endpoint?: string; - + export interface Params$Resource$Ragcorpora$Ragfiles$Operations$Delete extends StandardParameters { /** - * Request body metadata + * The name of the operation resource to be deleted. */ - requestBody?: Schema$GoogleCloudAiplatformV1FetchPredictOperationRequest; + name?: string; } - export interface Params$Resource$Publishers$Models$Generatecontent extends StandardParameters { - /** - * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - model?: string; - + export interface Params$Resource$Ragcorpora$Ragfiles$Operations$Get extends StandardParameters { /** - * Request body metadata + * The name of the operation resource. */ - requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; + name?: string; } - export interface Params$Resource$Publishers$Models$Get extends StandardParameters { - /** - * Optional. Token used to access Hugging Face gated models. - */ - huggingFaceToken?: string; - /** - * Optional. Boolean indicates whether the requested model is a Hugging Face model. - */ - isHuggingFaceModel?: boolean; + export interface Params$Resource$Ragcorpora$Ragfiles$Operations$List extends StandardParameters { /** - * Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in. + * The standard list filter. */ - languageCode?: string; + filter?: string; /** - * Required. The name of the PublisherModel resource. Format: `publishers/{publisher\}/models/{publisher_model\}` + * The name of the operation's parent resource. */ name?: string; /** - * Optional. PublisherModel view specifying which fields to read. - */ - view?: string; - } - export interface Params$Resource$Publishers$Models$Predict extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata + * The standard list page size. */ - requestBody?: Schema$GoogleCloudAiplatformV1PredictRequest; - } - export interface Params$Resource$Publishers$Models$Predictlongrunning extends StandardParameters { + pageSize?: number; /** - * 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\}` + * The standard list page token. */ - endpoint?: string; - + pageToken?: string; /** - * Request body metadata + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - requestBody?: Schema$GoogleCloudAiplatformV1PredictLongRunningRequest; + returnPartialSuccess?: boolean; } - export interface Params$Resource$Publishers$Models$Streamgeneratecontent extends StandardParameters { + export interface Params$Resource$Ragcorpora$Ragfiles$Operations$Wait extends StandardParameters { /** - * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * The name of the operation resource to wait on. */ - model?: string; - + name?: string; /** - * Request body metadata + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; + timeout?: string; } - export class Resource$Ragcorpora { + export class Resource$Ragengineconfig { context: APIRequestContext; - operations: Resource$Ragcorpora$Operations; - ragFiles: Resource$Ragcorpora$Ragfiles; + operations: Resource$Ragengineconfig$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = new Resource$Ragcorpora$Operations(this.context); - this.ragFiles = new Resource$Ragcorpora$Ragfiles(this.context); + this.operations = new Resource$Ragengineconfig$Operations(this.context); } } - export class Resource$Ragcorpora$Operations { + export class Resource$Ragengineconfig$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -160761,9 +164361,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.ragCorpora.operations.cancel({ + * const res = await aiplatform.ragEngineConfig.operations.cancel({ * // The name of the operation resource to be cancelled. - * name: 'ragCorpora/[^/]+/operations/my-operation', + * name: 'ragEngineConfig/operations/my-operation', * }); * console.log(res.data); * @@ -160784,31 +164384,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Ragcorpora$Operations$Cancel, + params: Params$Resource$Ragengineconfig$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Ragcorpora$Operations$Cancel, + params?: Params$Resource$Ragengineconfig$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Ragcorpora$Operations$Cancel, + params: Params$Resource$Ragengineconfig$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Ragcorpora$Operations$Cancel, + params: Params$Resource$Ragengineconfig$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Ragcorpora$Operations$Cancel, + params: Params$Resource$Ragengineconfig$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Ragcorpora$Operations$Cancel + | Params$Resource$Ragengineconfig$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -160824,12 +164424,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Ragcorpora$Operations$Cancel; + {}) as Params$Resource$Ragengineconfig$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Ragcorpora$Operations$Cancel; + params = {} as Params$Resource$Ragengineconfig$Operations$Cancel; options = {}; } @@ -160893,9 +164493,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.ragCorpora.operations.delete({ + * const res = await aiplatform.ragEngineConfig.operations.delete({ * // The name of the operation resource to be deleted. - * name: 'ragCorpora/[^/]+/operations/my-operation', + * name: 'ragEngineConfig/operations/my-operation', * }); * console.log(res.data); * @@ -160916,31 +164516,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Ragcorpora$Operations$Delete, + params: Params$Resource$Ragengineconfig$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Ragcorpora$Operations$Delete, + params?: Params$Resource$Ragengineconfig$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Ragcorpora$Operations$Delete, + params: Params$Resource$Ragengineconfig$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Ragcorpora$Operations$Delete, + params: Params$Resource$Ragengineconfig$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Ragcorpora$Operations$Delete, + params: Params$Resource$Ragengineconfig$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Ragcorpora$Operations$Delete + | Params$Resource$Ragengineconfig$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -160956,12 +164556,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Ragcorpora$Operations$Delete; + {}) as Params$Resource$Ragengineconfig$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Ragcorpora$Operations$Delete; + params = {} as Params$Resource$Ragengineconfig$Operations$Delete; options = {}; } @@ -161025,9 +164625,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.ragCorpora.operations.get({ + * const res = await aiplatform.ragEngineConfig.operations.get({ * // The name of the operation resource. - * name: 'ragCorpora/[^/]+/operations/my-operation', + * name: 'ragEngineConfig/operations/my-operation', * }); * console.log(res.data); * @@ -161054,27 +164654,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Ragcorpora$Operations$Get, + params: Params$Resource$Ragengineconfig$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Ragcorpora$Operations$Get, + params?: Params$Resource$Ragengineconfig$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Ragcorpora$Operations$Get, + params: Params$Resource$Ragengineconfig$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Ragcorpora$Operations$Get, + params: Params$Resource$Ragengineconfig$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Ragcorpora$Operations$Get, + params: Params$Resource$Ragengineconfig$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -161082,7 +164682,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Ragcorpora$Operations$Get + | Params$Resource$Ragengineconfig$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -161098,12 +164698,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Ragcorpora$Operations$Get; + {}) as Params$Resource$Ragengineconfig$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Ragcorpora$Operations$Get; + params = {} as Params$Resource$Ragengineconfig$Operations$Get; options = {}; } @@ -161167,11 +164767,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.ragCorpora.operations.list({ + * const res = await aiplatform.ragEngineConfig.operations.list({ * // The standard list filter. * filter: 'placeholder-value', * // The name of the operation's parent resource. - * name: 'ragCorpora/[^/]+', + * name: 'ragEngineConfig', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. @@ -161202,29 +164802,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Ragcorpora$Operations$List, + params: Params$Resource$Ragengineconfig$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Ragcorpora$Operations$List, + params?: Params$Resource$Ragengineconfig$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Ragcorpora$Operations$List, + params: Params$Resource$Ragengineconfig$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Ragcorpora$Operations$List, + params: Params$Resource$Ragengineconfig$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Ragcorpora$Operations$List, + params: Params$Resource$Ragengineconfig$Operations$List, callback: BodyResponseCallback ): void; list( @@ -161232,7 +164832,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Ragcorpora$Operations$List + | Params$Resource$Ragengineconfig$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -161250,12 +164850,12 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Ragcorpora$Operations$List; + {}) as Params$Resource$Ragengineconfig$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Ragcorpora$Operations$List; + params = {} as Params$Resource$Ragengineconfig$Operations$List; options = {}; } @@ -161324,9 +164924,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.ragCorpora.operations.wait({ + * const res = await aiplatform.ragEngineConfig.operations.wait({ * // The name of the operation resource to wait on. - * name: 'ragCorpora/[^/]+/operations/my-operation', + * name: 'ragEngineConfig/operations/my-operation', * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. * timeout: 'placeholder-value', * }); @@ -161355,27 +164955,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Ragcorpora$Operations$Wait, + params: Params$Resource$Ragengineconfig$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Ragcorpora$Operations$Wait, + params?: Params$Resource$Ragengineconfig$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Ragcorpora$Operations$Wait, + params: Params$Resource$Ragengineconfig$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Ragcorpora$Operations$Wait, + params: Params$Resource$Ragengineconfig$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Ragcorpora$Operations$Wait, + params: Params$Resource$Ragengineconfig$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -161383,7 +164983,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Ragcorpora$Operations$Wait + | Params$Resource$Ragengineconfig$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -161399,12 +164999,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Ragcorpora$Operations$Wait; + {}) as Params$Resource$Ragengineconfig$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Ragcorpora$Operations$Wait; + params = {} as Params$Resource$Ragengineconfig$Operations$Wait; options = {}; } @@ -161439,25 +165039,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Ragcorpora$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Ragengineconfig$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Ragcorpora$Operations$Delete extends StandardParameters { + export interface Params$Resource$Ragengineconfig$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Ragcorpora$Operations$Get extends StandardParameters { + export interface Params$Resource$Ragengineconfig$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Ragcorpora$Operations$List extends StandardParameters { + export interface Params$Resource$Ragengineconfig$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -161479,7 +165079,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Ragcorpora$Operations$Wait extends StandardParameters { + export interface Params$Resource$Ragengineconfig$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -161490,25 +165090,185 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Ragcorpora$Ragfiles { + export class Resource$Reasoningengines { context: APIRequestContext; - operations: Resource$Ragcorpora$Ragfiles$Operations; + memories: Resource$Reasoningengines$Memories; + operations: Resource$Reasoningengines$Operations; + sandboxEnvironments: Resource$Reasoningengines$Sandboxenvironments; + sessions: Resource$Reasoningengines$Sessions; constructor(context: APIRequestContext) { this.context = context; - this.operations = new Resource$Ragcorpora$Ragfiles$Operations( - this.context - ); + this.memories = new Resource$Reasoningengines$Memories(this.context); + this.operations = new Resource$Reasoningengines$Operations(this.context); + this.sandboxEnvironments = + new Resource$Reasoningengines$Sandboxenvironments(this.context); + this.sessions = new Resource$Reasoningengines$Sessions(this.context); } - } - export class Resource$Ragcorpora$Ragfiles$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + /** + * Creates a reasoning engine. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.reasoningEngines.create({ + * // Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project\}/locations/{location\}` + * parent: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contextSpec": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "spec": {}, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Reasoningengines$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Reasoningengines$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Reasoningengines$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Reasoningengines$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Reasoningengines$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Reasoningengines$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Reasoningengines$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reasoningengines$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/reasoningEngines').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Deletes a reasoning engine. * @example * ```js * // Before running the sample: @@ -161536,15 +165296,23 @@ export namespace aiplatform_v1 { * const authClient = await auth.getClient(); * google.options({auth: authClient}); * - * // Do the magic - * const res = await aiplatform.ragCorpora.ragFiles.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', + * // Do the magic + * const res = await aiplatform.reasoningEngines.delete({ + * // Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources. + * force: 'placeholder-value', + * // Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'reasoningEngines/my-reasoningEngine', * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -161559,53 +165327,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel, + delete( + params: Params$Resource$Reasoningengines$Delete, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel, + delete( + params?: Params$Resource$Reasoningengines$Delete, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel, + ): Promise>; + delete( + params: Params$Resource$Reasoningengines$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Reasoningengines$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel, - callback: BodyResponseCallback + delete( + params: Params$Resource$Reasoningengines$Delete, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + delete( + callback: BodyResponseCallback + ): void; + delete( paramsOrCallback?: - | Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Reasoningengines$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel; + {}) as Params$Resource$Reasoningengines$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel; + params = {} as Params$Resource$Reasoningengines$Delete; options = {}; } @@ -161618,8 +165390,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -161630,17 +165402,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Executes code statelessly. * @example * ```js * // Before running the sample: @@ -161669,14 +165441,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.ragCorpora.ragFiles.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', + * const res = await aiplatform.reasoningEngines.executeCode({ + * // Required. The resource name of the sandbox environment to execute. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'reasoningEngines/my-reasoningEngine', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "inputs": [] + * // } + * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "outputs": [] + * // } * } * * main().catch(e => { @@ -161691,53 +165473,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$Delete, + executeCode( + params: Params$Resource$Reasoningengines$Executecode, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Ragcorpora$Ragfiles$Operations$Delete, + executeCode( + params?: Params$Resource$Reasoningengines$Executecode, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + executeCode( + params: Params$Resource$Reasoningengines$Executecode, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + executeCode( + params: Params$Resource$Reasoningengines$Executecode, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$Delete, - callback: BodyResponseCallback + executeCode( + params: Params$Resource$Reasoningengines$Executecode, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + executeCode( + callback: BodyResponseCallback + ): void; + executeCode( paramsOrCallback?: - | Params$Resource$Ragcorpora$Ragfiles$Operations$Delete - | BodyResponseCallback + | Params$Resource$Reasoningengines$Executecode + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Ragcorpora$Ragfiles$Operations$Delete; + {}) as Params$Resource$Reasoningengines$Executecode; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Ragcorpora$Ragfiles$Operations$Delete; + params = {} as Params$Resource$Reasoningengines$Executecode; options = {}; } @@ -161750,8 +165540,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:executeCode').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -161762,17 +165555,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Gets a reasoning engine. * @example * ```js * // Before running the sample: @@ -161801,19 +165596,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.ragCorpora.ragFiles.operations.get({ - * // The name of the operation resource. - * name: 'ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', + * const res = await aiplatform.reasoningEngines.get({ + * // Required. The name of the ReasoningEngine resource. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'reasoningEngines/my-reasoningEngine', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "contextSpec": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, * // "name": "my_name", - * // "response": {} + * // "spec": {}, + * // "updateTime": "my_updateTime" * // } * } * @@ -161830,56 +165630,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$Get, + params: Params$Resource$Reasoningengines$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Ragcorpora$Ragfiles$Operations$Get, + params?: Params$Resource$Reasoningengines$Get, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; get( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$Get, + params: Params$Resource$Reasoningengines$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$Get, + params: Params$Resource$Reasoningengines$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Reasoningengines$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Ragcorpora$Ragfiles$Operations$Get - | BodyResponseCallback + | Params$Resource$Reasoningengines$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Ragcorpora$Ragfiles$Operations$Get; + {}) as Params$Resource$Reasoningengines$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Ragcorpora$Ragfiles$Operations$Get; + params = {} as Params$Resource$Reasoningengines$Get; options = {}; } @@ -161904,17 +165708,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Lists reasoning engines in a location. * @example * ```js * // Before running the sample: @@ -161943,25 +165749,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.ragCorpora.ragFiles.operations.list({ - * // The standard list filter. + * const res = await aiplatform.reasoningEngines.list({ + * // Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'ragCorpora/[^/]+/ragFiles/my-ragFile', - * // The standard list page size. + * // Optional. The standard list page size. * pageSize: 'placeholder-value', - * // The standard list page token. + * // Optional. The standard list page token. * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * // Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project\}/locations/{location\}` + * parent: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "reasoningEngines": [] * // } * } * @@ -161978,60 +165781,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$List, + params: Params$Resource$Reasoningengines$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Ragcorpora$Ragfiles$Operations$List, + params?: Params$Resource$Reasoningengines$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$List, + params: Params$Resource$Reasoningengines$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$List, + params: Params$Resource$Reasoningengines$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Reasoningengines$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Ragcorpora$Ragfiles$Operations$List - | BodyResponseCallback + | Params$Resource$Reasoningengines$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Ragcorpora$Ragfiles$Operations$List; + {}) as Params$Resource$Reasoningengines$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Ragcorpora$Ragfiles$Operations$List; + params = {} as Params$Resource$Reasoningengines$List; options = {}; } @@ -162044,7 +165847,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/reasoningEngines').replace( /([^:]\/)\/+/g, '$1' ), @@ -162054,24 +165857,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: [], + pathParams: [], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Updates a reasoning engine. * @example * ```js * // Before running the sample: @@ -162100,11 +165903,28 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.ragCorpora.ragFiles.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', + * const res = await aiplatform.reasoningEngines.patch({ + * // Identifier. The resource name of the ReasoningEngine. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'reasoningEngines/my-reasoningEngine', + * // Optional. Mask specifying which fields to update. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contextSpec": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "spec": {}, + * // "updateTime": "my_updateTime" + * // } + * }, * }); * console.log(res.data); * @@ -162130,36 +165950,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$Wait, + patch( + params: Params$Resource$Reasoningengines$Patch, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Ragcorpora$Ragfiles$Operations$Wait, + patch( + params?: Params$Resource$Reasoningengines$Patch, options?: MethodOptions ): Promise>; - wait( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$Wait, + patch( + params: Params$Resource$Reasoningengines$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$Wait, + patch( + params: Params$Resource$Reasoningengines$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$Wait, + patch( + params: Params$Resource$Reasoningengines$Patch, callback: BodyResponseCallback ): void; - wait( + patch( callback: BodyResponseCallback ): void; - wait( + patch( paramsOrCallback?: - | Params$Resource$Ragcorpora$Ragfiles$Operations$Wait + | Params$Resource$Reasoningengines$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -162175,12 +165995,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Ragcorpora$Ragfiles$Operations$Wait; + {}) as Params$Resource$Reasoningengines$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Ragcorpora$Ragfiles$Operations$Wait; + params = {} as Params$Resource$Reasoningengines$Patch; options = {}; } @@ -162193,8 +166013,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -162213,76 +166033,9 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Ragcorpora$Ragfiles$Operations$Delete extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Ragcorpora$Ragfiles$Operations$Get extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Ragcorpora$Ragfiles$Operations$List extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Ragcorpora$Ragfiles$Operations$Wait extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Ragengineconfig { - context: APIRequestContext; - operations: Resource$Ragengineconfig$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = new Resource$Ragengineconfig$Operations(this.context); - } - } - - export class Resource$Ragengineconfig$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Queries using a reasoning engine. * @example * ```js * // Before running the sample: @@ -162311,14 +166064,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.ragEngineConfig.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'ragEngineConfig/operations/my-operation', + * const res = await aiplatform.reasoningEngines.query({ + * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'reasoningEngines/my-reasoningEngine', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "classMethod": "my_classMethod", + * // "input": {} + * // } + * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "output": {} + * // } * } * * main().catch(e => { @@ -162333,53 +166097,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Ragengineconfig$Operations$Cancel, + query( + params: Params$Resource$Reasoningengines$Query, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Ragengineconfig$Operations$Cancel, + query( + params?: Params$Resource$Reasoningengines$Query, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Ragengineconfig$Operations$Cancel, + ): Promise< + GaxiosResponseWithHTTP2 + >; + query( + params: Params$Resource$Reasoningengines$Query, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Ragengineconfig$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + query( + params: Params$Resource$Reasoningengines$Query, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Ragengineconfig$Operations$Cancel, - callback: BodyResponseCallback + query( + params: Params$Resource$Reasoningengines$Query, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + query( + callback: BodyResponseCallback + ): void; + query( paramsOrCallback?: - | Params$Resource$Ragengineconfig$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Reasoningengines$Query + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Ragengineconfig$Operations$Cancel; + {}) as Params$Resource$Reasoningengines$Query; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Ragengineconfig$Operations$Cancel; + params = {} as Params$Resource$Reasoningengines$Query; options = {}; } @@ -162392,7 +166164,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:query').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -162404,17 +166176,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Streams queries using a reasoning engine. * @example * ```js * // Before running the sample: @@ -162443,14 +166217,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.ragEngineConfig.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'ragEngineConfig/operations/my-operation', + * const res = await aiplatform.reasoningEngines.streamQuery({ + * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'reasoningEngines/my-reasoningEngine', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "classMethod": "my_classMethod", + * // "input": {} + * // } + * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } * } * * main().catch(e => { @@ -162465,53 +166252,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Ragengineconfig$Operations$Delete, + streamQuery( + params: Params$Resource$Reasoningengines$Streamquery, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Ragengineconfig$Operations$Delete, + streamQuery( + params?: Params$Resource$Reasoningengines$Streamquery, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Ragengineconfig$Operations$Delete, + ): Promise>; + streamQuery( + params: Params$Resource$Reasoningengines$Streamquery, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Ragengineconfig$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + streamQuery( + params: Params$Resource$Reasoningengines$Streamquery, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Ragengineconfig$Operations$Delete, - callback: BodyResponseCallback + streamQuery( + params: Params$Resource$Reasoningengines$Streamquery, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + streamQuery(callback: BodyResponseCallback): void; + streamQuery( paramsOrCallback?: - | Params$Resource$Ragengineconfig$Operations$Delete - | BodyResponseCallback + | Params$Resource$Reasoningengines$Streamquery + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Ragengineconfig$Operations$Delete; + {}) as Params$Resource$Reasoningengines$Streamquery; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Ragengineconfig$Operations$Delete; + params = {} as Params$Resource$Reasoningengines$Streamquery; options = {}; } @@ -162524,8 +166311,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:streamQuery').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -162536,17 +166326,129 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Reasoningengines$Create extends StandardParameters { /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ReasoningEngine; + } + export interface Params$Resource$Reasoningengines$Delete extends StandardParameters { + /** + * Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources. + */ + force?: boolean; + /** + * Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + } + export interface Params$Resource$Reasoningengines$Executecode extends StandardParameters { + /** + * Required. The resource name of the sandbox environment to execute. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ExecuteCodeRequest; + } + export interface Params$Resource$Reasoningengines$Get extends StandardParameters { + /** + * Required. The name of the ReasoningEngine resource. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + } + export interface Params$Resource$Reasoningengines$List extends StandardParameters { + /** + * Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * Optional. The standard list page size. + */ + pageSize?: number; + /** + * Optional. The standard list page token. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + export interface Params$Resource$Reasoningengines$Patch extends StandardParameters { + /** + * Identifier. The resource name of the ReasoningEngine. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + /** + * Optional. Mask specifying which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ReasoningEngine; + } + export interface Params$Resource$Reasoningengines$Query extends StandardParameters { + /** + * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1QueryReasoningEngineRequest; + } + export interface Params$Resource$Reasoningengines$Streamquery extends StandardParameters { + /** + * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest; + } + + export class Resource$Reasoningengines$Memories { + context: APIRequestContext; + operations: Resource$Reasoningengines$Memories$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Reasoningengines$Memories$Operations( + this.context + ); + } + } + + export class Resource$Reasoningengines$Memories$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -162575,20 +166477,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.ragEngineConfig.operations.get({ - * // The name of the operation resource. - * name: 'ragEngineConfig/operations/my-operation', + * const res = await aiplatform.reasoningEngines.memories.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'reasoningEngines/my-reasoningEngine/memories/my-memorie/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -162603,57 +166499,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Ragengineconfig$Operations$Get, + cancel( + params: Params$Resource$Reasoningengines$Memories$Operations$Cancel, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Ragengineconfig$Operations$Get, + cancel( + params?: Params$Resource$Reasoningengines$Memories$Operations$Cancel, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Ragengineconfig$Operations$Get, + ): Promise>; + cancel( + params: Params$Resource$Reasoningengines$Memories$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Ragengineconfig$Operations$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Ragengineconfig$Operations$Get, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Reasoningengines$Memories$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Reasoningengines$Memories$Operations$Cancel, + callback: BodyResponseCallback ): void; - get( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Ragengineconfig$Operations$Get - | BodyResponseCallback + | Params$Resource$Reasoningengines$Memories$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Ragengineconfig$Operations$Get; + {}) as Params$Resource$Reasoningengines$Memories$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Ragengineconfig$Operations$Get; + params = + {} as Params$Resource$Reasoningengines$Memories$Operations$Cancel; options = {}; } @@ -162666,8 +166559,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -162678,17 +166571,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -162717,26 +166610,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.ragEngineConfig.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'ragEngineConfig', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * const res = await aiplatform.reasoningEngines.memories.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'reasoningEngines/my-reasoningEngine/memories/my-memorie/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] - * // } + * // {} * } * * main().catch(e => { @@ -162751,61 +166632,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Ragengineconfig$Operations$List, + delete( + params: Params$Resource$Reasoningengines$Memories$Operations$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Ragengineconfig$Operations$List, + delete( + params?: Params$Resource$Reasoningengines$Memories$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Ragengineconfig$Operations$List, + ): Promise>; + delete( + params: Params$Resource$Reasoningengines$Memories$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Ragengineconfig$Operations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Ragengineconfig$Operations$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Reasoningengines$Memories$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Reasoningengines$Memories$Operations$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Ragengineconfig$Operations$List - | BodyResponseCallback + | Params$Resource$Reasoningengines$Memories$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Ragengineconfig$Operations$List; + {}) as Params$Resource$Reasoningengines$Memories$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Ragengineconfig$Operations$List; + params = + {} as Params$Resource$Reasoningengines$Memories$Operations$Delete; options = {}; } @@ -162818,11 +166692,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -162833,19 +166704,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -162874,11 +166743,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.ragEngineConfig.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'ragEngineConfig/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', + * const res = await aiplatform.reasoningEngines.memories.operations.get({ + * // The name of the operation resource. + * name: 'reasoningEngines/my-reasoningEngine/memories/my-memorie/operations/my-operation', * }); * console.log(res.data); * @@ -162904,36 +166771,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Ragengineconfig$Operations$Wait, + get( + params: Params$Resource$Reasoningengines$Memories$Operations$Get, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Ragengineconfig$Operations$Wait, + get( + params?: Params$Resource$Reasoningengines$Memories$Operations$Get, options?: MethodOptions ): Promise>; - wait( - params: Params$Resource$Ragengineconfig$Operations$Wait, + get( + params: Params$Resource$Reasoningengines$Memories$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Ragengineconfig$Operations$Wait, + get( + params: Params$Resource$Reasoningengines$Memories$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Ragengineconfig$Operations$Wait, + get( + params: Params$Resource$Reasoningengines$Memories$Operations$Get, callback: BodyResponseCallback ): void; - wait( + get( callback: BodyResponseCallback ): void; - wait( + get( paramsOrCallback?: - | Params$Resource$Ragengineconfig$Operations$Wait + | Params$Resource$Reasoningengines$Memories$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -162949,12 +166816,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Ragengineconfig$Operations$Wait; + {}) as Params$Resource$Reasoningengines$Memories$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Ragengineconfig$Operations$Wait; + params = {} as Params$Resource$Reasoningengines$Memories$Operations$Get; options = {}; } @@ -162967,8 +166834,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -162987,73 +166854,9 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Ragengineconfig$Operations$Cancel extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Ragengineconfig$Operations$Delete extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Ragengineconfig$Operations$Get extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Ragengineconfig$Operations$List extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Ragengineconfig$Operations$Wait extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Reasoningengines { - context: APIRequestContext; - memories: Resource$Reasoningengines$Memories; - operations: Resource$Reasoningengines$Operations; - sessions: Resource$Reasoningengines$Sessions; - constructor(context: APIRequestContext) { - this.context = context; - this.memories = new Resource$Reasoningengines$Memories(this.context); - this.operations = new Resource$Reasoningengines$Operations(this.context); - this.sessions = new Resource$Reasoningengines$Sessions(this.context); - } /** - * Creates a reasoning engine. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -163082,36 +166885,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.create({ - * // Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project\}/locations/{location\}` - * parent: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contextSpec": {}, - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "spec": {}, - * // "updateTime": "my_updateTime" - * // } - * }, + * const res = await aiplatform.reasoningEngines.memories.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'reasoningEngines/my-reasoningEngine/memories/my-memorie', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -163127,57 +166919,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Reasoningengines$Create, + list( + params: Params$Resource$Reasoningengines$Memories$Operations$List, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Reasoningengines$Create, + list( + params?: Params$Resource$Reasoningengines$Memories$Operations$List, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Reasoningengines$Create, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Reasoningengines$Memories$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Reasoningengines$Create, + list( + params: Params$Resource$Reasoningengines$Memories$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Reasoningengines$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Reasoningengines$Memories$Operations$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Reasoningengines$Create - | BodyResponseCallback + | Params$Resource$Reasoningengines$Memories$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Create; + {}) as Params$Resource$Reasoningengines$Memories$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Create; + params = + {} as Params$Resource$Reasoningengines$Memories$Operations$List; options = {}; } @@ -163190,32 +166987,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/reasoningEngines').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: [], - pathParams: [], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a reasoning engine. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -163244,11 +167043,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.delete({ - * // Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources. - * force: 'placeholder-value', - * // Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * name: 'reasoningEngines/my-reasoningEngine', + * const res = await aiplatform.reasoningEngines.memories.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'reasoningEngines/my-reasoningEngine/memories/my-memorie/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * @@ -163274,36 +167073,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Reasoningengines$Delete, + wait( + params: Params$Resource$Reasoningengines$Memories$Operations$Wait, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Reasoningengines$Delete, + wait( + params?: Params$Resource$Reasoningengines$Memories$Operations$Wait, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Reasoningengines$Delete, + wait( + params: Params$Resource$Reasoningengines$Memories$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Reasoningengines$Delete, + wait( + params: Params$Resource$Reasoningengines$Memories$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Reasoningengines$Delete, + wait( + params: Params$Resource$Reasoningengines$Memories$Operations$Wait, callback: BodyResponseCallback ): void; - delete( + wait( callback: BodyResponseCallback ): void; - delete( + wait( paramsOrCallback?: - | Params$Resource$Reasoningengines$Delete + | Params$Resource$Reasoningengines$Memories$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -163319,12 +167118,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Delete; + {}) as Params$Resource$Reasoningengines$Memories$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Delete; + params = + {} as Params$Resource$Reasoningengines$Memories$Operations$Wait; options = {}; } @@ -163337,8 +167137,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -163357,9 +167157,67 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Reasoningengines$Memories$Operations$Cancel extends StandardParameters { /** - * Gets a reasoning engine. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Reasoningengines$Memories$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Reasoningengines$Memories$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Reasoningengines$Memories$Operations$List extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Reasoningengines$Memories$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Reasoningengines$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -163388,25 +167246,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.get({ - * // Required. The name of the ReasoningEngine resource. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * name: 'reasoningEngines/my-reasoningEngine', + * const res = await aiplatform.reasoningEngines.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'reasoningEngines/my-reasoningEngine/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "contextSpec": {}, - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "spec": {}, - * // "updateTime": "my_updateTime" - * // } + * // {} * } * * main().catch(e => { @@ -163421,61 +167268,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Reasoningengines$Get, + cancel( + params: Params$Resource$Reasoningengines$Operations$Cancel, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Reasoningengines$Get, + cancel( + params?: Params$Resource$Reasoningengines$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Reasoningengines$Get, + ): Promise>; + cancel( + params: Params$Resource$Reasoningengines$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Reasoningengines$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Reasoningengines$Get, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Reasoningengines$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Reasoningengines$Operations$Cancel, + callback: BodyResponseCallback ): void; - get( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Reasoningengines$Get - | BodyResponseCallback + | Params$Resource$Reasoningengines$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Get; + {}) as Params$Resource$Reasoningengines$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Get; + params = {} as Params$Resource$Reasoningengines$Operations$Cancel; options = {}; } @@ -163488,8 +167327,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -163500,19 +167339,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists reasoning engines in a location. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -163541,23 +167378,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.list({ - * // Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). - * filter: 'placeholder-value', - * // Optional. The standard list page size. - * pageSize: 'placeholder-value', - * // Optional. The standard list page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project\}/locations/{location\}` - * parent: 'placeholder-value', + * const res = await aiplatform.reasoningEngines.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'reasoningEngines/my-reasoningEngine/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "nextPageToken": "my_nextPageToken", - * // "reasoningEngines": [] - * // } + * // {} * } * * main().catch(e => { @@ -163572,61 +167400,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Reasoningengines$List, + delete( + params: Params$Resource$Reasoningengines$Operations$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Reasoningengines$List, + delete( + params?: Params$Resource$Reasoningengines$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Reasoningengines$List, + ): Promise>; + delete( + params: Params$Resource$Reasoningengines$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Reasoningengines$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Reasoningengines$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Reasoningengines$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Reasoningengines$Operations$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Reasoningengines$List - | BodyResponseCallback + | Params$Resource$Reasoningengines$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$List; + {}) as Params$Resource$Reasoningengines$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$List; + params = {} as Params$Resource$Reasoningengines$Operations$Delete; options = {}; } @@ -163639,34 +167459,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/reasoningEngines').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: [], - pathParams: [], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a reasoning engine. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -163695,28 +167510,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.patch({ - * // Identifier. The resource name of the ReasoningEngine. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * name: 'reasoningEngines/my-reasoningEngine', - * // Optional. Mask specifying which fields to update. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contextSpec": {}, - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "spec": {}, - * // "updateTime": "my_updateTime" - * // } - * }, + * const res = await aiplatform.reasoningEngines.operations.get({ + * // The name of the operation resource. + * name: 'reasoningEngines/my-reasoningEngine/operations/my-operation', * }); * console.log(res.data); * @@ -163742,36 +167538,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Reasoningengines$Patch, + get( + params: Params$Resource$Reasoningengines$Operations$Get, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Reasoningengines$Patch, + get( + params?: Params$Resource$Reasoningengines$Operations$Get, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Reasoningengines$Patch, + get( + params: Params$Resource$Reasoningengines$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Reasoningengines$Patch, + get( + params: Params$Resource$Reasoningengines$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Reasoningengines$Patch, + get( + params: Params$Resource$Reasoningengines$Operations$Get, callback: BodyResponseCallback ): void; - patch( + get( callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Reasoningengines$Patch + | Params$Resource$Reasoningengines$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -163787,12 +167583,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Patch; + {}) as Params$Resource$Reasoningengines$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Patch; + params = {} as Params$Resource$Reasoningengines$Operations$Get; options = {}; } @@ -163806,7 +167602,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -163827,7 +167623,7 @@ export namespace aiplatform_v1 { } /** - * Queries using a reasoning engine. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -163856,24 +167652,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.query({ - * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * const res = await aiplatform.reasoningEngines.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. * name: 'reasoningEngines/my-reasoningEngine', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "classMethod": "my_classMethod", - * // "input": {} - * // } - * }, + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "output": {} + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -163889,61 +167686,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - query( - params: Params$Resource$Reasoningengines$Query, + list( + params: Params$Resource$Reasoningengines$Operations$List, options: StreamMethodOptions ): Promise>; - query( - params?: Params$Resource$Reasoningengines$Query, + list( + params?: Params$Resource$Reasoningengines$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - query( - params: Params$Resource$Reasoningengines$Query, + list( + params: Params$Resource$Reasoningengines$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - query( - params: Params$Resource$Reasoningengines$Query, + list( + params: Params$Resource$Reasoningengines$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - query( - params: Params$Resource$Reasoningengines$Query, - callback: BodyResponseCallback + list( + params: Params$Resource$Reasoningengines$Operations$List, + callback: BodyResponseCallback ): void; - query( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - query( + list( paramsOrCallback?: - | Params$Resource$Reasoningengines$Query - | BodyResponseCallback + | Params$Resource$Reasoningengines$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Query; + {}) as Params$Resource$Reasoningengines$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Query; + params = {} as Params$Resource$Reasoningengines$Operations$List; options = {}; } @@ -163956,8 +167753,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:query').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -163968,19 +167768,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Streams queries using a reasoning engine. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -164009,26 +167809,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.streamQuery({ - * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * name: 'reasoningEngines/my-reasoningEngine', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "classMethod": "my_classMethod", - * // "input": {} - * // } - * }, + * const res = await aiplatform.reasoningEngines.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'reasoningEngines/my-reasoningEngine/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -164044,53 +167839,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - streamQuery( - params: Params$Resource$Reasoningengines$Streamquery, + wait( + params: Params$Resource$Reasoningengines$Operations$Wait, options: StreamMethodOptions ): Promise>; - streamQuery( - params?: Params$Resource$Reasoningengines$Streamquery, + wait( + params?: Params$Resource$Reasoningengines$Operations$Wait, options?: MethodOptions - ): Promise>; - streamQuery( - params: Params$Resource$Reasoningengines$Streamquery, + ): Promise>; + wait( + params: Params$Resource$Reasoningengines$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamQuery( - params: Params$Resource$Reasoningengines$Streamquery, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + wait( + params: Params$Resource$Reasoningengines$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamQuery( - params: Params$Resource$Reasoningengines$Streamquery, - callback: BodyResponseCallback + wait( + params: Params$Resource$Reasoningengines$Operations$Wait, + callback: BodyResponseCallback ): void; - streamQuery(callback: BodyResponseCallback): void; - streamQuery( + wait( + callback: BodyResponseCallback + ): void; + wait( paramsOrCallback?: - | Params$Resource$Reasoningengines$Streamquery - | BodyResponseCallback + | Params$Resource$Reasoningengines$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Streamquery; + {}) as Params$Resource$Reasoningengines$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Streamquery; + params = {} as Params$Resource$Reasoningengines$Operations$Wait; options = {}; } @@ -164103,10 +167902,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:streamQuery').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -164118,118 +167914,80 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Reasoningengines$Create extends StandardParameters { - /** - * Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - + export interface Params$Resource$Reasoningengines$Operations$Cancel extends StandardParameters { /** - * Request body metadata + * The name of the operation resource to be cancelled. */ - requestBody?: Schema$GoogleCloudAiplatformV1ReasoningEngine; + name?: string; } - export interface Params$Resource$Reasoningengines$Delete extends StandardParameters { - /** - * Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources. - */ - force?: boolean; + export interface Params$Resource$Reasoningengines$Operations$Delete extends StandardParameters { /** - * Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Reasoningengines$Get extends StandardParameters { + export interface Params$Resource$Reasoningengines$Operations$Get extends StandardParameters { /** - * Required. The name of the ReasoningEngine resource. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Reasoningengines$List extends StandardParameters { + export interface Params$Resource$Reasoningengines$Operations$List extends StandardParameters { /** - * Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). + * The standard list filter. */ filter?: string; /** - * Optional. The standard list page size. - */ - pageSize?: number; - /** - * Optional. The standard list page token. - */ - pageToken?: string; - /** - * Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - } - export interface Params$Resource$Reasoningengines$Patch extends StandardParameters { - /** - * Identifier. The resource name of the ReasoningEngine. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * The name of the operation's parent resource. */ name?: string; /** - * Optional. Mask specifying which fields to update. - */ - updateMask?: string; - - /** - * Request body metadata + * The standard list page size. */ - requestBody?: Schema$GoogleCloudAiplatformV1ReasoningEngine; - } - export interface Params$Resource$Reasoningengines$Query extends StandardParameters { + pageSize?: number; /** - * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * The standard list page token. */ - name?: string; - + pageToken?: string; /** - * Request body metadata + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - requestBody?: Schema$GoogleCloudAiplatformV1QueryReasoningEngineRequest; + returnPartialSuccess?: boolean; } - export interface Params$Resource$Reasoningengines$Streamquery extends StandardParameters { + export interface Params$Resource$Reasoningengines$Operations$Wait extends StandardParameters { /** - * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * The name of the operation resource to wait on. */ name?: string; - /** - * Request body metadata + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - requestBody?: Schema$GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest; - } - - export class Resource$Reasoningengines$Memories { - context: APIRequestContext; - operations: Resource$Reasoningengines$Memories$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = new Resource$Reasoningengines$Memories$Operations( - this.context - ); - } + timeout?: string; } - export class Resource$Reasoningengines$Memories$Operations { + export class Resource$Reasoningengines$Sandboxenvironments { context: APIRequestContext; + operations: Resource$Reasoningengines$Sandboxenvironments$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Reasoningengines$Sandboxenvironments$Operations( + this.context + ); } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Creates a SandboxEnvironment in a given reasoning engine. * @example * ```js * // Before running the sample: @@ -164258,14 +168016,36 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.memories.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'reasoningEngines/my-reasoningEngine/memories/my-memorie/operations/my-operation', + * const res = await aiplatform.reasoningEngines.sandboxEnvironments.create({ + * // Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}`. + * parent: 'reasoningEngines/my-reasoningEngine', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "connectionInfo": {}, + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "expireTime": "my_expireTime", + * // "name": "my_name", + * // "spec": {}, + * // "state": "my_state", + * // "ttl": "my_ttl", + * // "updateTime": "my_updateTime" + * // } + * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -164280,187 +168060,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Reasoningengines$Memories$Operations$Cancel, + create( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Create, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Reasoningengines$Memories$Operations$Cancel, + create( + params?: Params$Resource$Reasoningengines$Sandboxenvironments$Create, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Reasoningengines$Memories$Operations$Cancel, + ): Promise>; + create( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Reasoningengines$Memories$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - cancel( - params: Params$Resource$Reasoningengines$Memories$Operations$Cancel, - callback: BodyResponseCallback - ): void; - cancel(callback: BodyResponseCallback): void; - cancel( - paramsOrCallback?: - | Params$Resource$Reasoningengines$Memories$Operations$Cancel - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: + create( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Create, + options: | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Memories$Operations$Cancel; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Reasoningengines$Memories$Operations$Cancel; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await aiplatform.reasoningEngines.memories.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'reasoningEngines/my-reasoningEngine/memories/my-memorie/operations/my-operation', - * }); - * console.log(res.data); - * - * // Example response - * // {} - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Reasoningengines$Memories$Operations$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Reasoningengines$Memories$Operations$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Reasoningengines$Memories$Operations$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Reasoningengines$Memories$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Create, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Reasoningengines$Memories$Operations$Delete, - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + create( paramsOrCallback?: - | Params$Resource$Reasoningengines$Memories$Operations$Delete - | BodyResponseCallback + | Params$Resource$Reasoningengines$Sandboxenvironments$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Memories$Operations$Delete; + {}) as Params$Resource$Reasoningengines$Sandboxenvironments$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Reasoningengines$Memories$Operations$Delete; + {} as Params$Resource$Reasoningengines$Sandboxenvironments$Create; options = {}; } @@ -164473,29 +168124,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/sandboxEnvironments').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Deletes the specific SandboxEnvironment. * @example * ```js * // Before running the sample: @@ -164524,9 +168178,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.memories.operations.get({ - * // The name of the operation resource. - * name: 'reasoningEngines/my-reasoningEngine/memories/my-memorie/operations/my-operation', + * const res = await aiplatform.reasoningEngines.sandboxEnvironments.delete({ + * // Required. The resource name of the SandboxEnvironment to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` + * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment', * }); * console.log(res.data); * @@ -164552,36 +168206,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Reasoningengines$Memories$Operations$Get, + delete( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Reasoningengines$Memories$Operations$Get, + delete( + params?: Params$Resource$Reasoningengines$Sandboxenvironments$Delete, options?: MethodOptions ): Promise>; - get( - params: Params$Resource$Reasoningengines$Memories$Operations$Get, + delete( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Reasoningengines$Memories$Operations$Get, + delete( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Reasoningengines$Memories$Operations$Get, + delete( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Delete, callback: BodyResponseCallback ): void; - get( + delete( callback: BodyResponseCallback ): void; - get( + delete( paramsOrCallback?: - | Params$Resource$Reasoningengines$Memories$Operations$Get + | Params$Resource$Reasoningengines$Sandboxenvironments$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -164597,12 +168251,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Memories$Operations$Get; + {}) as Params$Resource$Reasoningengines$Sandboxenvironments$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Memories$Operations$Get; + params = + {} as Params$Resource$Reasoningengines$Sandboxenvironments$Delete; options = {}; } @@ -164616,7 +168271,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -164637,7 +168292,7 @@ export namespace aiplatform_v1 { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Executes using a sandbox environment. * @example * ```js * // Before running the sample: @@ -164666,25 +168321,23 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.memories.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'reasoningEngines/my-reasoningEngine/memories/my-memorie', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * const res = await aiplatform.reasoningEngines.sandboxEnvironments.execute({ + * // Required. The resource name of the sandbox environment to execute. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` + * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "inputs": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "outputs": [] * // } * } * @@ -164700,62 +168353,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Reasoningengines$Memories$Operations$List, + execute( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Execute, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Reasoningengines$Memories$Operations$List, + execute( + params?: Params$Resource$Reasoningengines$Sandboxenvironments$Execute, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Reasoningengines$Memories$Operations$List, + execute( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Execute, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Reasoningengines$Memories$Operations$List, + execute( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Execute, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Reasoningengines$Memories$Operations$List, - callback: BodyResponseCallback + execute( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Execute, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + execute( + callback: BodyResponseCallback ): void; - list( + execute( paramsOrCallback?: - | Params$Resource$Reasoningengines$Memories$Operations$List - | BodyResponseCallback + | Params$Resource$Reasoningengines$Sandboxenvironments$Execute + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Memories$Operations$List; + {}) as Params$Resource$Reasoningengines$Sandboxenvironments$Execute; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Reasoningengines$Memories$Operations$List; + {} as Params$Resource$Reasoningengines$Sandboxenvironments$Execute; options = {}; } @@ -164768,11 +168421,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+name}:execute').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -164783,19 +168436,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Gets details of the specific SandboxEnvironment. * @example * ```js * // Before running the sample: @@ -164824,21 +168477,23 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.memories.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'reasoningEngines/my-reasoningEngine/memories/my-memorie/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', + * const res = await aiplatform.reasoningEngines.sandboxEnvironments.get({ + * // Required. The resource name of the sandbox environment. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` + * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "connectionInfo": {}, + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "expireTime": "my_expireTime", * // "name": "my_name", - * // "response": {} + * // "spec": {}, + * // "state": "my_state", + * // "ttl": "my_ttl", + * // "updateTime": "my_updateTime" * // } * } * @@ -164854,58 +168509,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Reasoningengines$Memories$Operations$Wait, + get( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Get, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Reasoningengines$Memories$Operations$Wait, + get( + params?: Params$Resource$Reasoningengines$Sandboxenvironments$Get, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Reasoningengines$Memories$Operations$Wait, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Reasoningengines$Memories$Operations$Wait, + get( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Reasoningengines$Memories$Operations$Wait, - callback: BodyResponseCallback + get( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Get, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - wait( + get( paramsOrCallback?: - | Params$Resource$Reasoningengines$Memories$Operations$Wait - | BodyResponseCallback + | Params$Resource$Reasoningengines$Sandboxenvironments$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Memories$Operations$Wait; + {}) as Params$Resource$Reasoningengines$Sandboxenvironments$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Reasoningengines$Memories$Operations$Wait; + params = {} as Params$Resource$Reasoningengines$Sandboxenvironments$Get; options = {}; } @@ -164918,8 +168576,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -164930,75 +168588,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Reasoningengines$Memories$Operations$Cancel extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Reasoningengines$Memories$Operations$Delete extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Reasoningengines$Memories$Operations$Get extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Reasoningengines$Memories$Operations$List extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Reasoningengines$Memories$Operations$Wait extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Reasoningengines$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Lists SandboxEnvironments in a given reasoning engine. * @example * ```js * // Before running the sample: @@ -165027,14 +168629,23 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'reasoningEngines/my-reasoningEngine/operations/my-operation', + * const res = await aiplatform.reasoningEngines.sandboxEnvironments.list({ + * // Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). + * filter: 'placeholder-value', + * // Optional. The maximum number of SandboxEnvironments to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironments will be returned. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token, received from a previous `ListSandboxEnvironments` call. Provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * parent: 'reasoningEngines/my-reasoningEngine', * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "nextPageToken": "my_nextPageToken", + * // "sandboxEnvironments": [] + * // } * } * * main().catch(e => { @@ -165049,53 +168660,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Reasoningengines$Operations$Cancel, + list( + params: Params$Resource$Reasoningengines$Sandboxenvironments$List, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Reasoningengines$Operations$Cancel, + list( + params?: Params$Resource$Reasoningengines$Sandboxenvironments$List, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Reasoningengines$Operations$Cancel, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Reasoningengines$Sandboxenvironments$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Reasoningengines$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Reasoningengines$Sandboxenvironments$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Reasoningengines$Operations$Cancel, - callback: BodyResponseCallback + list( + params: Params$Resource$Reasoningengines$Sandboxenvironments$List, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Reasoningengines$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Reasoningengines$Sandboxenvironments$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Operations$Cancel; + {}) as Params$Resource$Reasoningengines$Sandboxenvironments$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Operations$Cancel; + params = + {} as Params$Resource$Reasoningengines$Sandboxenvironments$List; options = {}; } @@ -165108,29 +168728,94 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+parent}/sandboxEnvironments').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Reasoningengines$Sandboxenvironments$Create extends StandardParameters { /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1SandboxEnvironment; + } + export interface Params$Resource$Reasoningengines$Sandboxenvironments$Delete extends StandardParameters { + /** + * Required. The resource name of the SandboxEnvironment to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` + */ + name?: string; + } + export interface Params$Resource$Reasoningengines$Sandboxenvironments$Execute extends StandardParameters { + /** + * Required. The resource name of the sandbox environment to execute. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ExecuteSandboxEnvironmentRequest; + } + export interface Params$Resource$Reasoningengines$Sandboxenvironments$Get extends StandardParameters { + /** + * Required. The resource name of the sandbox environment. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` + */ + name?: string; + } + export interface Params$Resource$Reasoningengines$Sandboxenvironments$List extends StandardParameters { + /** + * Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * Optional. The maximum number of SandboxEnvironments to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironments will be returned. + */ + pageSize?: number; + /** + * Optional. The standard list page token, received from a previous `ListSandboxEnvironments` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + parent?: string; + } + + export class Resource$Reasoningengines$Sandboxenvironments$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -165159,10 +168844,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'reasoningEngines/my-reasoningEngine/operations/my-operation', - * }); + * const res = + * await aiplatform.reasoningEngines.sandboxEnvironments.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -165181,32 +168867,32 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Reasoningengines$Operations$Delete, + cancel( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Cancel, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Reasoningengines$Operations$Delete, + cancel( + params?: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Cancel, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Reasoningengines$Operations$Delete, + cancel( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Reasoningengines$Operations$Delete, + cancel( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Reasoningengines$Operations$Delete, + cancel( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Cancel, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Reasoningengines$Operations$Delete + | Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -165222,12 +168908,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Operations$Delete; + {}) as Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Operations$Delete; + params = + {} as Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Cancel; options = {}; } @@ -165240,8 +168927,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -165262,7 +168949,7 @@ export namespace aiplatform_v1 { } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -165291,20 +168978,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.operations.get({ - * // The name of the operation resource. - * name: 'reasoningEngines/my-reasoningEngine/operations/my-operation', - * }); + * const res = + * await aiplatform.reasoningEngines.sandboxEnvironments.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -165319,57 +169001,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Reasoningengines$Operations$Get, + delete( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Reasoningengines$Operations$Get, + delete( + params?: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Delete, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Reasoningengines$Operations$Get, + ): Promise>; + delete( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Reasoningengines$Operations$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Reasoningengines$Operations$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Delete, + callback: BodyResponseCallback ): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Reasoningengines$Operations$Get - | BodyResponseCallback + | Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Operations$Get; + {}) as Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Operations$Get; + params = + {} as Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Delete; options = {}; } @@ -165383,7 +169062,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -165394,17 +169073,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -165433,25 +169112,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'reasoningEngines/my-reasoningEngine', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = + * await aiplatform.reasoningEngines.sandboxEnvironments.operations.get({ + * // The name of the operation resource. + * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment/operations/my-operation', + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -165467,61 +169141,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Reasoningengines$Operations$List, + get( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Reasoningengines$Operations$List, + get( + params?: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Reasoningengines$Operations$List, + ): Promise>; + get( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Reasoningengines$Operations$List, + get( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Reasoningengines$Operations$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Reasoningengines$Operations$List - | BodyResponseCallback + | Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Operations$List; + {}) as Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Operations$List; + params = + {} as Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Get; options = {}; } @@ -165534,10 +169205,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -165549,14 +169217,12 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } @@ -165590,12 +169256,13 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'reasoningEngines/my-reasoningEngine/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = + * await aiplatform.reasoningEngines.sandboxEnvironments.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -165621,27 +169288,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Reasoningengines$Operations$Wait, + params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Reasoningengines$Operations$Wait, + params?: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Reasoningengines$Operations$Wait, + params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Reasoningengines$Operations$Wait, + params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Reasoningengines$Operations$Wait, + params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -165649,7 +169316,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Reasoningengines$Operations$Wait + | Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -165665,12 +169332,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Operations$Wait; + {}) as Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Operations$Wait; + params = + {} as Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Wait; options = {}; } @@ -165705,47 +169373,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Reasoningengines$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Reasoningengines$Operations$Delete extends StandardParameters { + export interface Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Reasoningengines$Operations$Get extends StandardParameters { + export interface Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Reasoningengines$Operations$List extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Reasoningengines$Operations$Wait extends StandardParameters { + export interface Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ diff --git a/src/apis/apigateway/v1.ts b/src/apis/apigateway/v1.ts index 10eb13809b2..84095f21fbe 100644 --- a/src/apis/apigateway/v1.ts +++ b/src/apis/apigateway/v1.ts @@ -423,7 +423,7 @@ export namespace apigateway_v1 { */ operations?: Schema$ApigatewayOperation[]; /** - * 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. + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. */ unreachable?: string[] | null; } @@ -5301,7 +5301,7 @@ export namespace apigateway_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); @@ -5461,7 +5461,7 @@ export namespace apigateway_v1 { */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; } diff --git a/src/apis/apigateway/v1beta.ts b/src/apis/apigateway/v1beta.ts index 927a6647185..e8e0073db53 100644 --- a/src/apis/apigateway/v1beta.ts +++ b/src/apis/apigateway/v1beta.ts @@ -445,7 +445,7 @@ export namespace apigateway_v1beta { */ operations?: Schema$ApigatewayOperation[]; /** - * 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. + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. */ unreachable?: string[] | null; } @@ -5335,7 +5335,7 @@ export namespace apigateway_v1beta { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); @@ -5495,7 +5495,7 @@ export namespace apigateway_v1beta { */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; } diff --git a/src/apis/authorizedbuyersmarketplace/v1alpha.ts b/src/apis/authorizedbuyersmarketplace/v1alpha.ts index 2da960c618d..b807817cad5 100644 --- a/src/apis/authorizedbuyersmarketplace/v1alpha.ts +++ b/src/apis/authorizedbuyersmarketplace/v1alpha.ts @@ -114,6 +114,8 @@ export namespace authorizedbuyersmarketplace_v1alpha { context: APIRequestContext; bidders: Resource$Bidders; buyers: Resource$Buyers; + curators: Resource$Curators; + mediaPlanners: Resource$Mediaplanners; constructor(options: GlobalOptions, google?: GoogleConfigurable) { this.context = { @@ -123,6 +125,8 @@ export namespace authorizedbuyersmarketplace_v1alpha { this.bidders = new Resource$Bidders(this.context); this.buyers = new Resource$Buyers(this.context); + this.curators = new Resource$Curators(this.context); + this.mediaPlanners = new Resource$Mediaplanners(this.context); } } @@ -135,6 +139,15 @@ export namespace authorizedbuyersmarketplace_v1alpha { */ proposalRevision?: string | null; } + /** + * Settings for controlling access to a curated package. + */ + export interface Schema$AccessControlSettings { + /** + * Required. Immutable. The list of media planners that are explicitly granted access to the curated package. Eligible media planners can be found in the mediaPlanners.list method. Only a single media planner may be allowlisted at this time. Format: `mediaPlanners/{mediaPlannerAccountId\}` + */ + allowlistedMediaPlanners?: string[] | null; + } /** * Request message for activating a client. */ @@ -143,6 +156,10 @@ export namespace authorizedbuyersmarketplace_v1alpha { * Request message for activating a client user. */ export interface Schema$ActivateClientUserRequest {} + /** + * Request message for ActivateCuratedPackage. + */ + export interface Schema$ActivateCuratedPackageRequest {} /** * Request message for activating a data segment */ @@ -358,6 +375,51 @@ export namespace authorizedbuyersmarketplace_v1alpha { */ targetedCriteriaIds?: string[] | null; } + /** + * Represents a curated package of inventory created and managed by a Curator. + */ + export interface Schema$CuratedPackage { + /** + * Required. Settings for controlling access to the curated package. Access to this curated package is limited to the allowlisted media planners and the creator. Buyers and bidders can not be allowlisted for or have direct access to this resource. + */ + accessSettings?: Schema$AccessControlSettings; + /** + * Output only. The timestamp when the curated package was created. Can be used to filter the response of the curatedPackages.list method. + */ + createTime?: string | null; + /** + * Optional. A description of the curated package, provided by the curator. + */ + description?: string | null; + /** + * Required. The display name assigned to the curated package by the curator. Can be used to filter the response of the curatedPackages.list method. + */ + displayName?: string | null; + /** + * Optional. The CPM fee charged by the curator to buyers using this curated package. Can be used to filter the response of the curatedPackages.list method. + */ + feeCpm?: Schema$Money; + /** + * Optional. The minimum CPM a buyer has to bid to participate in auctions for inventory in this curated package. Can be used to filter the response of the curatedPackages.list method. + */ + floorPriceCpm?: Schema$Money; + /** + * Identifier. The unique resource name for the curated package. Format: `curators/{accountId\}/curatedPackages/{curatedPackageId\}` + */ + name?: string | null; + /** + * Output only. The state of the curated package. Can be used to filter the response of the curatedPackages.list method. + */ + state?: string | null; + /** + * Optional. Targeting criteria for the curated package. + */ + targeting?: Schema$PackageTargeting; + /** + * Output only. The timestamp when the curated package was last updated. Can be used to filter the response of the curatedPackages.list method. + */ + updateTime?: string | null; + } /** * Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. */ @@ -421,6 +483,10 @@ export namespace authorizedbuyersmarketplace_v1alpha { * Request message for deactivating a client user. */ export interface Schema$DeactivateClientUserRequest {} + /** + * Request message for DeactivateCuratedPackage. + */ + export interface Schema$DeactivateCuratedPackageRequest {} /** * Request message for deactivating a data segment */ @@ -692,6 +758,19 @@ export namespace authorizedbuyersmarketplace_v1alpha { */ nextPageToken?: string | null; } + /** + * Response message for ListCuratedPackages. + */ + export interface Schema$ListCuratedPackagesResponse { + /** + * The list of curated packages. + */ + curatedPackages?: Schema$CuratedPackage[]; + /** + * A token to retrieve the next page of results. Pass this value in the ListCuratedPackagesRequest.pageToken field in the subsequent call to `ListCuratedPackages` method to retrieve the next page of results. If empty, then there are no more results. + */ + nextPageToken?: string | null; + } /** * Response message for listing data segments. */ @@ -731,6 +810,19 @@ export namespace authorizedbuyersmarketplace_v1alpha { */ nextPageToken?: string | null; } + /** + * A response containing media planner account information. + */ + export interface Schema$ListMediaPlannersResponse { + /** + * List of media planners. + */ + mediaPlanners?: Schema$MediaPlanner[]; + /** + * A token which can be passed to a subsequent call to the `ListMediaPlanners` method to retrieve the next page of results in ListMediaPlannersRequest.pageToken. + */ + nextPageToken?: string | null; + } /** * Response message for listing proposals. */ @@ -810,6 +902,18 @@ export namespace authorizedbuyersmarketplace_v1alpha { * Output only. Account ID of the media planner. */ accountId?: string | null; + /** + * Output only. The ancestor names of the media planner. Format: `mediaPlanners/{mediaPlannerAccountId\}` Can be used to filter the response of the mediaPlanners.list method. + */ + ancestorNames?: string[] | null; + /** + * Output only. The display name of the media planner. Can be used to filter the response of the mediaPlanners.list method. + */ + displayName?: string | null; + /** + * Identifier. The unique resource name of the media planner. Format: `mediaPlanners/{mediaPlannerAccountId\}` Can be used to filter the response of the mediaPlanners.list method. + */ + name?: string | null; } /** * Mobile application targeting settings. @@ -867,6 +971,162 @@ export namespace authorizedbuyersmarketplace_v1alpha { */ operatingSystemVersionCriteria?: Schema$CriteriaTargeting; } + /** + * Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. + */ + export interface Schema$PackagePlacementTargeting { + /** + * Optional. The list of targeted mobile app categories. + */ + includedMobileAppCategoryTargeting?: string[] | null; + /** + * Optional. The list of targeted or excluded mobile application IDs that publishers own. Currently, only Android and Apple apps are supported. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. + */ + mobileAppTargeting?: Schema$StringTargetingDimension; + /** + * Optional. The list of targeted or excluded URLs. The domains should have the http/https stripped (for example, google.com), and can contain a max of 5 paths per url. + */ + uriTargeting?: Schema$StringTargetingDimension; + } + /** + * Represents targeting about publisher provided signals. Different publisher provided signals types will be logically OR'ed. + */ + export interface Schema$PackagePublisherProvidedSignalsTargeting { + /** + * Optional. The list of targeted or excluded audience IDs. Based off of IAB Audience Taxonomy version 1.1 (https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Audience%20Taxonomies/Audience%20Taxonomy%201.1.tsv) + */ + audienceTargeting?: Schema$TaxonomyTargeting; + /** + * Optional. The list of targeted or excluded content IDs. Based off of IAB Content Taxonomy version 2.2 (https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Content%20Taxonomies/Content%20Taxonomy%202.2.tsv) + */ + contentTargeting?: Schema$TaxonomyTargeting; + /** + * Optional. The list of targeted and excluded video and audio signals IDs. These are additional signals supported by publisher provided signals. + */ + videoAndAudioSignalsTargeting?: Schema$StringTargetingDimension; + } + /** + * Targeting criteria for curated and auction packages. + */ + export interface Schema$PackageTargeting { + /** + * Optional. The geo criteria IDs to be included or excluded as defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv. If unset, inventory will be targeted regardless of geo. + */ + geoTargeting?: Schema$CriteriaTargeting; + /** + * Optional. The targeted accelerated mobile page type. If unset, inventory will be targeted regardless of AMP status. + */ + includedAcceleratedMobilePageType?: string | null; + /** + * Optional. The list of ad sizes to target. If unset, inventory will be targeted regardless of ad size. Curated packages supports `PIXEL` and `INTERSTITIAL` ad sizes. + */ + includedAdSizes?: Schema$AdSize[]; + /** + * Optional. The included list of targeted authorized seller statuses. If empty, inventory will be targeted regardless of seller status. + */ + includedAuthorizedSellerStatuses?: string[] | null; + /** + * Optional. The creative format to target. If unset, all creative markup types are targeted. + */ + includedCreativeFormat?: string | null; + /** + * Optional. The active data segments to be targeted. If unset, inventory will be targeted regardless of data segments. Format: `curators/{account_id\}/dataSegments/{data_segment_id\}` + */ + includedDataSegments?: string[] | null; + /** + * Optional. The list of included device types to target. If empty, all device types are targeted. + */ + includedDeviceTypes?: string[] | null; + /** + * Optional. The environment to target. If unspecified, all environments are targeted. + */ + includedEnvironment?: string | null; + /** + * Optional. The targeted native inventory types. If empty, inventory will be targeted regardless of native inventory type. + */ + includedNativeInventoryTypes?: string[] | null; + /** + * Optional. The list of targeted open measurement types. If empty, inventory will be targeted regardless of Open Measurement support. + */ + includedOpenMeasurementTypes?: string[] | null; + /** + * Optional. The list of targeted restricted categories. If empty, inventory will be targeted regardless of restricted categories. + */ + includedRestrictedCategories?: string[] | null; + /** + * Optional. The targeted rewarded type. If unset, inventory will be targeted regardless of rewarded type. + */ + includedRewardedType?: string | null; + /** + * Optional. The languages to target. If unset, inventory will be targeted regardless of language. See https://developers.google.com/google-ads/api/data/codes-formats#languages for the list of supported language codes. + */ + languageTargeting?: Schema$StringTargetingDimension; + /** + * Optional. The targeted minimum predicted click through rate, ranging in values [10, 10000] (0.01% - 10%). A value of 50 means that the configuration will only match adslots for which we predict at least 0.05% click through rate. An unset value indicates inventory will be targeted regardless of predicted click through rate. + */ + minimumPredictedClickThroughRatePercentageMillis?: string | null; + /** + * Optional. The targeted minimum predicted viewability percentage. This value must be a multiple of 10 between 10 and 90 (inclusive). For example, 10 is valid, but 0, 15, and 100 are not. A value of 10 means that the configuration will only match adslots for which we predict at least 10% viewability. An unset value indicates inventory will be targeted regardless of predicted viewability. + */ + minimumPredictedViewabilityPercentage?: string | null; + /** + * Optional. Placement targeting information, for example, URL, mobile applications. + */ + placementTargeting?: Schema$PackagePlacementTargeting; + /** + * Optional. The publisher provided signals to target. If unset, inventory will be targeted regardless of publisher provided signals. + */ + publisherProvidedSignalsTargeting?: Schema$PackagePublisherProvidedSignalsTargeting; + /** + * Optional. The targeted publishers. If unset, inventory will be targeted regardless of publisher. Publishers are identified by their publisher ID from ads.txt / app-ads.txt. See https://iabtechlab.com/ads-txt/ and https://iabtechlab.com/app-ads-txt/ for more details. + */ + publisherTargeting?: Schema$StringTargetingDimension; + /** + * Optional. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals. If unset, inventory will be targeted regardless of vertical. + */ + verticalTargeting?: Schema$CriteriaTargeting; + /** + * Optional. Video specific targeting criteria. + */ + videoTargeting?: Schema$PackageVideoTargeting; + } + /** + * Video specific targeting criteria. + */ + export interface Schema$PackageVideoTargeting { + /** + * Optional. The targeted video delivery method. If unset, inventory will be targeted regardless of video delivery method. + */ + includedContentDeliveryMethod?: string | null; + /** + * Optional. The targeted maximum video ad duration. If unset, inventory will be targeted regardless of maximum video ad duration. + */ + includedMaximumAdDurationTargeting?: string | null; + /** + * Optional. The list of targeted video mime types using the IANA published MIME type strings (https://www.iana.org/assignments/media-types/media-types.xhtml). If empty, inventory will be targeted regardless of video mime type. + */ + includedMimeTypes?: string[] | null; + /** + * Optional. The list of targeted video playback methods. If empty, inventory will be targeted regardless of video playback method. + */ + includedPlaybackMethods?: string[] | null; + /** + * Optional. The targeted video player size. If unset, inventory will be targeted regardless of video player size. + */ + includedPlayerSizeTargeting?: Schema$VideoPlayerSizeTargeting; + /** + * Optional. The targeted video ad position types. If empty, inventory will be targeted regardless of video ad position type. + */ + includedPositionTypes?: string[] | null; + /** + * Optional. The targeted minimum predicted completion rate percentage. This value must be a multiple of 10 between 10 and 90 (inclusive). For example, 10 is valid, but 0, 15, and 100 are not. A value of 10 means that the configuration will only match adslots for which we predict at least 10% completion rate. An unset value indicates inventory will be targeted regardless of predicted completion rate. + */ + minimumPredictedCompletionRatePercentage?: string | null; + /** + * Optional. The targeted video plcmt types. If unset, inventory will be targeted regardless of video plcmt type. + */ + plcmtTargeting?: Schema$VideoPlcmtTargeting; + } /** * Request message for pausing a finalized deal. */ @@ -1215,6 +1475,19 @@ export namespace authorizedbuyersmarketplace_v1alpha { * Request message for setting ready to serve for a finalized deal. */ export interface Schema$SetReadyToServeRequest {} + /** + * Generic targeting with string values. + */ + export interface Schema$StringTargetingDimension { + /** + * Required. How the items in this list should be targeted. + */ + selectionType?: string | null; + /** + * Required. The values specified. + */ + values?: string[] | null; + } /** * Request message for SubscribeAuctionPackage. */ @@ -1228,6 +1501,19 @@ export namespace authorizedbuyersmarketplace_v1alpha { */ clients?: string[] | null; } + /** + * Defines targeting criteria for handling the IAB audience and content Taxonomy ID space. + */ + export interface Schema$TaxonomyTargeting { + /** + * Optional. The list of excluded content taxonomy IDs. + */ + excludedTaxonomyIds?: string[] | null; + /** + * Optional. The list of targeted content taxonomy IDs. + */ + targetedTaxonomyIds?: string[] | null; + } /** * Represents targeting about various types of technology. */ @@ -1318,6 +1604,32 @@ export namespace authorizedbuyersmarketplace_v1alpha { */ targetedUris?: string[] | null; } + /** + * Represents the size of the video player that can be targeted. Both width and height are required to be set to non-zero values. + */ + export interface Schema$VideoPlayerSizeTargeting { + /** + * Required. The minimum height of the video player in pixels. + */ + minimumHeight?: string | null; + /** + * Required. The minimum width of the video player in pixels. + */ + minimumWidth?: string | null; + } + /** + * Defines targeting criteria based on the video placement type, often corresponding to the IAB OpenRTB 'plcmt' field. + */ + export interface Schema$VideoPlcmtTargeting { + /** + * Required. The selection type for the list of video plcmts. + */ + selectionType?: string | null; + /** + * Required. The list of targeted video plcmts types. If empty, inventory will be targeted regardless of video plcmt type. + */ + videoPlcmtTypes?: string[] | null; + } /** * Represents targeting information about video. */ @@ -9095,4 +9407,1208 @@ export namespace authorizedbuyersmarketplace_v1alpha { */ parent?: string; } + + export class Resource$Curators { + context: APIRequestContext; + curatedPackages: Resource$Curators$Curatedpackages; + constructor(context: APIRequestContext) { + this.context = context; + this.curatedPackages = new Resource$Curators$Curatedpackages( + this.context + ); + } + } + + export class Resource$Curators$Curatedpackages { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Activates an existing curated package. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/authorizedbuyersmarketplace.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const authorizedbuyersmarketplace = + * google.authorizedbuyersmarketplace('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/authorized-buyers-marketplace'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await authorizedbuyersmarketplace.curators.curatedPackages.activate({ + * // Required. The name of the curated package to activate. Format: `curators/{accountId\}/curatedPackages/{curatedPackageId\}` + * name: 'curators/my-curator/curatedPackages/my-curatedPackage', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accessSettings": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "feeCpm": {}, + * // "floorPriceCpm": {}, + * // "name": "my_name", + * // "state": "my_state", + * // "targeting": {}, + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + activate( + params: Params$Resource$Curators$Curatedpackages$Activate, + options: StreamMethodOptions + ): Promise>; + activate( + params?: Params$Resource$Curators$Curatedpackages$Activate, + options?: MethodOptions + ): Promise>; + activate( + params: Params$Resource$Curators$Curatedpackages$Activate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + activate( + params: Params$Resource$Curators$Curatedpackages$Activate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + activate( + params: Params$Resource$Curators$Curatedpackages$Activate, + callback: BodyResponseCallback + ): void; + activate(callback: BodyResponseCallback): void; + activate( + paramsOrCallback?: + | Params$Resource$Curators$Curatedpackages$Activate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Curators$Curatedpackages$Activate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Curators$Curatedpackages$Activate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:activate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a new curated package. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/authorizedbuyersmarketplace.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const authorizedbuyersmarketplace = + * google.authorizedbuyersmarketplace('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/authorized-buyers-marketplace'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await authorizedbuyersmarketplace.curators.curatedPackages.create( + * { + * // Required. The parent curator account where this curated package will be created. Format: `curators/{accountId\}` + * parent: 'curators/my-curator', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accessSettings": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "feeCpm": {}, + * // "floorPriceCpm": {}, + * // "name": "my_name", + * // "state": "my_state", + * // "targeting": {}, + * // "updateTime": "my_updateTime" + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "accessSettings": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "feeCpm": {}, + * // "floorPriceCpm": {}, + * // "name": "my_name", + * // "state": "my_state", + * // "targeting": {}, + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Curators$Curatedpackages$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Curators$Curatedpackages$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Curators$Curatedpackages$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Curators$Curatedpackages$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Curators$Curatedpackages$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Curators$Curatedpackages$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Curators$Curatedpackages$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Curators$Curatedpackages$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/curatedPackages').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deactivates an existing curated package. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/authorizedbuyersmarketplace.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const authorizedbuyersmarketplace = + * google.authorizedbuyersmarketplace('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/authorized-buyers-marketplace'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await authorizedbuyersmarketplace.curators.curatedPackages.deactivate({ + * // Required. The name of the curated package to deactivate. Format: `curators/{accountId\}/curatedPackages/{curatedPackageId\}` + * name: 'curators/my-curator/curatedPackages/my-curatedPackage', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accessSettings": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "feeCpm": {}, + * // "floorPriceCpm": {}, + * // "name": "my_name", + * // "state": "my_state", + * // "targeting": {}, + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + deactivate( + params: Params$Resource$Curators$Curatedpackages$Deactivate, + options: StreamMethodOptions + ): Promise>; + deactivate( + params?: Params$Resource$Curators$Curatedpackages$Deactivate, + options?: MethodOptions + ): Promise>; + deactivate( + params: Params$Resource$Curators$Curatedpackages$Deactivate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deactivate( + params: Params$Resource$Curators$Curatedpackages$Deactivate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deactivate( + params: Params$Resource$Curators$Curatedpackages$Deactivate, + callback: BodyResponseCallback + ): void; + deactivate(callback: BodyResponseCallback): void; + deactivate( + paramsOrCallback?: + | Params$Resource$Curators$Curatedpackages$Deactivate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Curators$Curatedpackages$Deactivate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Curators$Curatedpackages$Deactivate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:deactivate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a curated package given its resource name. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/authorizedbuyersmarketplace.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const authorizedbuyersmarketplace = + * google.authorizedbuyersmarketplace('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/authorized-buyers-marketplace'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await authorizedbuyersmarketplace.curators.curatedPackages.get({ + * // Required. The name of the curated package to retrieve. Format: `curators/{accountId\}/curatedPackages/{curatedPackageId\}` + * name: 'curators/my-curator/curatedPackages/my-curatedPackage', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accessSettings": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "feeCpm": {}, + * // "floorPriceCpm": {}, + * // "name": "my_name", + * // "state": "my_state", + * // "targeting": {}, + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Curators$Curatedpackages$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Curators$Curatedpackages$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Curators$Curatedpackages$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Curators$Curatedpackages$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Curators$Curatedpackages$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Curators$Curatedpackages$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Curators$Curatedpackages$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Curators$Curatedpackages$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists curated packages owned by the specified curator. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/authorizedbuyersmarketplace.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const authorizedbuyersmarketplace = + * google.authorizedbuyersmarketplace('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/authorized-buyers-marketplace'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await authorizedbuyersmarketplace.curators.curatedPackages.list({ + * // Optional. Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Supported columns for filtering are: * displayName * createTime * updateTime * state * feeCpm.currencyCode * feeCpm.units * feeCpm.nanos * floorPriceCpm.currencyCode * floorPriceCpm.units * floorPriceCpm.nanos + * filter: 'placeholder-value', + * // Optional. Requested page size. The server may return fewer results than requested. Max allowed page size is 500. If unspecified, the server will default to 500. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous `ListCuratedPackages` call. Provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. The parent curator account which owns this collection of curated packages. Format: `curators/{accountId\}` + * parent: 'curators/my-curator', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "curatedPackages": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Curators$Curatedpackages$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Curators$Curatedpackages$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Curators$Curatedpackages$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Curators$Curatedpackages$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Curators$Curatedpackages$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Curators$Curatedpackages$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Curators$Curatedpackages$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Curators$Curatedpackages$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/curatedPackages').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing curated package. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/authorizedbuyersmarketplace.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const authorizedbuyersmarketplace = + * google.authorizedbuyersmarketplace('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/authorized-buyers-marketplace'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await authorizedbuyersmarketplace.curators.curatedPackages.patch({ + * // Identifier. The unique resource name for the curated package. Format: `curators/{accountId\}/curatedPackages/{curatedPackageId\}` + * name: 'curators/my-curator/curatedPackages/my-curatedPackage', + * // Optional. List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement (the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accessSettings": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "feeCpm": {}, + * // "floorPriceCpm": {}, + * // "name": "my_name", + * // "state": "my_state", + * // "targeting": {}, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accessSettings": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "feeCpm": {}, + * // "floorPriceCpm": {}, + * // "name": "my_name", + * // "state": "my_state", + * // "targeting": {}, + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Curators$Curatedpackages$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Curators$Curatedpackages$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Curators$Curatedpackages$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Curators$Curatedpackages$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Curators$Curatedpackages$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Curators$Curatedpackages$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Curators$Curatedpackages$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Curators$Curatedpackages$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Curators$Curatedpackages$Activate extends StandardParameters { + /** + * Required. The name of the curated package to activate. Format: `curators/{accountId\}/curatedPackages/{curatedPackageId\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ActivateCuratedPackageRequest; + } + export interface Params$Resource$Curators$Curatedpackages$Create extends StandardParameters { + /** + * Required. The parent curator account where this curated package will be created. Format: `curators/{accountId\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CuratedPackage; + } + export interface Params$Resource$Curators$Curatedpackages$Deactivate extends StandardParameters { + /** + * Required. The name of the curated package to deactivate. Format: `curators/{accountId\}/curatedPackages/{curatedPackageId\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DeactivateCuratedPackageRequest; + } + export interface Params$Resource$Curators$Curatedpackages$Get extends StandardParameters { + /** + * Required. The name of the curated package to retrieve. Format: `curators/{accountId\}/curatedPackages/{curatedPackageId\}` + */ + name?: string; + } + export interface Params$Resource$Curators$Curatedpackages$List extends StandardParameters { + /** + * Optional. Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Supported columns for filtering are: * displayName * createTime * updateTime * state * feeCpm.currencyCode * feeCpm.units * feeCpm.nanos * floorPriceCpm.currencyCode * floorPriceCpm.units * floorPriceCpm.nanos + */ + filter?: string; + /** + * Optional. Requested page size. The server may return fewer results than requested. Max allowed page size is 500. If unspecified, the server will default to 500. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListCuratedPackages` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The parent curator account which owns this collection of curated packages. Format: `curators/{accountId\}` + */ + parent?: string; + } + export interface Params$Resource$Curators$Curatedpackages$Patch extends StandardParameters { + /** + * Identifier. The unique resource name for the curated package. Format: `curators/{accountId\}/curatedPackages/{curatedPackageId\}` + */ + name?: string; + /** + * Optional. List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement (the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CuratedPackage; + } + + export class Resource$Mediaplanners { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists all media planner accounts that the caller has access to. For curators, this will return all media planners that have accepted curator terms. For other accounts, attempting to list media planners will return an error. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/authorizedbuyersmarketplace.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const authorizedbuyersmarketplace = + * google.authorizedbuyersmarketplace('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/authorized-buyers-marketplace'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await authorizedbuyersmarketplace.mediaPlanners.list({ + * // Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Supported columns for filtering are: * `name` * `displayName` * `ancestorNames` + * filter: 'placeholder-value', + * // The maximum number of media planners to return. If unspecified, at most 100 media planners will be returned. The maximum value is 500; values above 500 will be coerced to 500. + * pageSize: 'placeholder-value', + * // A token identifying a page of results the server should return. This value is received from a previous `ListMediaPlanners` call in ListMediaPlannersResponse.nextPageToken. + * pageToken: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "mediaPlanners": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Mediaplanners$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Mediaplanners$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Mediaplanners$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Mediaplanners$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Mediaplanners$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Mediaplanners$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Mediaplanners$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Mediaplanners$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/mediaPlanners').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Mediaplanners$List extends StandardParameters { + /** + * Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Supported columns for filtering are: * `name` * `displayName` * `ancestorNames` + */ + filter?: string; + /** + * The maximum number of media planners to return. If unspecified, at most 100 media planners will be returned. The maximum value is 500; values above 500 will be coerced to 500. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. This value is received from a previous `ListMediaPlanners` call in ListMediaPlannersResponse.nextPageToken. + */ + pageToken?: string; + } } diff --git a/src/apis/authorizedbuyersmarketplace/v1beta.ts b/src/apis/authorizedbuyersmarketplace/v1beta.ts index 7a01cfa91fc..ba7ad8b3fcd 100644 --- a/src/apis/authorizedbuyersmarketplace/v1beta.ts +++ b/src/apis/authorizedbuyersmarketplace/v1beta.ts @@ -113,6 +113,7 @@ export namespace authorizedbuyersmarketplace_v1beta { export class Authorizedbuyersmarketplace { context: APIRequestContext; curators: Resource$Curators; + mediaPlanners: Resource$Mediaplanners; constructor(options: GlobalOptions, google?: GoogleConfigurable) { this.context = { @@ -121,80 +122,1454 @@ export namespace authorizedbuyersmarketplace_v1beta { }; this.curators = new Resource$Curators(this.context); + this.mediaPlanners = new Resource$Mediaplanners(this.context); } } + /** + * Settings for controlling access to a curated package. + */ + export interface Schema$AccessControlSettings { + /** + * Required. Immutable. The list of media planners that are explicitly granted access to the curated package. Eligible media planners can be found in the mediaPlanners.list method. Only a single media planner may be allowlisted at this time. Format: `mediaPlanners/{mediaPlannerAccountId\}` + */ + allowlistedMediaPlanners?: string[] | null; + } + /** + * Request message for ActivateCuratedPackage. + */ + export interface Schema$ActivateCuratedPackageRequest {} /** * Request message for activating a data segment */ export interface Schema$ActivateDataSegmentRequest {} + /** + * Represents size of a single ad slot, or a creative. + */ + export interface Schema$AdSize { + /** + * The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. + */ + height?: string | null; + /** + * The type of the ad slot size. + */ + type?: string | null; + /** + * The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. + */ + width?: string | null; + } + /** + * Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. + */ + export interface Schema$CriteriaTargeting { + /** + * A list of numeric IDs to be excluded. + */ + excludedCriteriaIds?: string[] | null; + /** + * A list of numeric IDs to be included. + */ + targetedCriteriaIds?: string[] | null; + } + /** + * Represents a curated package of inventory created and managed by a Curator. + */ + export interface Schema$CuratedPackage { + /** + * Required. Settings for controlling access to the curated package. Access to this curated package is limited to the allowlisted media planners and the creator. Buyers and bidders can not be allowlisted for or have direct access to this resource. + */ + accessSettings?: Schema$AccessControlSettings; + /** + * Output only. The timestamp when the curated package was created. Can be used to filter the response of the curatedPackages.list method. + */ + createTime?: string | null; + /** + * Optional. A description of the curated package, provided by the curator. + */ + description?: string | null; + /** + * Required. The display name assigned to the curated package by the curator. Can be used to filter the response of the curatedPackages.list method. + */ + displayName?: string | null; + /** + * Optional. The CPM fee charged by the curator to buyers using this curated package. Can be used to filter the response of the curatedPackages.list method. + */ + feeCpm?: Schema$Money; + /** + * Optional. The minimum CPM a buyer has to bid to participate in auctions for inventory in this curated package. Can be used to filter the response of the curatedPackages.list method. + */ + floorPriceCpm?: Schema$Money; + /** + * Identifier. The unique resource name for the curated package. Format: `curators/{accountId\}/curatedPackages/{curatedPackageId\}` + */ + name?: string | null; + /** + * Output only. The state of the curated package. Can be used to filter the response of the curatedPackages.list method. + */ + state?: string | null; + /** + * Optional. Targeting criteria for the curated package. + */ + targeting?: Schema$PackageTargeting; + /** + * Output only. The timestamp when the curated package was last updated. Can be used to filter the response of the curatedPackages.list method. + */ + updateTime?: string | null; + } /** * Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. */ export interface Schema$DataSegment { /** - * Optional. A fixed fee charged per thousand impressions. Once set, the currency code cannot be changed. + * Optional. A fixed fee charged per thousand impressions. Once set, the currency code cannot be changed. + */ + cpmFee?: Schema$Money; + /** + * Output only. Time the data segment was created. + */ + createTime?: string | null; + /** + * Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. v1alpha format: `buyers/{accountId\}/dataSegments/{curatorDataSegmentId\}` v1beta format: `curators/{curatorAccountId\}/dataSegments/{curatorDataSegmentId\}` + */ + name?: string | null; + /** + * Output only. The state of the data segment. + */ + state?: string | null; + /** + * Output only. Time the data segment was last updated. + */ + updateTime?: string | null; + } + /** + * Request message for DeactivateCuratedPackage. + */ + export interface Schema$DeactivateCuratedPackageRequest {} + /** + * Request message for deactivating a data segment + */ + export interface Schema$DeactivateDataSegmentRequest {} + /** + * Response message for ListCuratedPackages. + */ + export interface Schema$ListCuratedPackagesResponse { + /** + * The list of curated packages. + */ + curatedPackages?: Schema$CuratedPackage[]; + /** + * A token to retrieve the next page of results. Pass this value in the ListCuratedPackagesRequest.pageToken field in the subsequent call to `ListCuratedPackages` method to retrieve the next page of results. If empty, then there are no more results. + */ + nextPageToken?: string | null; + } + /** + * Response message for listing data segments. + */ + export interface Schema$ListDataSegmentsResponse { + /** + * The list of data segments. + */ + dataSegments?: Schema$DataSegment[]; + /** + * Continuation token for fetching the next page of results. Pass this value in the ListDataSegmentsRequest.pageToken field in the subsequent call to the `ListDataSegments` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + /** + * A response containing media planner account information. + */ + export interface Schema$ListMediaPlannersResponse { + /** + * List of media planners. + */ + mediaPlanners?: Schema$MediaPlanner[]; + /** + * A token which can be passed to a subsequent call to the `ListMediaPlanners` method to retrieve the next page of results in ListMediaPlannersRequest.pageToken. + */ + nextPageToken?: string | null; + } + /** + * Represents a media planner account. + */ + export interface Schema$MediaPlanner { + /** + * Output only. Account ID of the media planner. + */ + accountId?: string | null; + /** + * Output only. The ancestor names of the media planner. Format: `mediaPlanners/{mediaPlannerAccountId\}` Can be used to filter the response of the mediaPlanners.list method. + */ + ancestorNames?: string[] | null; + /** + * Output only. The display name of the media planner. Can be used to filter the response of the mediaPlanners.list method. + */ + displayName?: string | null; + /** + * Identifier. The unique resource name of the media planner. Format: `mediaPlanners/{mediaPlannerAccountId\}` Can be used to filter the response of the mediaPlanners.list method. + */ + name?: string | null; + } + /** + * Represents an amount of money with its currency type. + */ + export interface Schema$Money { + /** + * The three-letter currency code defined in ISO 4217. + */ + currencyCode?: string | null; + /** + * Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + */ + nanos?: number | null; + /** + * The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + */ + units?: string | null; + } + /** + * Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. + */ + export interface Schema$PackagePlacementTargeting { + /** + * Optional. The list of targeted mobile app categories. + */ + includedMobileAppCategoryTargeting?: string[] | null; + /** + * Optional. The list of targeted or excluded mobile application IDs that publishers own. Currently, only Android and Apple apps are supported. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. + */ + mobileAppTargeting?: Schema$StringTargetingDimension; + /** + * Optional. The list of targeted or excluded URLs. The domains should have the http/https stripped (for example, google.com), and can contain a max of 5 paths per url. + */ + uriTargeting?: Schema$StringTargetingDimension; + } + /** + * Represents targeting about publisher provided signals. Different publisher provided signals types will be logically OR'ed. + */ + export interface Schema$PackagePublisherProvidedSignalsTargeting { + /** + * Optional. The list of targeted or excluded audience IDs. Based off of IAB Audience Taxonomy version 1.1 (https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Audience%20Taxonomies/Audience%20Taxonomy%201.1.tsv) + */ + audienceTargeting?: Schema$TaxonomyTargeting; + /** + * Optional. The list of targeted or excluded content IDs. Based off of IAB Content Taxonomy version 2.2 (https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Content%20Taxonomies/Content%20Taxonomy%202.2.tsv) + */ + contentTargeting?: Schema$TaxonomyTargeting; + /** + * Optional. The list of targeted and excluded video and audio signals IDs. These are additional signals supported by publisher provided signals. + */ + videoAndAudioSignalsTargeting?: Schema$StringTargetingDimension; + } + /** + * Targeting criteria for curated and auction packages. + */ + export interface Schema$PackageTargeting { + /** + * Optional. The geo criteria IDs to be included or excluded as defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv. If unset, inventory will be targeted regardless of geo. + */ + geoTargeting?: Schema$CriteriaTargeting; + /** + * Optional. The targeted accelerated mobile page type. If unset, inventory will be targeted regardless of AMP status. + */ + includedAcceleratedMobilePageType?: string | null; + /** + * Optional. The list of ad sizes to target. If unset, inventory will be targeted regardless of ad size. Curated packages supports `PIXEL` and `INTERSTITIAL` ad sizes. + */ + includedAdSizes?: Schema$AdSize[]; + /** + * Optional. The included list of targeted authorized seller statuses. If empty, inventory will be targeted regardless of seller status. + */ + includedAuthorizedSellerStatuses?: string[] | null; + /** + * Optional. The creative format to target. If unset, all creative markup types are targeted. + */ + includedCreativeFormat?: string | null; + /** + * Optional. The active data segments to be targeted. If unset, inventory will be targeted regardless of data segments. Format: `curators/{account_id\}/dataSegments/{data_segment_id\}` + */ + includedDataSegments?: string[] | null; + /** + * Optional. The list of included device types to target. If empty, all device types are targeted. + */ + includedDeviceTypes?: string[] | null; + /** + * Optional. The environment to target. If unspecified, all environments are targeted. + */ + includedEnvironment?: string | null; + /** + * Optional. The targeted native inventory types. If empty, inventory will be targeted regardless of native inventory type. + */ + includedNativeInventoryTypes?: string[] | null; + /** + * Optional. The list of targeted open measurement types. If empty, inventory will be targeted regardless of Open Measurement support. + */ + includedOpenMeasurementTypes?: string[] | null; + /** + * Optional. The list of targeted restricted categories. If empty, inventory will be targeted regardless of restricted categories. + */ + includedRestrictedCategories?: string[] | null; + /** + * Optional. The targeted rewarded type. If unset, inventory will be targeted regardless of rewarded type. + */ + includedRewardedType?: string | null; + /** + * Optional. The languages to target. If unset, inventory will be targeted regardless of language. See https://developers.google.com/google-ads/api/data/codes-formats#languages for the list of supported language codes. + */ + languageTargeting?: Schema$StringTargetingDimension; + /** + * Optional. The targeted minimum predicted click through rate, ranging in values [10, 10000] (0.01% - 10%). A value of 50 means that the configuration will only match adslots for which we predict at least 0.05% click through rate. An unset value indicates inventory will be targeted regardless of predicted click through rate. + */ + minimumPredictedClickThroughRatePercentageMillis?: string | null; + /** + * Optional. The targeted minimum predicted viewability percentage. This value must be a multiple of 10 between 10 and 90 (inclusive). For example, 10 is valid, but 0, 15, and 100 are not. A value of 10 means that the configuration will only match adslots for which we predict at least 10% viewability. An unset value indicates inventory will be targeted regardless of predicted viewability. + */ + minimumPredictedViewabilityPercentage?: string | null; + /** + * Optional. Placement targeting information, for example, URL, mobile applications. + */ + placementTargeting?: Schema$PackagePlacementTargeting; + /** + * Optional. The publisher provided signals to target. If unset, inventory will be targeted regardless of publisher provided signals. + */ + publisherProvidedSignalsTargeting?: Schema$PackagePublisherProvidedSignalsTargeting; + /** + * Optional. The targeted publishers. If unset, inventory will be targeted regardless of publisher. Publishers are identified by their publisher ID from ads.txt / app-ads.txt. See https://iabtechlab.com/ads-txt/ and https://iabtechlab.com/app-ads-txt/ for more details. + */ + publisherTargeting?: Schema$StringTargetingDimension; + /** + * Optional. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals. If unset, inventory will be targeted regardless of vertical. + */ + verticalTargeting?: Schema$CriteriaTargeting; + /** + * Optional. Video specific targeting criteria. + */ + videoTargeting?: Schema$PackageVideoTargeting; + } + /** + * Video specific targeting criteria. + */ + export interface Schema$PackageVideoTargeting { + /** + * Optional. The targeted video delivery method. If unset, inventory will be targeted regardless of video delivery method. + */ + includedContentDeliveryMethod?: string | null; + /** + * Optional. The targeted maximum video ad duration. If unset, inventory will be targeted regardless of maximum video ad duration. + */ + includedMaximumAdDurationTargeting?: string | null; + /** + * Optional. The list of targeted video mime types using the IANA published MIME type strings (https://www.iana.org/assignments/media-types/media-types.xhtml). If empty, inventory will be targeted regardless of video mime type. + */ + includedMimeTypes?: string[] | null; + /** + * Optional. The list of targeted video playback methods. If empty, inventory will be targeted regardless of video playback method. + */ + includedPlaybackMethods?: string[] | null; + /** + * Optional. The targeted video player size. If unset, inventory will be targeted regardless of video player size. + */ + includedPlayerSizeTargeting?: Schema$VideoPlayerSizeTargeting; + /** + * Optional. The targeted video ad position types. If empty, inventory will be targeted regardless of video ad position type. + */ + includedPositionTypes?: string[] | null; + /** + * Optional. The targeted minimum predicted completion rate percentage. This value must be a multiple of 10 between 10 and 90 (inclusive). For example, 10 is valid, but 0, 15, and 100 are not. A value of 10 means that the configuration will only match adslots for which we predict at least 10% completion rate. An unset value indicates inventory will be targeted regardless of predicted completion rate. + */ + minimumPredictedCompletionRatePercentage?: string | null; + /** + * Optional. The targeted video plcmt types. If unset, inventory will be targeted regardless of video plcmt type. + */ + plcmtTargeting?: Schema$VideoPlcmtTargeting; + } + /** + * Generic targeting with string values. + */ + export interface Schema$StringTargetingDimension { + /** + * Required. How the items in this list should be targeted. + */ + selectionType?: string | null; + /** + * Required. The values specified. + */ + values?: string[] | null; + } + /** + * Defines targeting criteria for handling the IAB audience and content Taxonomy ID space. + */ + export interface Schema$TaxonomyTargeting { + /** + * Optional. The list of excluded content taxonomy IDs. + */ + excludedTaxonomyIds?: string[] | null; + /** + * Optional. The list of targeted content taxonomy IDs. + */ + targetedTaxonomyIds?: string[] | null; + } + /** + * Represents the size of the video player that can be targeted. Both width and height are required to be set to non-zero values. + */ + export interface Schema$VideoPlayerSizeTargeting { + /** + * Required. The minimum height of the video player in pixels. + */ + minimumHeight?: string | null; + /** + * Required. The minimum width of the video player in pixels. + */ + minimumWidth?: string | null; + } + /** + * Defines targeting criteria based on the video placement type, often corresponding to the IAB OpenRTB 'plcmt' field. + */ + export interface Schema$VideoPlcmtTargeting { + /** + * Required. The selection type for the list of video plcmts. + */ + selectionType?: string | null; + /** + * Required. The list of targeted video plcmts types. If empty, inventory will be targeted regardless of video plcmt type. + */ + videoPlcmtTypes?: string[] | null; + } + + export class Resource$Curators { + context: APIRequestContext; + curatedPackages: Resource$Curators$Curatedpackages; + dataSegments: Resource$Curators$Datasegments; + constructor(context: APIRequestContext) { + this.context = context; + this.curatedPackages = new Resource$Curators$Curatedpackages( + this.context + ); + this.dataSegments = new Resource$Curators$Datasegments(this.context); + } + } + + export class Resource$Curators$Curatedpackages { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Activates an existing curated package. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/authorizedbuyersmarketplace.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const authorizedbuyersmarketplace = + * google.authorizedbuyersmarketplace('v1beta'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/authorized-buyers-marketplace'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await authorizedbuyersmarketplace.curators.curatedPackages.activate({ + * // Required. The name of the curated package to activate. Format: `curators/{accountId\}/curatedPackages/{curatedPackageId\}` + * name: 'curators/my-curator/curatedPackages/my-curatedPackage', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accessSettings": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "feeCpm": {}, + * // "floorPriceCpm": {}, + * // "name": "my_name", + * // "state": "my_state", + * // "targeting": {}, + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + activate( + params: Params$Resource$Curators$Curatedpackages$Activate, + options: StreamMethodOptions + ): Promise>; + activate( + params?: Params$Resource$Curators$Curatedpackages$Activate, + options?: MethodOptions + ): Promise>; + activate( + params: Params$Resource$Curators$Curatedpackages$Activate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + activate( + params: Params$Resource$Curators$Curatedpackages$Activate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + activate( + params: Params$Resource$Curators$Curatedpackages$Activate, + callback: BodyResponseCallback + ): void; + activate(callback: BodyResponseCallback): void; + activate( + paramsOrCallback?: + | Params$Resource$Curators$Curatedpackages$Activate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Curators$Curatedpackages$Activate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Curators$Curatedpackages$Activate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}:activate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a new curated package. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/authorizedbuyersmarketplace.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const authorizedbuyersmarketplace = + * google.authorizedbuyersmarketplace('v1beta'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/authorized-buyers-marketplace'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await authorizedbuyersmarketplace.curators.curatedPackages.create( + * { + * // Required. The parent curator account where this curated package will be created. Format: `curators/{accountId\}` + * parent: 'curators/my-curator', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accessSettings": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "feeCpm": {}, + * // "floorPriceCpm": {}, + * // "name": "my_name", + * // "state": "my_state", + * // "targeting": {}, + * // "updateTime": "my_updateTime" + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "accessSettings": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "feeCpm": {}, + * // "floorPriceCpm": {}, + * // "name": "my_name", + * // "state": "my_state", + * // "targeting": {}, + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Curators$Curatedpackages$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Curators$Curatedpackages$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Curators$Curatedpackages$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Curators$Curatedpackages$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Curators$Curatedpackages$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Curators$Curatedpackages$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Curators$Curatedpackages$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Curators$Curatedpackages$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/curatedPackages').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deactivates an existing curated package. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/authorizedbuyersmarketplace.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const authorizedbuyersmarketplace = + * google.authorizedbuyersmarketplace('v1beta'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/authorized-buyers-marketplace'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await authorizedbuyersmarketplace.curators.curatedPackages.deactivate({ + * // Required. The name of the curated package to deactivate. Format: `curators/{accountId\}/curatedPackages/{curatedPackageId\}` + * name: 'curators/my-curator/curatedPackages/my-curatedPackage', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accessSettings": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "feeCpm": {}, + * // "floorPriceCpm": {}, + * // "name": "my_name", + * // "state": "my_state", + * // "targeting": {}, + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + deactivate( + params: Params$Resource$Curators$Curatedpackages$Deactivate, + options: StreamMethodOptions + ): Promise>; + deactivate( + params?: Params$Resource$Curators$Curatedpackages$Deactivate, + options?: MethodOptions + ): Promise>; + deactivate( + params: Params$Resource$Curators$Curatedpackages$Deactivate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deactivate( + params: Params$Resource$Curators$Curatedpackages$Deactivate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deactivate( + params: Params$Resource$Curators$Curatedpackages$Deactivate, + callback: BodyResponseCallback + ): void; + deactivate(callback: BodyResponseCallback): void; + deactivate( + paramsOrCallback?: + | Params$Resource$Curators$Curatedpackages$Deactivate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Curators$Curatedpackages$Deactivate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Curators$Curatedpackages$Deactivate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}:deactivate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a curated package given its resource name. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/authorizedbuyersmarketplace.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const authorizedbuyersmarketplace = + * google.authorizedbuyersmarketplace('v1beta'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/authorized-buyers-marketplace'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await authorizedbuyersmarketplace.curators.curatedPackages.get({ + * // Required. The name of the curated package to retrieve. Format: `curators/{accountId\}/curatedPackages/{curatedPackageId\}` + * name: 'curators/my-curator/curatedPackages/my-curatedPackage', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accessSettings": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "feeCpm": {}, + * // "floorPriceCpm": {}, + * // "name": "my_name", + * // "state": "my_state", + * // "targeting": {}, + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Curators$Curatedpackages$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Curators$Curatedpackages$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Curators$Curatedpackages$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Curators$Curatedpackages$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Curators$Curatedpackages$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Curators$Curatedpackages$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Curators$Curatedpackages$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Curators$Curatedpackages$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists curated packages owned by the specified curator. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/authorizedbuyersmarketplace.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const authorizedbuyersmarketplace = + * google.authorizedbuyersmarketplace('v1beta'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/authorized-buyers-marketplace'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await authorizedbuyersmarketplace.curators.curatedPackages.list({ + * // Optional. Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Supported columns for filtering are: * displayName * createTime * updateTime * state * feeCpm.currencyCode * feeCpm.units * feeCpm.nanos * floorPriceCpm.currencyCode * floorPriceCpm.units * floorPriceCpm.nanos + * filter: 'placeholder-value', + * // Optional. Requested page size. The server may return fewer results than requested. Max allowed page size is 500. If unspecified, the server will default to 500. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous `ListCuratedPackages` call. Provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. The parent curator account which owns this collection of curated packages. Format: `curators/{accountId\}` + * parent: 'curators/my-curator', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "curatedPackages": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Curators$Curatedpackages$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Curators$Curatedpackages$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Curators$Curatedpackages$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Curators$Curatedpackages$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Curators$Curatedpackages$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Curators$Curatedpackages$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Curators$Curatedpackages$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Curators$Curatedpackages$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/curatedPackages').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing curated package. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/authorizedbuyersmarketplace.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const authorizedbuyersmarketplace = + * google.authorizedbuyersmarketplace('v1beta'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/authorized-buyers-marketplace'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await authorizedbuyersmarketplace.curators.curatedPackages.patch({ + * // Identifier. The unique resource name for the curated package. Format: `curators/{accountId\}/curatedPackages/{curatedPackageId\}` + * name: 'curators/my-curator/curatedPackages/my-curatedPackage', + * // Optional. List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement (the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accessSettings": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "feeCpm": {}, + * // "floorPriceCpm": {}, + * // "name": "my_name", + * // "state": "my_state", + * // "targeting": {}, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accessSettings": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "feeCpm": {}, + * // "floorPriceCpm": {}, + * // "name": "my_name", + * // "state": "my_state", + * // "targeting": {}, + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Curators$Curatedpackages$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Curators$Curatedpackages$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Curators$Curatedpackages$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Curators$Curatedpackages$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Curators$Curatedpackages$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Curators$Curatedpackages$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Curators$Curatedpackages$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Curators$Curatedpackages$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Curators$Curatedpackages$Activate extends StandardParameters { + /** + * Required. The name of the curated package to activate. Format: `curators/{accountId\}/curatedPackages/{curatedPackageId\}` */ - cpmFee?: Schema$Money; + name?: string; + /** - * Output only. Time the data segment was created. + * Request body metadata */ - createTime?: string | null; + requestBody?: Schema$ActivateCuratedPackageRequest; + } + export interface Params$Resource$Curators$Curatedpackages$Create extends StandardParameters { /** - * Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. v1alpha format: `buyers/{accountId\}/dataSegments/{curatorDataSegmentId\}` v1beta format: `curators/{curatorAccountId\}/dataSegments/{curatorDataSegmentId\}` + * Required. The parent curator account where this curated package will be created. Format: `curators/{accountId\}` */ - name?: string | null; + parent?: string; + /** - * Output only. The state of the data segment. + * Request body metadata */ - state?: string | null; + requestBody?: Schema$CuratedPackage; + } + export interface Params$Resource$Curators$Curatedpackages$Deactivate extends StandardParameters { /** - * Output only. Time the data segment was last updated. + * Required. The name of the curated package to deactivate. Format: `curators/{accountId\}/curatedPackages/{curatedPackageId\}` */ - updateTime?: string | null; - } - /** - * Request message for deactivating a data segment - */ - export interface Schema$DeactivateDataSegmentRequest {} - /** - * Response message for listing data segments. - */ - export interface Schema$ListDataSegmentsResponse { + name?: string; + /** - * The list of data segments. + * Request body metadata */ - dataSegments?: Schema$DataSegment[]; + requestBody?: Schema$DeactivateCuratedPackageRequest; + } + export interface Params$Resource$Curators$Curatedpackages$Get extends StandardParameters { /** - * Continuation token for fetching the next page of results. Pass this value in the ListDataSegmentsRequest.pageToken field in the subsequent call to the `ListDataSegments` method to retrieve the next page of results. + * Required. The name of the curated package to retrieve. Format: `curators/{accountId\}/curatedPackages/{curatedPackageId\}` */ - nextPageToken?: string | null; + name?: string; } - /** - * Represents an amount of money with its currency type. - */ - export interface Schema$Money { + export interface Params$Resource$Curators$Curatedpackages$List extends StandardParameters { /** - * The three-letter currency code defined in ISO 4217. + * Optional. Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Supported columns for filtering are: * displayName * createTime * updateTime * state * feeCpm.currencyCode * feeCpm.units * feeCpm.nanos * floorPriceCpm.currencyCode * floorPriceCpm.units * floorPriceCpm.nanos */ - currencyCode?: string | null; + filter?: string; /** - * Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + * Optional. Requested page size. The server may return fewer results than requested. Max allowed page size is 500. If unspecified, the server will default to 500. */ - nanos?: number | null; + pageSize?: number; /** - * The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + * Optional. A page token, received from a previous `ListCuratedPackages` call. Provide this to retrieve the subsequent page. */ - units?: string | null; + pageToken?: string; + /** + * Required. The parent curator account which owns this collection of curated packages. Format: `curators/{accountId\}` + */ + parent?: string; } + export interface Params$Resource$Curators$Curatedpackages$Patch extends StandardParameters { + /** + * Identifier. The unique resource name for the curated package. Format: `curators/{accountId\}/curatedPackages/{curatedPackageId\}` + */ + name?: string; + /** + * Optional. List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement (the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask. + */ + updateMask?: string; - export class Resource$Curators { - context: APIRequestContext; - dataSegments: Resource$Curators$Datasegments; - constructor(context: APIRequestContext) { - this.context = context; - this.dataSegments = new Resource$Curators$Datasegments(this.context); - } + /** + * Request body metadata + */ + requestBody?: Schema$CuratedPackage; } export class Resource$Curators$Datasegments { @@ -1172,4 +2547,175 @@ export namespace authorizedbuyersmarketplace_v1beta { */ requestBody?: Schema$DataSegment; } + + export class Resource$Mediaplanners { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists all media planner accounts that the caller has access to. For curators, this will return all media planners that have accepted curator terms. For other accounts, attempting to list media planners will return an error. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/authorizedbuyersmarketplace.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const authorizedbuyersmarketplace = + * google.authorizedbuyersmarketplace('v1beta'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/authorized-buyers-marketplace'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await authorizedbuyersmarketplace.mediaPlanners.list({ + * // Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Supported columns for filtering are: * `name` * `displayName` * `ancestorNames` + * filter: 'placeholder-value', + * // The maximum number of media planners to return. If unspecified, at most 100 media planners will be returned. The maximum value is 500; values above 500 will be coerced to 500. + * pageSize: 'placeholder-value', + * // A token identifying a page of results the server should return. This value is received from a previous `ListMediaPlanners` call in ListMediaPlannersResponse.nextPageToken. + * pageToken: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "mediaPlanners": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Mediaplanners$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Mediaplanners$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Mediaplanners$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Mediaplanners$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Mediaplanners$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Mediaplanners$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Mediaplanners$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Mediaplanners$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/mediaPlanners').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Mediaplanners$List extends StandardParameters { + /** + * Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Supported columns for filtering are: * `name` * `displayName` * `ancestorNames` + */ + filter?: string; + /** + * The maximum number of media planners to return. If unspecified, at most 100 media planners will be returned. The maximum value is 500; values above 500 will be coerced to 500. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. This value is received from a previous `ListMediaPlanners` call in ListMediaPlannersResponse.nextPageToken. + */ + pageToken?: string; + } } diff --git a/src/apis/beyondcorp/v1.ts b/src/apis/beyondcorp/v1.ts index eb1e25650ac..dcf9824d386 100644 --- a/src/apis/beyondcorp/v1.ts +++ b/src/apis/beyondcorp/v1.ts @@ -1518,7 +1518,7 @@ export namespace beyondcorp_v1 { */ operations?: Schema$GoogleLongrunningOperation[]; /** - * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. */ unreachable?: string[] | null; } @@ -2120,7 +2120,7 @@ export namespace beyondcorp_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); @@ -2280,7 +2280,7 @@ export namespace beyondcorp_v1 { */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; } @@ -7536,7 +7536,7 @@ export namespace beyondcorp_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); @@ -7696,7 +7696,7 @@ export namespace beyondcorp_v1 { */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; } diff --git a/src/apis/beyondcorp/v1alpha.ts b/src/apis/beyondcorp/v1alpha.ts index 0438b75c811..8339497c58d 100644 --- a/src/apis/beyondcorp/v1alpha.ts +++ b/src/apis/beyondcorp/v1alpha.ts @@ -2009,7 +2009,7 @@ export namespace beyondcorp_v1alpha { */ operations?: Schema$GoogleLongrunningOperation[]; /** - * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. */ unreachable?: string[] | null; } @@ -3864,7 +3864,7 @@ export namespace beyondcorp_v1alpha { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); @@ -4024,7 +4024,7 @@ export namespace beyondcorp_v1alpha { */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; } @@ -14782,7 +14782,7 @@ export namespace beyondcorp_v1alpha { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); @@ -14942,7 +14942,7 @@ export namespace beyondcorp_v1alpha { */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; } diff --git a/src/apis/clouddeploy/v1.ts b/src/apis/clouddeploy/v1.ts index a4c636560a4..96755dc2441 100644 --- a/src/apis/clouddeploy/v1.ts +++ b/src/apis/clouddeploy/v1.ts @@ -2179,7 +2179,7 @@ export namespace clouddeploy_v1 { */ targetSnapshots?: Schema$Target[]; /** - * Optional. The tool versions to use for this release and all subsequent operations involving this release. If unset, then it will freeze the tool versions at the time of release creation. + * Optional. The tool versions to use for this release and all subsequent operations involving this release. If unset, tool versions are frozen when the release is created. */ toolVersions?: Schema$ToolVersions; /** @@ -2200,7 +2200,7 @@ export namespace clouddeploy_v1 { */ helmVersionSupportedCondition?: Schema$ToolVersionSupportedCondition; /** - * Output only. Details around the support state of the release's Kpt version. + * Output only. Details around the support state of the release's kpt version. */ kptVersionSupportedCondition?: Schema$ToolVersionSupportedCondition; /** @@ -3309,11 +3309,11 @@ export namespace clouddeploy_v1 { */ export interface Schema$ToolVersions { /** - * Optional. The docker version to use for Cloud Deploy operations. + * Optional. The Docker version to use for Cloud Deploy operations. */ docker?: string | null; /** - * Optional. The helm version to use for Cloud Deploy operations. + * Optional. The Helm version to use for Cloud Deploy operations. */ helm?: string | null; /** @@ -3321,24 +3321,24 @@ export namespace clouddeploy_v1 { */ kpt?: string | null; /** - * Optional. The kubectl version to use for Cloud Deploy operations. + * Optional. The Kubectl version to use for Cloud Deploy operations. */ kubectl?: string | null; /** - * Optional. The kustomize version to use for Cloud Deploy operations. + * Optional. The Kustomize version to use for Cloud Deploy operations. */ kustomize?: string | null; /** - * Optional. The skaffold version to use for Cloud Deploy operations. + * Optional. The Skaffold version to use for Cloud Deploy operations. */ skaffold?: string | null; } /** - * ToolVersionSupportedCondition contains information about when support for the release's version of a Tool ends. + * ToolVersionSupportedCondition contains information about when support for the release's version of a tool ends. */ export interface Schema$ToolVersionSupportedCondition { /** - * Output only. The time at which this release's version of the Tool will enter maintenance mode. + * Output only. The time at which this release's version of the tool will enter maintenance mode. */ maintenanceModeTime?: string | null; /** @@ -3346,11 +3346,11 @@ export namespace clouddeploy_v1 { */ status?: boolean | null; /** - * Output only. The time at which this release's version of the Tool will no longer be supported. + * Output only. The time at which this release's version of the tool will no longer be supported. */ supportExpirationTime?: string | null; /** - * Output only. The Tool support state for this release's version of the Tool. + * Output only. The tool support state for this release's version of the tool. */ toolVersionSupportState?: string | null; } diff --git a/src/apis/contactcenterinsights/v1.ts b/src/apis/contactcenterinsights/v1.ts index 3fdca349a65..de5a138ff81 100644 --- a/src/apis/contactcenterinsights/v1.ts +++ b/src/apis/contactcenterinsights/v1.ts @@ -2080,11 +2080,11 @@ export namespace contactcenterinsights_v1 { */ export interface Schema$GoogleCloudContactcenterinsightsV1alpha1QaAnswer { /** - * List of all individual answers given to the question. + * Lists all answer sources containing one or more answer values of a specific source type, e.g., all system-generated answer sources, or all manual edit answer sources. */ answerSources?: Schema$GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerSource[]; /** - * The main answer value, incorporating any manual edits if they exist. + * The answer value from this source. This field is populated by default, unless the question has a selection strategy configured to return multiple answer values, in which case `answer_values` will be populated instead. */ answerValue?: Schema$GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue; /** @@ -2109,7 +2109,7 @@ export namespace contactcenterinsights_v1 { */ export interface Schema$GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerSource { /** - * The answer value from this source. + * The answer value from this source. This field is populated by default, unless the question has a selection strategy configured to return multiple answer values, in which case `answer_values` will be populated instead. */ answerValue?: Schema$GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue; /** @@ -2644,6 +2644,10 @@ export namespace contactcenterinsights_v1 { * Speech-to-Text configuration. Speech-to-Text settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint. */ export interface Schema$GoogleCloudContactcenterinsightsV1alpha1SpeechConfig { + /** + * Whether to disable word time offsets. If true, the `enable_word_time_offsets` field in the recognition config will be set to false. + */ + disableWordTimeOffsets?: boolean | null; /** * The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id\}/locations/{location\}/recognizer/{recognizer\}` */ @@ -3702,6 +3706,19 @@ export namespace contactcenterinsights_v1 { */ metadataUri?: string | null; } + /** + * A wrapper for holding the audio for any given turn. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio { + /** + * The duration of the audio. + */ + audioDuration?: string | null; + /** + * The Cloud Storage URI of the audio for any given turn. + */ + audioGcsUri?: string | null; + } /** * One channel of conversation-level sentiment data. */ @@ -4652,6 +4669,15 @@ export namespace contactcenterinsights_v1 { */ transcriptUri?: string | null; } + /** + * The response from a GenerateConversationSignedAudio request. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1GenerateConversationSignedAudioResponse { + /** + * The signed uris for the audio. + */ + signedAudioUris?: Schema$GoogleCloudContactcenterinsightsV1SignedAudioUris; + } /** * The data for a hold annotation. */ @@ -7398,11 +7424,11 @@ export namespace contactcenterinsights_v1 { */ export interface Schema$GoogleCloudContactcenterinsightsV1mainQaAnswer { /** - * List of all individual answers given to the question. + * Lists all answer sources containing one or more answer values of a specific source type, e.g., all system-generated answer sources, or all manual edit answer sources. */ answerSources?: Schema$GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerSource[]; /** - * The main answer value, incorporating any manual edits if they exist. + * The answer value from this source. This field is populated by default, unless the question has a selection strategy configured to return multiple answer values, in which case `answer_values` will be populated instead. */ answerValue?: Schema$GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue; /** @@ -7427,7 +7453,7 @@ export namespace contactcenterinsights_v1 { */ export interface Schema$GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerSource { /** - * The answer value from this source. + * The answer value from this source. This field is populated by default, unless the question has a selection strategy configured to return multiple answer values, in which case `answer_values` will be populated instead. */ answerValue?: Schema$GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue; /** @@ -7962,6 +7988,10 @@ export namespace contactcenterinsights_v1 { * Speech-to-Text configuration. Speech-to-Text settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint. */ export interface Schema$GoogleCloudContactcenterinsightsV1mainSpeechConfig { + /** + * Whether to disable word time offsets. If true, the `enable_word_time_offsets` field in the recognition config will be set to false. + */ + disableWordTimeOffsets?: boolean | null; /** * The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id\}/locations/{location\}/recognizer/{recognizer\}` */ @@ -8250,11 +8280,11 @@ export namespace contactcenterinsights_v1 { */ export interface Schema$GoogleCloudContactcenterinsightsV1QaAnswer { /** - * List of all individual answers given to the question. + * Lists all answer sources containing one or more answer values of a specific source type, e.g., all system-generated answer sources, or all manual edit answer sources. */ answerSources?: Schema$GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource[]; /** - * The main answer value, incorporating any manual edits if they exist. + * The answer value from this source. This field is populated by default, unless the question has a selection strategy configured to return multiple answer values, in which case `answer_values` will be populated instead. */ answerValue?: Schema$GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue; /** @@ -8279,7 +8309,7 @@ export namespace contactcenterinsights_v1 { */ export interface Schema$GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource { /** - * The answer value from this source. + * The answer value from this source. This field is populated by default, unless the question has a selection strategy configured to return multiple answer values, in which case `answer_values` will be populated instead. */ answerValue?: Schema$GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue; /** @@ -9107,6 +9137,23 @@ export namespace contactcenterinsights_v1 { */ uploadConversationAnalysisPercentage?: number | null; } + /** + * Signed audio URIs for a conversation. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1SignedAudioUris { + /** + * The signed URI for the audio from the Dialogflow conversation source. + */ + signedDialogflowAudioUri?: string | null; + /** + * The signed URI for the audio from the Cloud Storage conversation source. + */ + signedGcsAudioUri?: string | null; + /** + * The signed URI for the audio corresponding to each turn in the conversation. + */ + signedTurnLevelAudios?: Schema$GoogleCloudContactcenterinsightsV1ConversationDataSourceTurnLevelAudio[]; + } /** * The data for a silence annotation. */ @@ -9157,6 +9204,10 @@ export namespace contactcenterinsights_v1 { * Speech-to-Text configuration. Speech-to-Text settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint. */ export interface Schema$GoogleCloudContactcenterinsightsV1SpeechConfig { + /** + * Whether to disable word time offsets. If true, the `enable_word_time_offsets` field in the recognition config will be set to false. + */ + disableWordTimeOffsets?: boolean | null; /** * The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id\}/locations/{location\}/recognizer/{recognizer\}` */ @@ -15864,6 +15915,158 @@ export namespace contactcenterinsights_v1 { } } + /** + * Gets the signed URI for the audio for the given conversation. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/contactcenterinsights.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const contactcenterinsights = google.contactcenterinsights('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.generateSignedAudio( + * { + * // Required. The name of the conversation to sign. + * name: 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "signedAudioUris": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + generateSignedAudio( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Generatesignedaudio, + options: StreamMethodOptions + ): Promise>; + generateSignedAudio( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Generatesignedaudio, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + generateSignedAudio( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Generatesignedaudio, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateSignedAudio( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Generatesignedaudio, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateSignedAudio( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Generatesignedaudio, + callback: BodyResponseCallback + ): void; + generateSignedAudio( + callback: BodyResponseCallback + ): void; + generateSignedAudio( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Generatesignedaudio + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Generatesignedaudio; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Generatesignedaudio; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:generateSignedAudio').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Gets a conversation. * @example @@ -16221,6 +16424,12 @@ export namespace contactcenterinsights_v1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Generatesignedaudio extends StandardParameters { + /** + * Required. The name of the conversation to sign. + */ + name?: string; + } export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Get extends StandardParameters { /** * Required. The name of the conversation to get. @@ -20336,6 +20545,158 @@ export namespace contactcenterinsights_v1 { } } + /** + * Gets the signed URI for the audio for the given conversation. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/contactcenterinsights.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const contactcenterinsights = google.contactcenterinsights('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await contactcenterinsights.projects.locations.conversations.generateSignedAudio( + * { + * // Required. The name of the conversation to sign. + * name: 'projects/my-project/locations/my-location/conversations/my-conversation', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "signedAudioUris": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + generateSignedAudio( + params: Params$Resource$Projects$Locations$Conversations$Generatesignedaudio, + options: StreamMethodOptions + ): Promise>; + generateSignedAudio( + params?: Params$Resource$Projects$Locations$Conversations$Generatesignedaudio, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + generateSignedAudio( + params: Params$Resource$Projects$Locations$Conversations$Generatesignedaudio, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateSignedAudio( + params: Params$Resource$Projects$Locations$Conversations$Generatesignedaudio, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateSignedAudio( + params: Params$Resource$Projects$Locations$Conversations$Generatesignedaudio, + callback: BodyResponseCallback + ): void; + generateSignedAudio( + callback: BodyResponseCallback + ): void; + generateSignedAudio( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Generatesignedaudio + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Generatesignedaudio; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Conversations$Generatesignedaudio; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:generateSignedAudio').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Gets a conversation. * @example @@ -21400,6 +21761,12 @@ export namespace contactcenterinsights_v1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Conversations$Generatesignedaudio extends StandardParameters { + /** + * Required. The name of the conversation to sign. + */ + name?: string; + } export interface Params$Resource$Projects$Locations$Conversations$Get extends StandardParameters { /** * Required. The name of the conversation to get. @@ -27114,6 +27481,158 @@ export namespace contactcenterinsights_v1 { } } + /** + * Gets the signed URI for the audio for the given conversation. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/contactcenterinsights.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const contactcenterinsights = google.contactcenterinsights('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await contactcenterinsights.projects.locations.datasets.conversations.generateSignedAudio( + * { + * // Required. The name of the conversation to sign. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/conversations/my-conversation', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "signedAudioUris": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + generateSignedAudio( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Generatesignedaudio, + options: StreamMethodOptions + ): Promise>; + generateSignedAudio( + params?: Params$Resource$Projects$Locations$Datasets$Conversations$Generatesignedaudio, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + generateSignedAudio( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Generatesignedaudio, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateSignedAudio( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Generatesignedaudio, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateSignedAudio( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Generatesignedaudio, + callback: BodyResponseCallback + ): void; + generateSignedAudio( + callback: BodyResponseCallback + ): void; + generateSignedAudio( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Conversations$Generatesignedaudio + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Generatesignedaudio; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Conversations$Generatesignedaudio; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:generateSignedAudio').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Gets a conversation. * @example @@ -27802,6 +28321,12 @@ export namespace contactcenterinsights_v1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Datasets$Conversations$Generatesignedaudio extends StandardParameters { + /** + * Required. The name of the conversation to sign. + */ + name?: string; + } export interface Params$Resource$Projects$Locations$Datasets$Conversations$Get extends StandardParameters { /** * Required. The name of the conversation to get. diff --git a/src/apis/container/v1.ts b/src/apis/container/v1.ts index 0402d389255..10bc35fb6cc 100644 --- a/src/apis/container/v1.ts +++ b/src/apis/container/v1.ts @@ -606,7 +606,7 @@ export namespace container_v1 { */ fqdns?: string[] | null; /** - * Google Secret Manager (GCP) certificate configuration. + * Secret Manager certificate configuration. */ gcpSecretManagerCertificateConfig?: Schema$GCPSecretManagerCertificateConfig; } diff --git a/src/apis/container/v1beta1.ts b/src/apis/container/v1beta1.ts index f7a3dc797a8..74195fd3392 100644 --- a/src/apis/container/v1beta1.ts +++ b/src/apis/container/v1beta1.ts @@ -2817,7 +2817,7 @@ export namespace container_v1beta1 { */ export interface Schema$Master { /** - * Output only. The compatibility status of the control plane. It should be empty if the cluster does not have emulated version. For details, see go/user-initiated-rollbackable-upgrade-design. + * Output only. The compatibility status of the control plane. It should be empty if the cluster does not have emulated version. */ compatibilityStatus?: Schema$CompatibilityStatus; } diff --git a/src/apis/dataflow/v1b3.ts b/src/apis/dataflow/v1b3.ts index 3c1d2838871..0f5d91546f1 100644 --- a/src/apis/dataflow/v1b3.ts +++ b/src/apis/dataflow/v1b3.ts @@ -2609,6 +2609,10 @@ export namespace dataflow_v1b3 { * Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. */ export interface Schema$RuntimeUpdatableParams { + /** + * Optional. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. + */ + acceptableBacklogDuration?: string | null; /** * The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs. */ diff --git a/src/apis/developerconnect/v1.ts b/src/apis/developerconnect/v1.ts index 149c327ebda..ae9aa192642 100644 --- a/src/apis/developerconnect/v1.ts +++ b/src/apis/developerconnect/v1.ts @@ -686,6 +686,10 @@ export namespace developerconnect_v1 { * Optional. Setting this to true allows the git proxy to be used for performing git operations on the repositories linked in the connection. */ enabled?: boolean | null; + /** + * Output only. The base URI for the HTTP proxy endpoint. Has the format `https://{generatedID\}-c-h-{shortRegion\}.developerconnect.dev` Populated only when enabled is set to true. This endpoint is used by other Google services that integrate with Developer Connect. + */ + httpProxyBaseUri?: string | null; } /** * Message describing the GitRepositoryLink object diff --git a/src/apis/discoveryengine/v1.ts b/src/apis/discoveryengine/v1.ts index 17a5fc067ff..25b1a8a8428 100644 --- a/src/apis/discoveryengine/v1.ts +++ b/src/apis/discoveryengine/v1.ts @@ -4320,12 +4320,16 @@ export namespace discoveryengine_v1 { * The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. */ regionCode?: string | null; + /** + * Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search. + */ + relevanceFilterSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec; /** * Optional. The specification for returning the relevance score. */ relevanceScoreSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec; /** - * The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search. + * The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search. */ relevanceThreshold?: string | null; /** @@ -4764,6 +4768,32 @@ export namespace discoveryengine_v1 { */ pinUnexpandedResults?: boolean | null; } + /** + * Relevance filtering specification. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec { + /** + * Optional. Relevance filtering threshold specification for keyword search. + */ + keywordSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec; + /** + * Optional. Relevance filtering threshold specification for semantic search. + */ + semanticSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec; + } + /** + * Specification for relevance filtering on a specific sub-search. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec { + /** + * Pre-defined relevance threshold for the sub-search. + */ + relevanceThreshold?: string | null; + /** + * Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0]. + */ + semanticRelevanceThreshold?: number | null; + } /** * The specification for returning the document relevance score. */ @@ -8479,12 +8509,16 @@ export namespace discoveryengine_v1 { * The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. */ regionCode?: string | null; + /** + * Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search. + */ + relevanceFilterSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec; /** * Optional. The specification for returning the relevance score. */ relevanceScoreSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec; /** - * The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search. + * The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search. */ relevanceThreshold?: string | null; /** @@ -8919,6 +8953,32 @@ export namespace discoveryengine_v1 { */ pinUnexpandedResults?: boolean | null; } + /** + * Relevance filtering specification. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec { + /** + * Optional. Relevance filtering threshold specification for keyword search. + */ + keywordSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec; + /** + * Optional. Relevance filtering threshold specification for semantic search. + */ + semanticSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec; + } + /** + * Specification for relevance filtering on a specific sub-search. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec { + /** + * Pre-defined relevance threshold for the sub-search. + */ + relevanceThreshold?: string | null; + /** + * Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0]. + */ + semanticRelevanceThreshold?: number | null; + } /** * The specification for returning the document relevance score. */ @@ -12902,7 +12962,7 @@ export namespace discoveryengine_v1 { */ relevanceScoreSpec?: Schema$GoogleCloudDiscoveryengineV1SearchRequestRelevanceScoreSpec; /** - * The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search. + * The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search. */ relevanceThreshold?: string | null; /** @@ -17509,7 +17569,7 @@ export namespace discoveryengine_v1 { * await discoveryengine.projects.locations.collections.updateDataConnector({ * // Output only. The full resource name of the Data Connector. Format: `projects/x/locations/x/collections/x/dataConnector`. * name: 'projects/my-project/locations/my-location/collections/my-collection/dataConnector', - * // Indicates which fields in the provided DataConnector to update. Supported field paths include: - refresh_interval - params - auto_run_disabled - action_config - action_config.action_params - action_config.service_name - destination_configs - blocking_reasons - sync_mode - incremental_sync_disabled - incremental_refresh_interval Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error. + * // Indicates which fields in the provided DataConnector to update. Supported field paths include: - `refresh_interval` - `params` - `auto_run_disabled` - `action_config` - `action_config.action_params` - `action_config.service_name` - `destination_configs` - `blocking_reasons` - `sync_mode` - `incremental_sync_disabled` - `incremental_refresh_interval` - `data_protection_policy` Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error. * updateMask: 'placeholder-value', * * // Request body metadata @@ -17727,7 +17787,7 @@ export namespace discoveryengine_v1 { */ name?: string; /** - * Indicates which fields in the provided DataConnector to update. Supported field paths include: - refresh_interval - params - auto_run_disabled - action_config - action_config.action_params - action_config.service_name - destination_configs - blocking_reasons - sync_mode - incremental_sync_disabled - incremental_refresh_interval Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error. + * Indicates which fields in the provided DataConnector to update. Supported field paths include: - `refresh_interval` - `params` - `auto_run_disabled` - `action_config` - `action_config.action_params` - `action_config.service_name` - `destination_configs` - `blocking_reasons` - `sync_mode` - `incremental_sync_disabled` - `incremental_refresh_interval` - `data_protection_policy` Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error. */ updateMask?: string; diff --git a/src/apis/discoveryengine/v1alpha.ts b/src/apis/discoveryengine/v1alpha.ts index 0a41e950e71..59df4e4a0ff 100644 --- a/src/apis/discoveryengine/v1alpha.ts +++ b/src/apis/discoveryengine/v1alpha.ts @@ -8233,12 +8233,16 @@ export namespace discoveryengine_v1alpha { * The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. */ regionCode?: string | null; + /** + * Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search. + */ + relevanceFilterSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec; /** * Optional. The specification for returning the relevance score. */ relevanceScoreSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec; /** - * The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search. + * The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search. */ relevanceThreshold?: string | null; /** @@ -8677,6 +8681,32 @@ export namespace discoveryengine_v1alpha { */ pinUnexpandedResults?: boolean | null; } + /** + * Relevance filtering specification. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec { + /** + * Optional. Relevance filtering threshold specification for keyword search. + */ + keywordSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec; + /** + * Optional. Relevance filtering threshold specification for semantic search. + */ + semanticSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec; + } + /** + * Specification for relevance filtering on a specific sub-search. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec { + /** + * Pre-defined relevance threshold for the sub-search. + */ + relevanceThreshold?: string | null; + /** + * Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0]. + */ + semanticRelevanceThreshold?: number | null; + } /** * The specification for returning the document relevance score. */ @@ -12942,12 +12972,16 @@ export namespace discoveryengine_v1alpha { * The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. */ regionCode?: string | null; + /** + * Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search. + */ + relevanceFilterSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec; /** * Optional. The specification for returning the relevance score. */ relevanceScoreSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec; /** - * The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search. + * The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search. */ relevanceThreshold?: string | null; /** @@ -13382,6 +13416,32 @@ export namespace discoveryengine_v1alpha { */ pinUnexpandedResults?: boolean | null; } + /** + * Relevance filtering specification. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec { + /** + * Optional. Relevance filtering threshold specification for keyword search. + */ + keywordSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec; + /** + * Optional. Relevance filtering threshold specification for semantic search. + */ + semanticSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec; + } + /** + * Specification for relevance filtering on a specific sub-search. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec { + /** + * Pre-defined relevance threshold for the sub-search. + */ + relevanceThreshold?: string | null; + /** + * Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0]. + */ + semanticRelevanceThreshold?: number | null; + } /** * The specification for returning the document relevance score. */ @@ -22655,7 +22715,7 @@ export namespace discoveryengine_v1alpha { * await discoveryengine.projects.locations.collections.updateDataConnector({ * // Output only. The full resource name of the Data Connector. Format: `projects/x/locations/x/collections/x/dataConnector`. * name: 'projects/my-project/locations/my-location/collections/my-collection/dataConnector', - * // Indicates which fields in the provided DataConnector to update. Supported field paths include: - refresh_interval - params - auto_run_disabled - action_config - action_config.action_params - action_config.service_name - destination_configs - blocking_reasons - sync_mode - incremental_sync_disabled - incremental_refresh_interval Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error. + * // Indicates which fields in the provided DataConnector to update. Supported field paths include: - `refresh_interval` - `params` - `auto_run_disabled` - `action_config` - `action_config.action_params` - `action_config.service_name` - `destination_configs` - `blocking_reasons` - `sync_mode` - `incremental_sync_disabled` - `incremental_refresh_interval` - `data_protection_policy` Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error. * updateMask: 'placeholder-value', * * // Request body metadata @@ -22912,7 +22972,7 @@ export namespace discoveryengine_v1alpha { */ name?: string; /** - * Indicates which fields in the provided DataConnector to update. Supported field paths include: - refresh_interval - params - auto_run_disabled - action_config - action_config.action_params - action_config.service_name - destination_configs - blocking_reasons - sync_mode - incremental_sync_disabled - incremental_refresh_interval Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error. + * Indicates which fields in the provided DataConnector to update. Supported field paths include: - `refresh_interval` - `params` - `auto_run_disabled` - `action_config` - `action_config.action_params` - `action_config.service_name` - `destination_configs` - `blocking_reasons` - `sync_mode` - `incremental_sync_disabled` - `incremental_refresh_interval` - `data_protection_policy` Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error. */ updateMask?: string; @@ -34850,6 +34910,7 @@ export namespace discoveryengine_v1alpha { * // "rankingExpression": "my_rankingExpression", * // "rankingExpressionBackend": "my_rankingExpressionBackend", * // "regionCode": "my_regionCode", + * // "relevanceFilterSpec": {}, * // "relevanceScoreSpec": {}, * // "relevanceThreshold": "my_relevanceThreshold", * // "safeSearch": false, @@ -35071,6 +35132,7 @@ export namespace discoveryengine_v1alpha { * // "rankingExpression": "my_rankingExpression", * // "rankingExpressionBackend": "my_rankingExpressionBackend", * // "regionCode": "my_regionCode", + * // "relevanceFilterSpec": {}, * // "relevanceScoreSpec": {}, * // "relevanceThreshold": "my_relevanceThreshold", * // "safeSearch": false, @@ -52048,6 +52110,7 @@ export namespace discoveryengine_v1alpha { * // "rankingExpression": "my_rankingExpression", * // "rankingExpressionBackend": "my_rankingExpressionBackend", * // "regionCode": "my_regionCode", + * // "relevanceFilterSpec": {}, * // "relevanceScoreSpec": {}, * // "relevanceThreshold": "my_relevanceThreshold", * // "safeSearch": false, @@ -52269,6 +52332,7 @@ export namespace discoveryengine_v1alpha { * // "rankingExpression": "my_rankingExpression", * // "rankingExpressionBackend": "my_rankingExpressionBackend", * // "regionCode": "my_regionCode", + * // "relevanceFilterSpec": {}, * // "relevanceScoreSpec": {}, * // "relevanceThreshold": "my_relevanceThreshold", * // "safeSearch": false, @@ -65041,6 +65105,7 @@ export namespace discoveryengine_v1alpha { * // "rankingExpression": "my_rankingExpression", * // "rankingExpressionBackend": "my_rankingExpressionBackend", * // "regionCode": "my_regionCode", + * // "relevanceFilterSpec": {}, * // "relevanceScoreSpec": {}, * // "relevanceThreshold": "my_relevanceThreshold", * // "safeSearch": false, @@ -65261,6 +65326,7 @@ export namespace discoveryengine_v1alpha { * // "rankingExpression": "my_rankingExpression", * // "rankingExpressionBackend": "my_rankingExpressionBackend", * // "regionCode": "my_regionCode", + * // "relevanceFilterSpec": {}, * // "relevanceScoreSpec": {}, * // "relevanceThreshold": "my_relevanceThreshold", * // "safeSearch": false, diff --git a/src/apis/discoveryengine/v1beta.ts b/src/apis/discoveryengine/v1beta.ts index 33e0e2bb8bf..ebf4f38f820 100644 --- a/src/apis/discoveryengine/v1beta.ts +++ b/src/apis/discoveryengine/v1beta.ts @@ -4086,12 +4086,16 @@ export namespace discoveryengine_v1beta { * The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. */ regionCode?: string | null; + /** + * Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search. + */ + relevanceFilterSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec; /** * Optional. The specification for returning the relevance score. */ relevanceScoreSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec; /** - * The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search. + * The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search. */ relevanceThreshold?: string | null; /** @@ -4530,6 +4534,32 @@ export namespace discoveryengine_v1beta { */ pinUnexpandedResults?: boolean | null; } + /** + * Relevance filtering specification. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec { + /** + * Optional. Relevance filtering threshold specification for keyword search. + */ + keywordSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec; + /** + * Optional. Relevance filtering threshold specification for semantic search. + */ + semanticSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec; + } + /** + * Specification for relevance filtering on a specific sub-search. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec { + /** + * Pre-defined relevance threshold for the sub-search. + */ + relevanceThreshold?: string | null; + /** + * Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0]. + */ + semanticRelevanceThreshold?: number | null; + } /** * The specification for returning the document relevance score. */ @@ -10732,12 +10762,16 @@ export namespace discoveryengine_v1beta { * The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. */ regionCode?: string | null; + /** + * Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search. + */ + relevanceFilterSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec; /** * Optional. The specification for returning the relevance score. */ relevanceScoreSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec; /** - * The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search. + * The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search. */ relevanceThreshold?: string | null; /** @@ -11172,6 +11206,32 @@ export namespace discoveryengine_v1beta { */ pinUnexpandedResults?: boolean | null; } + /** + * Relevance filtering specification. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec { + /** + * Optional. Relevance filtering threshold specification for keyword search. + */ + keywordSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec; + /** + * Optional. Relevance filtering threshold specification for semantic search. + */ + semanticSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec; + } + /** + * Specification for relevance filtering on a specific sub-search. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec { + /** + * Pre-defined relevance threshold for the sub-search. + */ + relevanceThreshold?: string | null; + /** + * Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0]. + */ + semanticRelevanceThreshold?: number | null; + } /** * The specification for returning the document relevance score. */ @@ -27051,6 +27111,7 @@ export namespace discoveryengine_v1beta { * // "rankingExpression": "my_rankingExpression", * // "rankingExpressionBackend": "my_rankingExpressionBackend", * // "regionCode": "my_regionCode", + * // "relevanceFilterSpec": {}, * // "relevanceScoreSpec": {}, * // "relevanceThreshold": "my_relevanceThreshold", * // "safeSearch": false, @@ -27270,6 +27331,7 @@ export namespace discoveryengine_v1beta { * // "rankingExpression": "my_rankingExpression", * // "rankingExpressionBackend": "my_rankingExpressionBackend", * // "regionCode": "my_regionCode", + * // "relevanceFilterSpec": {}, * // "relevanceScoreSpec": {}, * // "relevanceThreshold": "my_relevanceThreshold", * // "safeSearch": false, @@ -39773,6 +39835,7 @@ export namespace discoveryengine_v1beta { * // "rankingExpression": "my_rankingExpression", * // "rankingExpressionBackend": "my_rankingExpressionBackend", * // "regionCode": "my_regionCode", + * // "relevanceFilterSpec": {}, * // "relevanceScoreSpec": {}, * // "relevanceThreshold": "my_relevanceThreshold", * // "safeSearch": false, @@ -39992,6 +40055,7 @@ export namespace discoveryengine_v1beta { * // "rankingExpression": "my_rankingExpression", * // "rankingExpressionBackend": "my_rankingExpressionBackend", * // "regionCode": "my_regionCode", + * // "relevanceFilterSpec": {}, * // "relevanceScoreSpec": {}, * // "relevanceThreshold": "my_relevanceThreshold", * // "safeSearch": false, @@ -50511,6 +50575,7 @@ export namespace discoveryengine_v1beta { * // "rankingExpression": "my_rankingExpression", * // "rankingExpressionBackend": "my_rankingExpressionBackend", * // "regionCode": "my_regionCode", + * // "relevanceFilterSpec": {}, * // "relevanceScoreSpec": {}, * // "relevanceThreshold": "my_relevanceThreshold", * // "safeSearch": false, @@ -50729,6 +50794,7 @@ export namespace discoveryengine_v1beta { * // "rankingExpression": "my_rankingExpression", * // "rankingExpressionBackend": "my_rankingExpressionBackend", * // "regionCode": "my_regionCode", + * // "relevanceFilterSpec": {}, * // "relevanceScoreSpec": {}, * // "relevanceThreshold": "my_relevanceThreshold", * // "safeSearch": false, diff --git a/src/apis/dlp/v2.ts b/src/apis/dlp/v2.ts index e9681a32f79..e7a2b52f4b3 100644 --- a/src/apis/dlp/v2.ts +++ b/src/apis/dlp/v2.ts @@ -1219,7 +1219,7 @@ export namespace dlp_v2 { */ sensitivityScore?: Schema$GooglePrivacyDlpV2SensitivityScore; /** - * Load an existing `StoredInfoType` resource for use in `InspectDataSource`. Not currently supported in `InspectContent`. + * Loads an existing `StoredInfoType` resource. */ storedType?: Schema$GooglePrivacyDlpV2StoredType; /** diff --git a/src/apis/eventarc/v1.ts b/src/apis/eventarc/v1.ts index aca9a02f8ae..2a1007543fc 100644 --- a/src/apis/eventarc/v1.ts +++ b/src/apis/eventarc/v1.ts @@ -1335,7 +1335,6 @@ export namespace eventarc_v1 { channels: Resource$Projects$Locations$Channels; enrollments: Resource$Projects$Locations$Enrollments; googleApiSources: Resource$Projects$Locations$Googleapisources; - kafkaSources: Resource$Projects$Locations$Kafkasources; messageBuses: Resource$Projects$Locations$Messagebuses; operations: Resource$Projects$Locations$Operations; pipelines: Resource$Projects$Locations$Pipelines; @@ -1352,9 +1351,6 @@ export namespace eventarc_v1 { this.googleApiSources = new Resource$Projects$Locations$Googleapisources( this.context ); - this.kafkaSources = new Resource$Projects$Locations$Kafkasources( - this.context - ); this.messageBuses = new Resource$Projects$Locations$Messagebuses( this.context ); @@ -7153,494 +7149,6 @@ export namespace eventarc_v1 { requestBody?: Schema$TestIamPermissionsRequest; } - export class Resource$Projects$Locations$Kafkasources { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/eventarc.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const eventarc = google.eventarc('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await eventarc.projects.locations.kafkaSources.getIamPolicy({ - * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - * 'options.requestedPolicyVersion': 'placeholder-value', - * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/kafkaSources/my-kafkaSource', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Kafkasources$Getiampolicy, - options: StreamMethodOptions - ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Kafkasources$Getiampolicy, - options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Kafkasources$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Kafkasources$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Kafkasources$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Kafkasources$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Kafkasources$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Kafkasources$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://eventarc.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/eventarc.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const eventarc = google.eventarc('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await eventarc.projects.locations.kafkaSources.setIamPolicy({ - * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/kafkaSources/my-kafkaSource', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {}, - * // "updateMask": "my_updateMask" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "auditConfigs": [], - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Kafkasources$Setiampolicy, - options: StreamMethodOptions - ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Kafkasources$Setiampolicy, - options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Kafkasources$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Kafkasources$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Kafkasources$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Kafkasources$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Kafkasources$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Kafkasources$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://eventarc.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/eventarc.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const eventarc = google.eventarc('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await eventarc.projects.locations.kafkaSources.testIamPermissions( - * { - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/kafkaSources/my-kafkaSource', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "permissions": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Kafkasources$Testiampermissions, - options: StreamMethodOptions - ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Kafkasources$Testiampermissions, - options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Projects$Locations$Kafkasources$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Kafkasources$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Kafkasources$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Kafkasources$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Kafkasources$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Kafkasources$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://eventarc.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Kafkasources$Getiampolicy extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Kafkasources$Setiampolicy extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Kafkasources$Testiampermissions extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; - } - export class Resource$Projects$Locations$Messagebuses { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/firestore/v1.ts b/src/apis/firestore/v1.ts index a8cb1bffc43..55f8f432869 100644 --- a/src/apis/firestore/v1.ts +++ b/src/apis/firestore/v1.ts @@ -469,6 +469,48 @@ export namespace firestore_v1 { * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} */ export interface Schema$Empty {} + /** + * The request for Firestore.ExecutePipeline. + */ + export interface Schema$ExecutePipelineRequest { + /** + * Execute the pipeline in a new transaction. The identifier of the newly created transaction will be returned in the first response on the stream. This defaults to a read-only transaction. + */ + newTransaction?: Schema$TransactionOptions; + /** + * Execute the pipeline in a snapshot transaction at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. + */ + readTime?: string | null; + /** + * A pipelined operation. + */ + structuredPipeline?: Schema$StructuredPipeline; + /** + * Run the query within an already active transaction. The value here is the opaque transaction ID to execute the query in. + */ + transaction?: string | null; + } + /** + * The response for Firestore.Execute. + */ + export interface Schema$ExecutePipelineResponse { + /** + * The time at which the results are valid. This is a (not strictly) monotonically increasing value across multiple responses in the same stream. The API guarantees that all previously returned results are still valid at the latest `execution_time`. This allows the API consumer to treat the query if it ran at the latest `execution_time` returned. If the query returns no results, a response with `execution_time` and no `results` will be sent, and this represents the time at which the operation was run. + */ + executionTime?: string | null; + /** + * Query explain stats. This is present on the **last** response if the request configured explain to run in 'analyze' or 'explain' mode in the pipeline options. If the query does not return any results, a response with `explain_stats` and no `results` will still be sent. + */ + explainStats?: Schema$ExplainStats; + /** + * An ordered batch of results returned executing a pipeline. The batch size is variable, and can even be zero for when only a partial progress message is returned. The fields present in the returned documents are only those that were explicitly requested in the pipeline, this includes those like `__name__` and `__update_time__`. This is explicitly a divergence from `Firestore.RunQuery` / `Firestore.GetDocument` RPCs which always return such fields even when they are not specified in the `mask`. + */ + results?: Schema$Document[]; + /** + * Newly created transaction identifier. This field is only specified as part of the first response from the server, alongside the `results` field when the original request specified ExecuteRequest.new_transaction. + */ + transaction?: string | null; + } /** * Execution statistics for the query. */ @@ -529,6 +571,15 @@ export namespace firestore_v1 { */ analyze?: boolean | null; } + /** + * Pipeline explain stats. Depending on the explain options in the original request, this can contain the optimized plan and / or execution stats. + */ + export interface Schema$ExplainStats { + /** + * The format depends on the `output_format` options in the request. Currently there are two supported options: `TEXT` and `JSON`. Both supply a `google.protobuf.StringValue`. + */ + data?: {[key: string]: any} | null; + } /** * A filter on a specific field. */ @@ -634,6 +685,23 @@ export namespace firestore_v1 { */ vectorField?: Schema$FieldReference; } + /** + * Represents an unevaluated scalar expression. For example, the expression `like(user_name, "%alice%")` is represented as: ``` name: "like" args { field_reference: "user_name" \} args { string_value: "%alice%" \} ``` + */ + export interface Schema$Function { + /** + * Optional. Ordered list of arguments the given function expects. + */ + args?: Schema$Value[]; + /** + * Required. The name of the function to evaluate. **Requires:** * must be in snake case (lower case with underscore separator). + */ + name?: string | null; + /** + * Optional. Optional named arguments that certain functions may support. + */ + options?: {[key: string]: Schema$Value} | null; + } /** * A Backup of a Cloud Firestore Database. The backup contains all documents and index configurations for the given database at a specific point in time. */ @@ -848,7 +916,7 @@ export namespace firestore_v1 { */ cmekConfig?: Schema$GoogleFirestoreAdminV1CmekConfig; /** - * The concurrency control mode to use for this database. + * The concurrency control mode to use for this database. If unspecified in a CreateDatabase request, this will default based on the database edition: Optimistic for Enterprise and Pessimistic for all other databases. */ concurrencyMode?: string | null; /** @@ -1793,6 +1861,15 @@ export namespace firestore_v1 { */ partitions?: Schema$Cursor[]; } + /** + * A Firestore query represented as an ordered list of operations / stages. + */ + export interface Schema$Pipeline { + /** + * Required. Ordered list of stages to evaluate. + */ + stages?: Schema$Stage[]; + } /** * Planning phase information for the query. */ @@ -1964,6 +2041,23 @@ export namespace firestore_v1 { */ transaction?: string | null; } + /** + * A single operation within a pipeline. A stage is made up of a unique name, and a list of arguments. The exact number of arguments & types is dependent on the stage type. To give an example, the stage `filter(state = "MD")` would be encoded as: ``` name: "filter" args { function_value { name: "eq" args { field_reference_value: "state" \} args { string_value: "MD" \} \} \} ``` See public documentation for the full list. + */ + export interface Schema$Stage { + /** + * Optional. Ordered list of arguments the given stage expects. + */ + args?: Schema$Value[]; + /** + * Required. The name of the stage to evaluate. **Requires:** * must be in snake case (lower case with underscore separator). + */ + name?: string | null; + /** + * Optional. Optional named arguments that certain functions may support. + */ + options?: {[key: string]: Schema$Value} | null; + } /** * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ @@ -1994,6 +2088,19 @@ export namespace firestore_v1 { */ structuredQuery?: Schema$StructuredQuery; } + /** + * A Firestore query represented as an ordered list of operations / stages. This is considered the top-level function which plans and executes a query. It is logically equivalent to `query(stages, options)`, but prevents the client from having to build a function wrapper. + */ + export interface Schema$StructuredPipeline { + /** + * Optional. Optional query-level arguments. + */ + options?: {[key: string]: Schema$Value} | null; + /** + * Required. The pipeline query to execute. + */ + pipeline?: Schema$Pipeline; + } /** * A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7. find_nearest */ @@ -2148,6 +2255,14 @@ export namespace firestore_v1 { * A double value. */ doubleValue?: number | null; + /** + * Value which references a field. This is considered relative (vs absolute) since it only refers to a field and not a field within a particular document. **Requires:** * Must follow field reference limitations. * Not allowed to be used when writing documents. + */ + fieldReferenceValue?: string | null; + /** + * A value that represents an unevaluated expression. **Requires:** * Not allowed to be used when writing documents. + */ + functionValue?: Schema$Function; /** * A geo point value representing a point on the surface of Earth. */ @@ -2164,6 +2279,10 @@ export namespace firestore_v1 { * A null value. */ nullValue?: string | null; + /** + * A value that represents an unevaluated pipeline. **Requires:** * Not allowed to be used when writing documents. + */ + pipelineValue?: Schema$Pipeline; /** * A reference to a document. For example: `projects/{project_id\}/databases/{database_id\}/documents/{document_path\}`. */ @@ -6953,6 +7072,164 @@ export namespace firestore_v1 { } } + /** + * Executes a pipeline query. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/firestore.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const firestore = google.firestore('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/datastore', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await firestore.projects.databases.documents.executePipeline({ + * // Required. Database identifier, in the form `projects/{project\}/databases/{database\}`. + * database: 'projects/my-project/databases/my-database', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "newTransaction": {}, + * // "readTime": "my_readTime", + * // "structuredPipeline": {}, + * // "transaction": "my_transaction" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "executionTime": "my_executionTime", + * // "explainStats": {}, + * // "results": [], + * // "transaction": "my_transaction" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + executePipeline( + params: Params$Resource$Projects$Databases$Documents$Executepipeline, + options: StreamMethodOptions + ): Promise>; + executePipeline( + params?: Params$Resource$Projects$Databases$Documents$Executepipeline, + options?: MethodOptions + ): Promise>; + executePipeline( + params: Params$Resource$Projects$Databases$Documents$Executepipeline, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + executePipeline( + params: Params$Resource$Projects$Databases$Documents$Executepipeline, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + executePipeline( + params: Params$Resource$Projects$Databases$Documents$Executepipeline, + callback: BodyResponseCallback + ): void; + executePipeline( + callback: BodyResponseCallback + ): void; + executePipeline( + paramsOrCallback?: + | Params$Resource$Projects$Databases$Documents$Executepipeline + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Databases$Documents$Executepipeline; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Databases$Documents$Executepipeline; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firestore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+database}/documents:executePipeline' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['database'], + pathParams: ['database'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Gets a single document. * @example @@ -8751,6 +9028,17 @@ export namespace firestore_v1 { */ name?: string; } + export interface Params$Resource$Projects$Databases$Documents$Executepipeline extends StandardParameters { + /** + * Required. Database identifier, in the form `projects/{project\}/databases/{database\}`. + */ + database?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ExecutePipelineRequest; + } export interface Params$Resource$Projects$Databases$Documents$Get extends StandardParameters { /** * The list of field paths in the mask. See Document.fields for a field path syntax reference. diff --git a/src/apis/firestore/v1beta1.ts b/src/apis/firestore/v1beta1.ts index ae581fbacc8..0dfb9ea62a6 100644 --- a/src/apis/firestore/v1beta1.ts +++ b/src/apis/firestore/v1beta1.ts @@ -469,6 +469,48 @@ export namespace firestore_v1beta1 { * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} */ export interface Schema$Empty {} + /** + * The request for Firestore.ExecutePipeline. + */ + export interface Schema$ExecutePipelineRequest { + /** + * Execute the pipeline in a new transaction. The identifier of the newly created transaction will be returned in the first response on the stream. This defaults to a read-only transaction. + */ + newTransaction?: Schema$TransactionOptions; + /** + * Execute the pipeline in a snapshot transaction at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. + */ + readTime?: string | null; + /** + * A pipelined operation. + */ + structuredPipeline?: Schema$StructuredPipeline; + /** + * Run the query within an already active transaction. The value here is the opaque transaction ID to execute the query in. + */ + transaction?: string | null; + } + /** + * The response for Firestore.Execute. + */ + export interface Schema$ExecutePipelineResponse { + /** + * The time at which the results are valid. This is a (not strictly) monotonically increasing value across multiple responses in the same stream. The API guarantees that all previously returned results are still valid at the latest `execution_time`. This allows the API consumer to treat the query if it ran at the latest `execution_time` returned. If the query returns no results, a response with `execution_time` and no `results` will be sent, and this represents the time at which the operation was run. + */ + executionTime?: string | null; + /** + * Query explain stats. This is present on the **last** response if the request configured explain to run in 'analyze' or 'explain' mode in the pipeline options. If the query does not return any results, a response with `explain_stats` and no `results` will still be sent. + */ + explainStats?: Schema$ExplainStats; + /** + * An ordered batch of results returned executing a pipeline. The batch size is variable, and can even be zero for when only a partial progress message is returned. The fields present in the returned documents are only those that were explicitly requested in the pipeline, this includes those like `__name__` and `__update_time__`. This is explicitly a divergence from `Firestore.RunQuery` / `Firestore.GetDocument` RPCs which always return such fields even when they are not specified in the `mask`. + */ + results?: Schema$Document[]; + /** + * Newly created transaction identifier. This field is only specified as part of the first response from the server, alongside the `results` field when the original request specified ExecuteRequest.new_transaction. + */ + transaction?: string | null; + } /** * Execution statistics for the query. */ @@ -529,6 +571,15 @@ export namespace firestore_v1beta1 { */ analyze?: boolean | null; } + /** + * Pipeline explain stats. Depending on the explain options in the original request, this can contain the optimized plan and / or execution stats. + */ + export interface Schema$ExplainStats { + /** + * The format depends on the `output_format` options in the request. Currently there are two supported options: `TEXT` and `JSON`. Both supply a `google.protobuf.StringValue`. + */ + data?: {[key: string]: any} | null; + } /** * A filter on a specific field. */ @@ -634,6 +685,23 @@ export namespace firestore_v1beta1 { */ vectorField?: Schema$FieldReference; } + /** + * Represents an unevaluated scalar expression. For example, the expression `like(user_name, "%alice%")` is represented as: ``` name: "like" args { field_reference: "user_name" \} args { string_value: "%alice%" \} ``` + */ + export interface Schema$Function { + /** + * Optional. Ordered list of arguments the given function expects. + */ + args?: Schema$Value[]; + /** + * Required. The name of the function to evaluate. **Requires:** * must be in snake case (lower case with underscore separator). + */ + name?: string | null; + /** + * Optional. Optional named arguments that certain functions may support. + */ + options?: {[key: string]: Schema$Value} | null; + } /** * Metadata for ExportDocuments operations. */ @@ -1148,6 +1216,15 @@ export namespace firestore_v1beta1 { */ partitions?: Schema$Cursor[]; } + /** + * A Firestore query represented as an ordered list of operations / stages. + */ + export interface Schema$Pipeline { + /** + * Required. Ordered list of stages to evaluate. + */ + stages?: Schema$Stage[]; + } /** * Planning phase information for the query. */ @@ -1319,6 +1396,23 @@ export namespace firestore_v1beta1 { */ transaction?: string | null; } + /** + * A single operation within a pipeline. A stage is made up of a unique name, and a list of arguments. The exact number of arguments & types is dependent on the stage type. To give an example, the stage `filter(state = "MD")` would be encoded as: ``` name: "filter" args { function_value { name: "eq" args { field_reference_value: "state" \} args { string_value: "MD" \} \} \} ``` See public documentation for the full list. + */ + export interface Schema$Stage { + /** + * Optional. Ordered list of arguments the given stage expects. + */ + args?: Schema$Value[]; + /** + * Required. The name of the stage to evaluate. **Requires:** * must be in snake case (lower case with underscore separator). + */ + name?: string | null; + /** + * Optional. Optional named arguments that certain functions may support. + */ + options?: {[key: string]: Schema$Value} | null; + } /** * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ @@ -1349,6 +1443,19 @@ export namespace firestore_v1beta1 { */ structuredQuery?: Schema$StructuredQuery; } + /** + * A Firestore query represented as an ordered list of operations / stages. This is considered the top-level function which plans and executes a query. It is logically equivalent to `query(stages, options)`, but prevents the client from having to build a function wrapper. + */ + export interface Schema$StructuredPipeline { + /** + * Optional. Optional query-level arguments. + */ + options?: {[key: string]: Schema$Value} | null; + /** + * Required. The pipeline query to execute. + */ + pipeline?: Schema$Pipeline; + } /** * A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7. find_nearest */ @@ -1503,6 +1610,14 @@ export namespace firestore_v1beta1 { * A double value. */ doubleValue?: number | null; + /** + * Value which references a field. This is considered relative (vs absolute) since it only refers to a field and not a field within a particular document. **Requires:** * Must follow field reference limitations. * Not allowed to be used when writing documents. + */ + fieldReferenceValue?: string | null; + /** + * A value that represents an unevaluated expression. **Requires:** * Not allowed to be used when writing documents. + */ + functionValue?: Schema$Function; /** * A geo point value representing a point on the surface of Earth. */ @@ -1519,6 +1634,10 @@ export namespace firestore_v1beta1 { * A null value. */ nullValue?: string | null; + /** + * A value that represents an unevaluated pipeline. **Requires:** * Not allowed to be used when writing documents. + */ + pipelineValue?: Schema$Pipeline; /** * A reference to a document. For example: `projects/{project_id\}/databases/{database_id\}/documents/{document_path\}`. */ @@ -2890,6 +3009,164 @@ export namespace firestore_v1beta1 { } } + /** + * Executes a pipeline query. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/firestore.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const firestore = google.firestore('v1beta1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/datastore', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await firestore.projects.databases.documents.executePipeline({ + * // Required. Database identifier, in the form `projects/{project\}/databases/{database\}`. + * database: 'projects/my-project/databases/my-database', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "newTransaction": {}, + * // "readTime": "my_readTime", + * // "structuredPipeline": {}, + * // "transaction": "my_transaction" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "executionTime": "my_executionTime", + * // "explainStats": {}, + * // "results": [], + * // "transaction": "my_transaction" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + executePipeline( + params: Params$Resource$Projects$Databases$Documents$Executepipeline, + options: StreamMethodOptions + ): Promise>; + executePipeline( + params?: Params$Resource$Projects$Databases$Documents$Executepipeline, + options?: MethodOptions + ): Promise>; + executePipeline( + params: Params$Resource$Projects$Databases$Documents$Executepipeline, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + executePipeline( + params: Params$Resource$Projects$Databases$Documents$Executepipeline, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + executePipeline( + params: Params$Resource$Projects$Databases$Documents$Executepipeline, + callback: BodyResponseCallback + ): void; + executePipeline( + callback: BodyResponseCallback + ): void; + executePipeline( + paramsOrCallback?: + | Params$Resource$Projects$Databases$Documents$Executepipeline + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Databases$Documents$Executepipeline; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Databases$Documents$Executepipeline; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firestore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1beta1/{+database}/documents:executePipeline' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['database'], + pathParams: ['database'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Gets a single document. * @example @@ -4688,6 +4965,17 @@ export namespace firestore_v1beta1 { */ name?: string; } + export interface Params$Resource$Projects$Databases$Documents$Executepipeline extends StandardParameters { + /** + * Required. Database identifier, in the form `projects/{project\}/databases/{database\}`. + */ + database?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ExecutePipelineRequest; + } export interface Params$Resource$Projects$Databases$Documents$Get extends StandardParameters { /** * The list of field paths in the mask. See Document.fields for a field path syntax reference. diff --git a/src/apis/networkconnectivity/v1.ts b/src/apis/networkconnectivity/v1.ts index 61a59c341ef..9a9389e25f8 100644 --- a/src/apis/networkconnectivity/v1.ts +++ b/src/apis/networkconnectivity/v1.ts @@ -329,7 +329,7 @@ export namespace networkconnectivity_v1 { */ project?: string | null; /** - * Output only. A map to store mapping between customer vip and target service attachment. Only service attachment with producer specified ip addresses are stored here. + * Optional. A map to store mapping between customer vip and target service attachment. This field can be used to specify a static IP address for a PSC connection. */ serviceAttachmentIpAddressMap?: {[key: string]: string} | null; /** diff --git a/src/apis/pubsub/v1.ts b/src/apis/pubsub/v1.ts index 7749a49e578..9511d52a4e3 100644 --- a/src/apis/pubsub/v1.ts +++ b/src/apis/pubsub/v1.ts @@ -429,7 +429,7 @@ export namespace pubsub_v1 { */ labels?: {[key: string]: string} | null; /** - * Required. The subscription whose backlog the snapshot retains. Specifically, the created snapshot is guaranteed to retain: (a) The existing backlog on the subscription. More precisely, this is defined as the messages in the subscription's backlog that are unacknowledged upon the successful completion of the `CreateSnapshot` request; as well as: (b) Any messages published to the subscription's topic following the successful completion of the CreateSnapshot request. Format is `projects/{project\}/subscriptions/{sub\}`. + * Required. Identifier. The subscription whose backlog the snapshot retains. Specifically, the created snapshot is guaranteed to retain: (a) The existing backlog on the subscription. More precisely, this is defined as the messages in the subscription's backlog that are unacknowledged upon the successful completion of the `CreateSnapshot` request; as well as: (b) Any messages published to the subscription's topic following the successful completion of the CreateSnapshot request. Format is `projects/{project\}/subscriptions/{sub\}`. */ subscription?: string | null; /** @@ -1008,7 +1008,7 @@ export namespace pubsub_v1 { */ messageTransforms?: Schema$MessageTransform[]; /** - * Required. The name of the subscription. It must have the format `"projects/{project\}/subscriptions/{subscription\}"`. `{subscription\}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. + * Required. Identifier. The name of the subscription. It must have the format `"projects/{project\}/subscriptions/{subscription\}"`. `{subscription\}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. */ name?: string | null; /** @@ -1032,7 +1032,7 @@ export namespace pubsub_v1 { */ tags?: {[key: string]: string} | null; /** - * Required. The name of the topic from which this subscription is receiving messages. Format is `projects/{project\}/topics/{topic\}`. The value of this field will be `_deleted-topic_` if the topic has been deleted. + * Required. Identifier. The name of the topic from which this subscription is receiving messages. Format is `projects/{project\}/topics/{topic\}`. The value of this field will be `_deleted-topic_` if the topic has been deleted. */ topic?: string | null; /** @@ -1100,7 +1100,7 @@ export namespace pubsub_v1 { */ messageTransforms?: Schema$MessageTransform[]; /** - * Required. The name of the topic. It must have the format `"projects/{project\}/topics/{topic\}"`. `{topic\}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. + * Required. Identifier. The name of the topic. It must have the format `"projects/{project\}/topics/{topic\}"`. `{topic\}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. */ name?: string | null; /** @@ -3344,7 +3344,7 @@ export namespace pubsub_v1 { * * // Do the magic * const res = await pubsub.projects.snapshots.create({ - * // Required. User-provided name for this snapshot. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription. Note that for REST API requests, you must specify a name. See the [resource name rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). Format is `projects/{project\}/snapshots/{snap\}`. + * // Required. Identifier. User-provided name for this snapshot. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription. Note that for REST API requests, you must specify a name. See the [resource name rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). Format is `projects/{project\}/snapshots/{snap\}`. * name: 'projects/my-project/snapshots/my-snapshot', * * // Request body metadata @@ -3494,7 +3494,7 @@ export namespace pubsub_v1 { * * // Do the magic * const res = await pubsub.projects.snapshots.delete({ - * // Required. The name of the snapshot to delete. Format is `projects/{project\}/snapshots/{snap\}`. + * // Required. Identifier. The name of the snapshot to delete. Format is `projects/{project\}/snapshots/{snap\}`. * snapshot: 'projects/my-project/snapshots/my-snapshot', * }); * console.log(res.data); @@ -3629,7 +3629,7 @@ export namespace pubsub_v1 { * * // Do the magic * const res = await pubsub.projects.snapshots.get({ - * // Required. The name of the snapshot to get. Format is `projects/{project\}/snapshots/{snap\}`. + * // Required. Identifier. The name of the snapshot to get. Format is `projects/{project\}/snapshots/{snap\}`. * snapshot: 'projects/my-project/snapshots/my-snapshot', * }); * console.log(res.data); @@ -3917,7 +3917,7 @@ export namespace pubsub_v1 { * pageSize: 'placeholder-value', * // Optional. The value returned by the last `ListSnapshotsResponse`; indicates that this is a continuation of a prior `ListSnapshots` call, and that the system should return the next page of data. * pageToken: 'placeholder-value', - * // Required. The name of the project in which to list snapshots. Format is `projects/{project-id\}`. + * // Required. Identifier. The name of the project in which to list snapshots. Format is `projects/{project-id\}`. * project: 'projects/my-project', * }); * console.log(res.data); @@ -4480,7 +4480,7 @@ export namespace pubsub_v1 { export interface Params$Resource$Projects$Snapshots$Create extends StandardParameters { /** - * Required. User-provided name for this snapshot. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription. Note that for REST API requests, you must specify a name. See the [resource name rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). Format is `projects/{project\}/snapshots/{snap\}`. + * Required. Identifier. User-provided name for this snapshot. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription. Note that for REST API requests, you must specify a name. See the [resource name rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). Format is `projects/{project\}/snapshots/{snap\}`. */ name?: string; @@ -4491,13 +4491,13 @@ export namespace pubsub_v1 { } export interface Params$Resource$Projects$Snapshots$Delete extends StandardParameters { /** - * Required. The name of the snapshot to delete. Format is `projects/{project\}/snapshots/{snap\}`. + * Required. Identifier. The name of the snapshot to delete. Format is `projects/{project\}/snapshots/{snap\}`. */ snapshot?: string; } export interface Params$Resource$Projects$Snapshots$Get extends StandardParameters { /** - * Required. The name of the snapshot to get. Format is `projects/{project\}/snapshots/{snap\}`. + * Required. Identifier. The name of the snapshot to get. Format is `projects/{project\}/snapshots/{snap\}`. */ snapshot?: string; } @@ -4521,7 +4521,7 @@ export namespace pubsub_v1 { */ pageToken?: string; /** - * Required. The name of the project in which to list snapshots. Format is `projects/{project-id\}`. + * Required. Identifier. The name of the project in which to list snapshots. Format is `projects/{project-id\}`. */ project?: string; } @@ -4745,7 +4745,7 @@ export namespace pubsub_v1 { * * // Do the magic * const res = await pubsub.projects.subscriptions.create({ - * // Required. The name of the subscription. It must have the format `"projects/{project\}/subscriptions/{subscription\}"`. `{subscription\}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. + * // Required. Identifier. The name of the subscription. It must have the format `"projects/{project\}/subscriptions/{subscription\}"`. `{subscription\}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. * name: 'projects/my-project/subscriptions/my-subscription', * * // Request body metadata @@ -4930,7 +4930,7 @@ export namespace pubsub_v1 { * * // Do the magic * const res = await pubsub.projects.subscriptions.delete({ - * // Required. The subscription to delete. Format is `projects/{project\}/subscriptions/{sub\}`. + * // Required. Identifier. The subscription to delete. Format is `projects/{project\}/subscriptions/{sub\}`. * subscription: 'projects/my-project/subscriptions/my-subscription', * }); * console.log(res.data); @@ -5210,7 +5210,7 @@ export namespace pubsub_v1 { * * // Do the magic * const res = await pubsub.projects.subscriptions.get({ - * // Required. The name of the subscription to get. Format is `projects/{project\}/subscriptions/{sub\}`. + * // Required. Identifier. The name of the subscription to get. Format is `projects/{project\}/subscriptions/{sub\}`. * subscription: 'projects/my-project/subscriptions/my-subscription', * }); * console.log(res.data); @@ -5518,7 +5518,7 @@ export namespace pubsub_v1 { * pageSize: 'placeholder-value', * // Optional. The value returned by the last `ListSubscriptionsResponse`; indicates that this is a continuation of a prior `ListSubscriptions` call, and that the system should return the next page of data. * pageToken: 'placeholder-value', - * // Required. The name of the project in which to list subscriptions. Format is `projects/{project-id\}`. + * // Required. Identifier. The name of the project in which to list subscriptions. Format is `projects/{project-id\}`. * project: 'projects/my-project', * }); * console.log(res.data); @@ -5956,7 +5956,7 @@ export namespace pubsub_v1 { * * // Do the magic * const res = await pubsub.projects.subscriptions.patch({ - * // Required. The name of the subscription. It must have the format `"projects/{project\}/subscriptions/{subscription\}"`. `{subscription\}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. + * // Required. Identifier. The name of the subscription. It must have the format `"projects/{project\}/subscriptions/{subscription\}"`. `{subscription\}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. * name: 'projects/my-project/subscriptions/my-subscription', * * // Request body metadata @@ -6701,7 +6701,7 @@ export namespace pubsub_v1 { } export interface Params$Resource$Projects$Subscriptions$Create extends StandardParameters { /** - * Required. The name of the subscription. It must have the format `"projects/{project\}/subscriptions/{subscription\}"`. `{subscription\}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. + * Required. Identifier. The name of the subscription. It must have the format `"projects/{project\}/subscriptions/{subscription\}"`. `{subscription\}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. */ name?: string; @@ -6712,7 +6712,7 @@ export namespace pubsub_v1 { } export interface Params$Resource$Projects$Subscriptions$Delete extends StandardParameters { /** - * Required. The subscription to delete. Format is `projects/{project\}/subscriptions/{sub\}`. + * Required. Identifier. The subscription to delete. Format is `projects/{project\}/subscriptions/{sub\}`. */ subscription?: string; } @@ -6724,7 +6724,7 @@ export namespace pubsub_v1 { } export interface Params$Resource$Projects$Subscriptions$Get extends StandardParameters { /** - * Required. The name of the subscription to get. Format is `projects/{project\}/subscriptions/{sub\}`. + * Required. Identifier. The name of the subscription to get. Format is `projects/{project\}/subscriptions/{sub\}`. */ subscription?: string; } @@ -6748,7 +6748,7 @@ export namespace pubsub_v1 { */ pageToken?: string; /** - * Required. The name of the project in which to list subscriptions. Format is `projects/{project-id\}`. + * Required. Identifier. The name of the project in which to list subscriptions. Format is `projects/{project-id\}`. */ project?: string; } @@ -6776,7 +6776,7 @@ export namespace pubsub_v1 { } export interface Params$Resource$Projects$Subscriptions$Patch extends StandardParameters { /** - * Required. The name of the subscription. It must have the format `"projects/{project\}/subscriptions/{subscription\}"`. `{subscription\}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. + * Required. Identifier. The name of the subscription. It must have the format `"projects/{project\}/subscriptions/{subscription\}"`. `{subscription\}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. */ name?: string; @@ -6876,7 +6876,7 @@ export namespace pubsub_v1 { * * // Do the magic * const res = await pubsub.projects.topics.create({ - * // Required. The name of the topic. It must have the format `"projects/{project\}/topics/{topic\}"`. `{topic\}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. + * // Required. Identifier. The name of the topic. It must have the format `"projects/{project\}/topics/{topic\}"`. `{topic\}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. * name: 'projects/my-project/topics/my-topic', * * // Request body metadata @@ -7041,7 +7041,7 @@ export namespace pubsub_v1 { * * // Do the magic * const res = await pubsub.projects.topics.delete({ - * // Required. Name of the topic to delete. Format is `projects/{project\}/topics/{topic\}`. + * // Required. Identifier. Name of the topic to delete. Format is `projects/{project\}/topics/{topic\}`. * topic: 'projects/my-project/topics/my-topic', * }); * console.log(res.data); @@ -7176,7 +7176,7 @@ export namespace pubsub_v1 { * * // Do the magic * const res = await pubsub.projects.topics.get({ - * // Required. The name of the topic to get. Format is `projects/{project\}/topics/{topic\}`. + * // Required. Identifier. The name of the topic to get. Format is `projects/{project\}/topics/{topic\}`. * topic: 'projects/my-project/topics/my-topic', * }); * console.log(res.data); @@ -7471,7 +7471,7 @@ export namespace pubsub_v1 { * pageSize: 'placeholder-value', * // Optional. The value returned by the last `ListTopicsResponse`; indicates that this is a continuation of a prior `ListTopics` call, and that the system should return the next page of data. * pageToken: 'placeholder-value', - * // Required. The name of the project in which to list topics. Format is `projects/{project-id\}`. + * // Required. Identifier. The name of the project in which to list topics. Format is `projects/{project-id\}`. * project: 'projects/my-project', * }); * console.log(res.data); @@ -7612,7 +7612,7 @@ export namespace pubsub_v1 { * * // Do the magic * const res = await pubsub.projects.topics.patch({ - * // Required. The name of the topic. It must have the format `"projects/{project\}/topics/{topic\}"`. `{topic\}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. + * // Required. Identifier. The name of the topic. It must have the format `"projects/{project\}/topics/{topic\}"`. `{topic\}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. * name: 'projects/my-project/topics/my-topic', * * // Request body metadata @@ -7768,7 +7768,7 @@ export namespace pubsub_v1 { * * // Do the magic * const res = await pubsub.projects.topics.publish({ - * // Required. The messages in the request will be published on this topic. Format is `projects/{project\}/topics/{topic\}`. + * // Required. Identifier. The messages in the request will be published on this topic. Format is `projects/{project\}/topics/{topic\}`. * topic: 'projects/my-project/topics/my-topic', * * // Request body metadata @@ -8187,7 +8187,7 @@ export namespace pubsub_v1 { export interface Params$Resource$Projects$Topics$Create extends StandardParameters { /** - * Required. The name of the topic. It must have the format `"projects/{project\}/topics/{topic\}"`. `{topic\}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. + * Required. Identifier. The name of the topic. It must have the format `"projects/{project\}/topics/{topic\}"`. `{topic\}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. */ name?: string; @@ -8198,13 +8198,13 @@ export namespace pubsub_v1 { } export interface Params$Resource$Projects$Topics$Delete extends StandardParameters { /** - * Required. Name of the topic to delete. Format is `projects/{project\}/topics/{topic\}`. + * Required. Identifier. Name of the topic to delete. Format is `projects/{project\}/topics/{topic\}`. */ topic?: string; } export interface Params$Resource$Projects$Topics$Get extends StandardParameters { /** - * Required. The name of the topic to get. Format is `projects/{project\}/topics/{topic\}`. + * Required. Identifier. The name of the topic to get. Format is `projects/{project\}/topics/{topic\}`. */ topic?: string; } @@ -8228,13 +8228,13 @@ export namespace pubsub_v1 { */ pageToken?: string; /** - * Required. The name of the project in which to list topics. Format is `projects/{project-id\}`. + * Required. Identifier. The name of the project in which to list topics. Format is `projects/{project-id\}`. */ project?: string; } export interface Params$Resource$Projects$Topics$Patch extends StandardParameters { /** - * Required. The name of the topic. It must have the format `"projects/{project\}/topics/{topic\}"`. `{topic\}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. + * Required. Identifier. The name of the topic. It must have the format `"projects/{project\}/topics/{topic\}"`. `{topic\}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. */ name?: string; @@ -8245,7 +8245,7 @@ export namespace pubsub_v1 { } export interface Params$Resource$Projects$Topics$Publish extends StandardParameters { /** - * Required. The messages in the request will be published on this topic. Format is `projects/{project\}/topics/{topic\}`. + * Required. Identifier. The messages in the request will be published on this topic. Format is `projects/{project\}/topics/{topic\}`. */ topic?: string; diff --git a/src/apis/safebrowsing/v5.ts b/src/apis/safebrowsing/v5.ts index 7799cd8b4b0..577a290b945 100644 --- a/src/apis/safebrowsing/v5.ts +++ b/src/apis/safebrowsing/v5.ts @@ -115,6 +115,7 @@ export namespace safebrowsing_v5 { hashes: Resource$Hashes; hashList: Resource$Hashlist; hashLists: Resource$Hashlists; + urls: Resource$Urls; constructor(options: GlobalOptions, google?: GoogleConfigurable) { this.context = { @@ -125,6 +126,7 @@ export namespace safebrowsing_v5 { this.hashes = new Resource$Hashes(this.context); this.hashList = new Resource$Hashlist(this.context); this.hashLists = new Resource$Hashlists(this.context); + this.urls = new Resource$Urls(this.context); } } @@ -359,6 +361,32 @@ export namespace safebrowsing_v5 { */ fullHashes?: Schema$GoogleSecuritySafebrowsingV5FullHash[]; } + /** + * The response returned after searching threats matching the specified URLs. If nothing is found, the server will return an OK status (HTTP status code 200) with the `threats` field empty, rather than returning a NOT_FOUND status (HTTP status code 404). + */ + export interface Schema$GoogleSecuritySafebrowsingV5SearchUrlsResponse { + /** + * The client-side cache duration. The client MUST add this duration to the current time to determine the expiration time. The expiration time then applies to every URL queried by the client in the request, regardless of how many URLs are returned in the response. Even if the server returns no matches for a particular URL, this fact MUST also be cached by the client. If and only if the field `threats` is empty, the client MAY increase the `cache_duration` to determine a new expiration that is later than that specified by the server. In any case, the increased cache duration must not be longer than 24 hours. Important: the client MUST NOT assume that the server will return the same cache duration for all responses. The server MAY choose different cache durations for different responses depending on the situation. + */ + cacheDuration?: string | null; + /** + * Unordered list. The unordered list of threat matches found. Each entry contains a URL and the threat types that were found matching that URL. The list size can be greater than the number of URLs in the request as the all expressions of the URL would've been considered. + */ + threats?: Schema$GoogleSecuritySafebrowsingV5ThreatUrl[]; + } + /** + * A URL matching one or more threats. + */ + export interface Schema$GoogleSecuritySafebrowsingV5ThreatUrl { + /** + * Unordered list. The unordered list of threat that the URL is classified as. + */ + threatTypes?: string[] | null; + /** + * The requested URL that was matched by one or more threats. + */ + url?: string | null; + } export class Resource$Hashes { context: APIRequestContext; @@ -367,7 +395,7 @@ export namespace safebrowsing_v5 { } /** - * Search for full hashes matching the specified prefixes. This is a custom method as defined by https://google.aip.dev/136 (the custom method refers to this method having a custom name within Google's general API development nomenclature; it does not refer to using a custom HTTP method). + * Searches for full hashes matching the specified prefixes. This is a custom method as defined by https://google.aip.dev/136 (the custom method refers to this method having a custom name within Google's general API development nomenclature; it does not refer to using a custom HTTP method). * @example * ```js * // Before running the sample: @@ -525,7 +553,7 @@ export namespace safebrowsing_v5 { } /** - * Get the latest contents of a hash list. A hash list may either by a threat list or a non-threat list such as the Global Cache. This is a standard Get method as defined by https://google.aip.dev/131 and the HTTP method is also GET. + * Gets the latest contents of a hash list. A hash list may either by a threat list or a non-threat list such as the Global Cache. This is a standard Get method as defined by https://google.aip.dev/131 and the HTTP method is also GET. * @example * ```js * // Before running the sample: @@ -713,7 +741,7 @@ export namespace safebrowsing_v5 { } /** - * Get multiple hash lists at once. It is very common for a client to need to get multiple hash lists. Using this method is preferred over using the regular Get method multiple times. This is a standard batch Get method as defined by https://google.aip.dev/231 and the HTTP method is also GET. + * Gets multiple hash lists at once. It is very common for a client to need to get multiple hash lists. Using this method is preferred over using the regular Get method multiple times. This is a standard batch Get method as defined by https://google.aip.dev/231 and the HTTP method is also GET. * @example * ```js * // Before running the sample: @@ -866,7 +894,7 @@ export namespace safebrowsing_v5 { } /** - * List hash lists. In the V5 API, Google will never remove a hash list that has ever been returned by this method. This enables clients to skip using this method and simply hard-code all hash lists they need. This is a standard List method as defined by https://google.aip.dev/132 and the HTTP method is GET. + * Lists hash lists. In the V5 API, Google will never remove a hash list that has ever been returned by this method. This enables clients to skip using this method and simply hard-code all hash lists they need. This is a standard List method as defined by https://google.aip.dev/132 and the HTTP method is GET. * @example * ```js * // Before running the sample: @@ -1040,4 +1068,162 @@ export namespace safebrowsing_v5 { */ pageToken?: string; } + + export class Resource$Urls { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Searches for URLs matching known threats. Each URL and it's host-suffix and path-prefix expressions (up to a limited depth) are checked. This means that the response may contain URLs that were not included in the request, but are expressions of the requested URLs. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/safebrowsing.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const safebrowsing = google.safebrowsing('v5'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await safebrowsing.urls.search({ + * // Required. The URLs to be looked up. Clients MUST NOT send more than 50 URLs. + * urls: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "cacheDuration": "my_cacheDuration", + * // "threats": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + search( + params: Params$Resource$Urls$Search, + options: StreamMethodOptions + ): Promise>; + search( + params?: Params$Resource$Urls$Search, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + search( + params: Params$Resource$Urls$Search, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + search( + params: Params$Resource$Urls$Search, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + search( + params: Params$Resource$Urls$Search, + callback: BodyResponseCallback + ): void; + search( + callback: BodyResponseCallback + ): void; + search( + paramsOrCallback?: + | Params$Resource$Urls$Search + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Urls$Search; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Urls$Search; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://safebrowsing.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v5/urls:search').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Urls$Search extends StandardParameters { + /** + * Required. The URLs to be looked up. Clients MUST NOT send more than 50 URLs. + */ + urls?: string[]; + } } diff --git a/src/apis/spanner/v1.ts b/src/apis/spanner/v1.ts index 58d8203153f..2d5f9f5df29 100644 --- a/src/apis/spanner/v1.ts +++ b/src/apis/spanner/v1.ts @@ -126,6 +126,23 @@ export namespace spanner_v1 { } } + /** + * Arguments to ack operations. + */ + export interface Schema$Ack { + /** + * By default, an attempt to ack a message that does not exist will fail with a `NOT_FOUND` error. With `ignore_not_found` set to true, the ack will succeed even if the message does not exist. This is useful for unconditionally acking a message, even if it is missing or has already been acked. + */ + ignoreNotFound?: boolean | null; + /** + * Required. The primary key of the message to be acked. + */ + key?: any[] | null; + /** + * Required. The queue where the message to be acked is stored. + */ + queue?: string | null; + } /** * A session in the Cloud Spanner Adapter API. */ @@ -582,10 +599,6 @@ export namespace spanner_v1 { */ variable?: string | null; } - /** - * Container for various pieces of client-owned context attached to a request. - */ - export interface Schema$ClientContext {} /** * Metadata for a column. */ @@ -670,6 +683,23 @@ export namespace spanner_v1 { */ mutationCount?: string | null; } + /** + * Metadata type for the long-running operation returned by `CALL compact_all()`, which can be executed using ExecuteSql or ExecuteStreamingSql APIs. + */ + export interface Schema$CompactDatabaseMetadata { + /** + * Output only. The time at which cancellation of this operation was received. Operations.CancelOperation starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + */ + cancelTime?: string | null; + /** + * Output only. The database being compacted. + */ + database?: string | null; + /** + * Output only. The progress of the compaction operation. + */ + progress?: Schema$OperationProgress; + } /** * A message representing context for a KeyRangeInfo, including a label, value, unit, and severity. */ @@ -1951,7 +1981,7 @@ export namespace spanner_v1 { */ operations?: Schema$Operation[]; /** - * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. */ unreachable?: string[] | null; } @@ -2147,6 +2177,10 @@ export namespace spanner_v1 { * A modification to one or more Cloud Spanner rows. Mutations can be applied to a Cloud Spanner database by sending them in a Commit call. */ export interface Schema$Mutation { + /** + * Ack a message from a queue. + */ + ack?: Schema$Ack; /** * Delete rows from a table. Succeeds whether or not the named rows were present. */ @@ -2163,6 +2197,10 @@ export namespace spanner_v1 { * Like insert, except that if the row already exists, it is deleted, and the column values provided are inserted instead. Unlike insert_or_update, this means any values not explicitly written become `NULL`. In an interleaved table, if you create the child table with the `ON DELETE CASCADE` annotation, then replacing a parent row also deletes the child rows. Otherwise, you must delete the child rows before you replace the parent row. */ replace?: Schema$Write; + /** + * Send a message to a queue. + */ + send?: Schema$Send; /** * Update existing rows in a table. If any of the rows does not already exist, the transaction fails with error `NOT_FOUND`. */ @@ -2708,10 +2746,6 @@ export namespace spanner_v1 { * Common request options for various APIs. */ export interface Schema$RequestOptions { - /** - * Optional. Optional context that may be needed for some requests. - */ - clientContext?: Schema$ClientContext; /** * Priority for the request. */ @@ -2911,6 +2945,27 @@ export namespace spanner_v1 { */ startTime?: string | null; } + /** + * Arguments to send operations. + */ + export interface Schema$Send { + /** + * The time at which Spanner will begin attempting to deliver the message. If `deliver_time` is not set, Spanner will deliver the message immediately. If `deliver_time` is in the past, Spanner will replace it with a value closer to the current time. + */ + deliverTime?: string | null; + /** + * Required. The primary key of the message to be sent. + */ + key?: any[] | null; + /** + * The payload of the message. + */ + payload?: any | null; + /** + * Required. The queue to which the message will be sent. + */ + queue?: string | null; + } /** * A session in the Cloud Spanner API. */ @@ -4854,7 +4909,7 @@ export namespace spanner_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); @@ -4998,7 +5053,7 @@ export namespace spanner_v1 { */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; } @@ -5479,7 +5534,7 @@ export namespace spanner_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); @@ -5624,7 +5679,7 @@ export namespace spanner_v1 { */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; } @@ -9285,7 +9340,7 @@ export namespace spanner_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); @@ -9430,7 +9485,7 @@ export namespace spanner_v1 { */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; } @@ -14020,7 +14075,7 @@ export namespace spanner_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); @@ -14165,7 +14220,7 @@ export namespace spanner_v1 { */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; } @@ -18658,7 +18713,7 @@ export namespace spanner_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); @@ -18803,7 +18858,7 @@ export namespace spanner_v1 { */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; } @@ -19267,7 +19322,7 @@ export namespace spanner_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); @@ -19411,7 +19466,7 @@ export namespace spanner_v1 { */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; } diff --git a/src/apis/workspaceevents/v1.ts b/src/apis/workspaceevents/v1.ts index 43488eeeaab..847a312b05d 100644 --- a/src/apis/workspaceevents/v1.ts +++ b/src/apis/workspaceevents/v1.ts @@ -172,7 +172,12 @@ export namespace workspaceevents_v1 { */ schemes?: string[] | null; } - export interface Schema$CancelTaskRequest {} + export interface Schema$CancelTaskRequest { + /** + * Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release. + */ + tenant?: string | null; + } /** * DataPart represents a structured blob. This is most commonly a JSON payload. */ @@ -369,6 +374,10 @@ export namespace workspaceevents_v1 { * Optional metadata for the request. */ metadata?: {[key: string]: any} | null; + /** + * Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release. + */ + tenant?: string | null; } /** * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). @@ -615,7 +624,8 @@ export namespace workspaceevents_v1 { * // { * // "configuration": {}, * // "message": {}, - * // "metadata": {} + * // "metadata": {}, + * // "tenant": "my_tenant" * // } * }, * }); @@ -2053,7 +2063,9 @@ export namespace workspaceevents_v1 { * // Request body metadata * requestBody: { * // request body parameters - * // {} + * // { + * // "tenant": "my_tenant" + * // } * }, * }); * console.log(res.data); @@ -2196,6 +2208,8 @@ export namespace workspaceevents_v1 { * historyLength: 'placeholder-value', * // Required. The resource name of the task. Format: tasks/{task_id\} * name: 'tasks/my-task', + * // Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release. + * tenant: 'placeholder-value', * }); * console.log(res.data); * @@ -2335,6 +2349,8 @@ export namespace workspaceevents_v1 { * const res = await workspaceevents.tasks.subscribe({ * // The resource name of the task to subscribe to. Format: tasks/{task_id\} * name: 'tasks/my-task', + * // Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release. + * tenant: 'placeholder-value', * }); * console.log(res.data); * @@ -2463,12 +2479,20 @@ export namespace workspaceevents_v1 { * Required. The resource name of the task. Format: tasks/{task_id\} */ name?: string; + /** + * Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release. + */ + tenant?: string; } export interface Params$Resource$Tasks$Subscribe extends StandardParameters { /** * The resource name of the task to subscribe to. Format: tasks/{task_id\} */ name?: string; + /** + * Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release. + */ + tenant?: string; } export class Resource$Tasks$Pushnotificationconfigs { @@ -2512,6 +2536,8 @@ export namespace workspaceevents_v1 { * configId: 'placeholder-value', * // Required. The parent task resource for this config. Format: tasks/{task_id\} * parent: 'tasks/my-task/pushNotificationConfigs', + * // Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release. + * tenant: 'placeholder-value', * * // Request body metadata * requestBody: { @@ -2661,6 +2687,8 @@ export namespace workspaceevents_v1 { * const res = await workspaceevents.tasks.pushNotificationConfigs.delete({ * // The resource name of the config to delete. Format: tasks/{task_id\}/pushNotificationConfigs/{config_id\} * name: 'tasks/my-task/pushNotificationConfigs/my-pushNotificationConfig', + * // Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release. + * tenant: 'placeholder-value', * }); * console.log(res.data); * @@ -2794,6 +2822,8 @@ export namespace workspaceevents_v1 { * const res = await workspaceevents.tasks.pushNotificationConfigs.get({ * // The resource name of the config to retrieve. Format: tasks/{task_id\}/pushNotificationConfigs/{config_id\} * name: 'tasks/my-task/pushNotificationConfigs/my-pushNotificationConfig', + * // Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release. + * tenant: 'placeholder-value', * }); * console.log(res.data); * @@ -2938,6 +2968,8 @@ export namespace workspaceevents_v1 { * pageToken: 'placeholder-value', * // The parent task resource. Format: tasks/{task_id\} * parent: 'tasks/my-task', + * // Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release. + * tenant: 'placeholder-value', * }); * console.log(res.data); * @@ -3064,6 +3096,10 @@ export namespace workspaceevents_v1 { * Required. The parent task resource for this config. Format: tasks/{task_id\} */ parent?: string; + /** + * Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release. + */ + tenant?: string; /** * Request body metadata @@ -3075,12 +3111,20 @@ export namespace workspaceevents_v1 { * The resource name of the config to delete. Format: tasks/{task_id\}/pushNotificationConfigs/{config_id\} */ name?: string; + /** + * Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release. + */ + tenant?: string; } export interface Params$Resource$Tasks$Pushnotificationconfigs$Get extends StandardParameters { /** * The resource name of the config to retrieve. Format: tasks/{task_id\}/pushNotificationConfigs/{config_id\} */ name?: string; + /** + * Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release. + */ + tenant?: string; } export interface Params$Resource$Tasks$Pushnotificationconfigs$List extends StandardParameters { /** @@ -3095,5 +3139,9 @@ export namespace workspaceevents_v1 { * The parent task resource. Format: tasks/{task_id\} */ parent?: string; + /** + * Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release. + */ + tenant?: string; } } diff --git a/src/apis/youtube/v3.ts b/src/apis/youtube/v3.ts index 3908fa7f315..57529dbdadf 100644 --- a/src/apis/youtube/v3.ts +++ b/src/apis/youtube/v3.ts @@ -4590,13 +4590,13 @@ export namespace youtube_v3 { */ etag?: string | null; /** - * Output only. Identifies what kind of resource this is. Value: the fixed string "youtube#videoStats". + * Output only. The ID that YouTube uses to uniquely identify the video. */ - kind?: string | null; + id?: string | null; /** - * Output only. Identifier. The resource name for the `VideoStats` resource, in the format `videoStats/{video_stat\}`. + * Output only. Identifies what kind of resource this is. Value: the fixed string "youtube#videoStats". */ - name?: string | null; + kind?: string | null; /** * Output only. The VideoStatsSnippet object contains basic details about the video, such publish time. */ @@ -4605,10 +4605,6 @@ export namespace youtube_v3 { * Output only. The VideoStatsStatistics object contains statistics about the video. */ statistics?: Schema$VideoStatsStatistics; - /** - * Output only. The ID that YouTube uses to uniquely identify the video. - */ - videoId?: string | null; } /** * Statistics about the video, such as the number of times the video was viewed or liked. @@ -19703,12 +19699,12 @@ export namespace youtube_v3 { * * // Do the magic * const res = await youtube.youtube.v3.videos.batchGetStats({ + * // Required. Return videos with the given ids. + * id: 'placeholder-value', * // Optional. **Note:** This parameter is intended exclusively for YouTube content partners. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. * onBehalfOfContentOwner: 'placeholder-value', * // Required. The `**part**` parameter specifies a comma-separated list of one or more `videoStat` resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a `videoStat` resource, the `statistics` property contains `view_count` and `like_count`. As such, if you set `**part=snippet**`, the API response will contain all of those properties. * part: 'placeholder-value', - * // Required. Return videos with the given ids. - * videoIds: 'placeholder-value', * }); * console.log(res.data); * @@ -19821,6 +19817,10 @@ export namespace youtube_v3 { } export interface Params$Resource$Youtube$V3$Videos$Batchgetstats extends StandardParameters { + /** + * Required. Return videos with the given ids. + */ + id?: string[]; /** * Optional. **Note:** This parameter is intended exclusively for YouTube content partners. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. */ @@ -19829,9 +19829,5 @@ export namespace youtube_v3 { * Required. The `**part**` parameter specifies a comma-separated list of one or more `videoStat` resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a `videoStat` resource, the `statistics` property contains `view_count` and `like_count`. As such, if you set `**part=snippet**`, the API response will contain all of those properties. */ part?: string[]; - /** - * Required. Return videos with the given ids. - */ - videoIds?: string[]; } }