diff --git a/discovery/aiplatform-v1.json b/discovery/aiplatform-v1.json index 375054616fe..a641b00c5b2 100644 --- a/discovery/aiplatform-v1.json +++ b/discovery/aiplatform-v1.json @@ -22228,14 +22228,12 @@ "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" - }, - "operationName": { - "description": "Required. The name of the longrunning operation returned from AsyncQueryReasoningEngine. Format: `projects/{project}/locations/{location}/operations/{operation}`", - "location": "query", - "type": "string" } }, "path": "v1/{+name}:cancelAsyncQuery", + "request": { + "$ref": "GoogleCloudAiplatformV1CancelAsyncQueryReasoningEngineRequest" + }, "response": { "$ref": "GoogleCloudAiplatformV1CancelAsyncQueryReasoningEngineResponse" }, @@ -29051,14 +29049,12 @@ "pattern": "^reasoningEngines/[^/]+$", "required": true, "type": "string" - }, - "operationName": { - "description": "Required. The name of the longrunning operation returned from AsyncQueryReasoningEngine. Format: `projects/{project}/locations/{location}/operations/{operation}`", - "location": "query", - "type": "string" } }, "path": "v1/{+name}:cancelAsyncQuery", + "request": { + "$ref": "GoogleCloudAiplatformV1CancelAsyncQueryReasoningEngineRequest" + }, "response": { "$ref": "GoogleCloudAiplatformV1CancelAsyncQueryReasoningEngineResponse" }, @@ -32361,13 +32357,27 @@ } } }, - "revision": "20260506", + "revision": "20260509", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoExperiments": { "description": "Experimental parameters for video generation.", "id": "CloudAiLargeModelsVisionGenerateVideoExperiments", "properties": { + "codec": { + "description": "Optional. Video codec to use for output.", + "enum": [ + "VIDEO_CODEC_UNSPECIFIED", + "VIDEO_CODEC_H264", + "VIDEO_CODEC_PRORES" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, "conditioningFrames": { "description": "Conditioning frames for veo experimental models ONLY, not to be confused with keyframes (ID:31) in GenerateVideoRequest.", "items": { @@ -33384,11 +33394,11 @@ "id": "GoogleCloudAiplatformV1AsyncQueryReasoningEngineRequest", "properties": { "inputGcsUri": { - "description": "Optional. Input Cloud Storage URI for the Async query.", + "description": "Optional. Input Cloud Storage URI for the Async query. If you are not bringing your own container (BYOC), the content of the file should be a JSON object with an `input` field matching the `input` field of `QueryReasoningEngineRequest` (e.g. `{ \"input\": { \"user_id\": \"hello\", \"message\":\"$QUERY\"} }`). For BYOC, the content of the file depends on the the agent application.", "type": "string" }, "outputGcsUri": { - "description": "Optional. Output Cloud Storage URI for the Async query.", + "description": "Optional. Output Cloud Storage URI for the Async query. This contains the final response of the query.", "type": "string" } }, @@ -34693,6 +34703,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1CancelAsyncQueryReasoningEngineRequest": { + "description": "Request message for ReasoningEngineExecutionService.CancelAsyncQueryReasoningEngine.", + "id": "GoogleCloudAiplatformV1CancelAsyncQueryReasoningEngineRequest", + "properties": { + "operationName": { + "description": "Required. The name of the longrunning operation returned from AsyncQueryReasoningEngine. Format: `projects/{project}/locations/{location}/operations/{operation}`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1CancelAsyncQueryReasoningEngineResponse": { "description": "Response message for ReasoningEngineExecutionService.CancelAsyncQueryReasoningEngine.", "id": "GoogleCloudAiplatformV1CancelAsyncQueryReasoningEngineResponse", @@ -39290,7 +39311,7 @@ "type": "array" }, "metrics": { - "description": "Required. The metrics to be calculated in the evaluation run.", + "description": "Optional. The metrics to be calculated in the evaluation run. Required when analysis_configs is not set.", "items": { "$ref": "GoogleCloudAiplatformV1EvaluationRunMetric" }, @@ -42734,6 +42755,20 @@ "description": "Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.", "id": "GoogleCloudAiplatformV1FunctionDeclaration", "properties": { + "behavior": { + "description": "Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method.", + "enum": [ + "UNSPECIFIED", + "BLOCKING", + "NON_BLOCKING" + ], + "enumDescriptions": [ + "This value is unspecified.", + "If set, the system will wait to receive the function response before continuing the conversation.", + "If set, the system will not wait to receive the function response. Instead, it will attempt to handle function responses as they become available while maintaining the conversation between the user and the model." + ], + "type": "string" + }, "description": { "description": "Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.", "type": "string" @@ -55672,7 +55707,7 @@ "type": "string" }, "sandboxEnvironmentTemplate": { - "description": "Optional. The name of the SandboxEnvironmentTemplate specified in the parent Agent Engine resource that this SandboxEnvironment is created from. Only one of `sandbox_environment_template` and `spec` should be set.", + "description": "Optional. The name of the SandboxEnvironmentTemplate specified in the parent Agent Engine resource that this SandboxEnvironment is created from.", "type": "string" }, "spec": { diff --git a/discovery/aiplatform-v1beta1.json b/discovery/aiplatform-v1beta1.json index 909588b12f8..5ab500959af 100644 --- a/discovery/aiplatform-v1beta1.json +++ b/discovery/aiplatform-v1beta1.json @@ -5720,6 +5720,142 @@ } } }, + "interactions": { + "methods": { + "cancel": { + "description": "Cancels an interaction.", + "flatPath": "v1beta1/interactions/{interactionsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.interactions.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the interaction to cancel. Format: `interactions/{interaction}`.", + "location": "path", + "pattern": "^interactions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GenaiVertexV1beta1Interaction" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an interaction.", + "flatPath": "v1beta1/interactions/{interactionsId}", + "httpMethod": "DELETE", + "id": "aiplatform.interactions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the interaction to delete. Format: interactions/{interaction}", + "location": "path", + "pattern": "^interactions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getPoll": { + "description": "Fully typed proto, unary version of GetInteraction that returns Interaction proto.", + "flatPath": "v1beta1/interactions/{interactionsId}:poll", + "httpMethod": "GET", + "id": "aiplatform.interactions.getPoll", + "parameterOrder": [ + "name" + ], + "parameters": { + "include_input": { + "deprecated": true, + "description": "Optional. If true, includes the input in the response.", + "location": "query", + "type": "boolean" + }, + "last_event_id": { + "description": "Optional. If set, resumes the interaction stream from the chunk after the event marked by the event id. Can only be used if `stream` is true.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The name of the interaction to retrieve. Format: interactions/{interaction}", + "location": "path", + "pattern": "^interactions/[^/]+$", + "required": true, + "type": "string" + }, + "stream": { + "description": "Optional. If true, streams the interaction events as Server-Sent Events.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}:poll", + "response": { + "$ref": "GenaiVertexV1beta1Interaction" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getStream": { + "description": "Fully typed proto, streaming version of GetInteraction that returns Interaction proto.", + "flatPath": "v1beta1/interactions/{interactionsId}:stream", + "httpMethod": "GET", + "id": "aiplatform.interactions.getStream", + "parameterOrder": [ + "name" + ], + "parameters": { + "include_input": { + "deprecated": true, + "description": "Optional. If true, includes the input in the response.", + "location": "query", + "type": "boolean" + }, + "last_event_id": { + "description": "Optional. If set, resumes the interaction stream from the chunk after the event marked by the event id. Can only be used if `stream` is true.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The name of the interaction to retrieve. Format: interactions/{interaction}", + "location": "path", + "pattern": "^interactions/[^/]+$", + "required": true, + "type": "string" + }, + "stream": { + "description": "Optional. If true, streams the interaction events as Server-Sent Events.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}:stream", + "response": { + "$ref": "GenaiVertexV1beta1InteractionStreamingEvent" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "media": { "methods": { "upload": { @@ -8949,6 +9085,161 @@ }, "resources": { "agents": { + "methods": { + "create": { + "description": "Creates a new Agent in a given location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.agents.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the location to create the agent in. Format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/agents", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Agent" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes the specific Agent.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.agents.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of the specific Agent.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.agents.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Agent" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Agents in a given location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.agents.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "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 agents to return. The service may return fewer than this value. If unspecified, at most 100 agents will be returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The next_page_token value returned from a previous list AgentService.ListAgents call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the location to list agents from. Format: `projects/{project}/locations/{location}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/agents", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListAgentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the specific Agent.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.agents.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Agent" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Agent" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "operations": { "methods": { @@ -13584,6 +13875,62 @@ ] } } + }, + "responses": { + "methods": { + "delete": { + "description": "Deletes the response from the endpoint.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/responses/{responsesId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.endpoints.responses.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Response resource to be deleted. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}/responses/{response}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/responses/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "get": { + "description": "Gets the response from the endpoint.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/responses/{responsesId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.endpoints.responses.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Response resource. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}/responses/{response}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/responses/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } } } }, @@ -20637,6 +20984,74 @@ } } }, + "interactions": { + "methods": { + "create": { + "description": "Creates an interaction.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactions:create", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.interactions.create", + "parameterOrder": [ + "projectsId", + "locationsId" + ], + "parameters": { + "locationsId": { + "location": "path", + "required": true, + "type": "string" + }, + "projectsId": { + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactions:create", + "request": { + "$ref": "GenaiVertexV1beta1CreateInteractionRequest" + }, + "response": { + "$ref": "GenaiVertexV1beta1Interaction" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "createStream": { + "description": "Creates an interaction and streams the response.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactions:createStream", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.interactions.createStream", + "parameterOrder": [ + "projectsId", + "locationsId" + ], + "parameters": { + "locationsId": { + "location": "path", + "required": true, + "type": "string" + }, + "projectsId": { + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactions:createStream", + "request": { + "$ref": "GenaiVertexV1beta1CreateInteractionRequest" + }, + "response": { + "$ref": "GenaiVertexV1beta1InteractionStreamingEvent" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "metadataStores": { "methods": { "create": { @@ -28849,14 +29264,12 @@ "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" - }, - "operationName": { - "description": "Required. The name of the longrunning operation returned from AsyncQueryReasoningEngine. Format: `projects/{project}/locations/{location}/operations/{operation}`", - "location": "query", - "type": "string" } }, "path": "v1beta1/{+name}:cancelAsyncQuery", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1CancelAsyncQueryReasoningEngineRequest" + }, "response": { "$ref": "GoogleCloudAiplatformV1beta1CancelAsyncQueryReasoningEngineResponse" }, @@ -34417,15 +34830,15 @@ } } }, - "skills": { + "servingProfiles": { "resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}/operations/{operationsId}:cancel", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.skills.operations.cancel", + "id": "aiplatform.projects.locations.servingProfiles.operations.cancel", "parameterOrder": [ "name" ], @@ -34433,7 +34846,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/servingProfiles/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -34448,9 +34861,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.skills.operations.delete", + "id": "aiplatform.projects.locations.servingProfiles.operations.delete", "parameterOrder": [ "name" ], @@ -34458,7 +34871,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/servingProfiles/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -34473,9 +34886,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.skills.operations.get", + "id": "aiplatform.projects.locations.servingProfiles.operations.get", "parameterOrder": [ "name" ], @@ -34483,7 +34896,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/servingProfiles/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -34498,9 +34911,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}/operations", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.skills.operations.list", + "id": "aiplatform.projects.locations.servingProfiles.operations.list", "parameterOrder": [ "name" ], @@ -34513,7 +34926,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/servingProfiles/[^/]+$", "required": true, "type": "string" }, @@ -34544,9 +34957,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.skills.operations.wait", + "id": "aiplatform.projects.locations.servingProfiles.operations.wait", "parameterOrder": [ "name" ], @@ -34554,7 +34967,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/servingProfiles/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -34577,15 +34990,231 @@ } } }, - "solvers": { + "skills": { + "methods": { + "create": { + "description": "Create a Skill.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/skills", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.skills.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The location to create the Skill in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "skillId": { + "description": "Optional. The ID to use for the Skill, which will become the final component of the Skill's resource name. If not provided, a system-generated ID will be used. This value must be 1-63 characters. Valid characters are lowercase letters, numbers, and hyphens. The first character must be a lowercase letter, and the last character must be a lowercase letter or a number. Specifically, the ID must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$` See [AIP-122](https://aip.dev/122#resource-id-segments) for more details.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/skills", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Skill" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete a Skill.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.skills.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Skill to delete. Format: `projects/{project}/locations/{location}/skills/{skill}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get a Skill.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.skills.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Skill to retrieve. Format: `projects/{project}/locations/{location}/skills/{skill}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Skill" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List Skills.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/skills", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.skills.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The location to list the Skills in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/skills", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListSkillsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update a Skill.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.skills.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the Skill. Format: `projects/{project}/locations/{location}/skills/{skill}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Mask specifying which fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Skill" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "retrieve": { + "description": "Retrieves skills.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/skills:retrieve", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.skills.retrieve", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The location to retrieve the Skills in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "query": { + "description": "Optional. The query to find matching skills.", + "location": "query", + "type": "string" + }, + "topK": { + "description": "Optional. The maximum number of skills to return. The service may return fewer than this value. If unspecified, at most 10 skills will be returned. The maximum value is 100.", + "format": "int32", + "location": "query", + "type": "integer" + } + }, + "path": "v1beta1/{+parent}/skills:retrieve", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1RetrieveSkillsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "operations": { "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.skills.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/solvers/{solversId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.solvers.operations.delete", + "id": "aiplatform.projects.locations.skills.operations.delete", "parameterOrder": [ "name" ], @@ -34593,7 +35222,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/solvers/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -34608,9 +35237,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/solvers/{solversId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.solvers.operations.get", + "id": "aiplatform.projects.locations.skills.operations.get", "parameterOrder": [ "name" ], @@ -34618,7 +35247,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/solvers/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -34633,9 +35262,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/solvers/{solversId}/operations", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.solvers.operations.list", + "id": "aiplatform.projects.locations.skills.operations.list", "parameterOrder": [ "name" ], @@ -34648,7 +35277,212 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/solvers/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+$", + "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": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.skills.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "revisions": { + "methods": { + "get": { + "description": "Get a Skill Revision.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}/revisions/{revisionsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.skills.revisions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Skill Revision to retrieve. Format: `projects/{project}/locations/{location}/skills/{skill}/revisions/{revision}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+/revisions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1SkillRevision" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List Skill Revisions for a Skill.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}/revisions", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.skills.revisions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `labels`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Skill to list revisions for. Format: `projects/{project}/locations/{location}/skills/{skill}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/revisions", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListSkillRevisionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "solvers": { + "resources": { + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/solvers/{solversId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.solvers.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/solvers/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/solvers/{solversId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.solvers.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/solvers/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/solvers/{solversId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.solvers.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/solvers/[^/]+$", "required": true, "type": "string" }, @@ -38873,14 +39707,12 @@ "pattern": "^reasoningEngines/[^/]+$", "required": true, "type": "string" - }, - "operationName": { - "description": "Required. The name of the longrunning operation returned from AsyncQueryReasoningEngine. Format: `projects/{project}/locations/{location}/operations/{operation}`", - "location": "query", - "type": "string" } }, "path": "v1beta1/{+name}:cancelAsyncQuery", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1CancelAsyncQueryReasoningEngineRequest" + }, "response": { "$ref": "GoogleCloudAiplatformV1beta1CancelAsyncQueryReasoningEngineResponse" }, @@ -43823,15 +44655,15 @@ } } }, - "skills": { + "servingProfiles": { "resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/skills/{skillsId}/operations/{operationsId}:cancel", + "flatPath": "v1beta1/servingProfiles/{servingProfilesId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.skills.operations.cancel", + "id": "aiplatform.servingProfiles.operations.cancel", "parameterOrder": [ "name" ], @@ -43839,7 +44671,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^skills/[^/]+/operations/[^/]+$", + "pattern": "^servingProfiles/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -43854,9 +44686,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/skills/{skillsId}/operations/{operationsId}", + "flatPath": "v1beta1/servingProfiles/{servingProfilesId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.skills.operations.delete", + "id": "aiplatform.servingProfiles.operations.delete", "parameterOrder": [ "name" ], @@ -43864,7 +44696,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^skills/[^/]+/operations/[^/]+$", + "pattern": "^servingProfiles/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -43879,9 +44711,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/skills/{skillsId}/operations/{operationsId}", + "flatPath": "v1beta1/servingProfiles/{servingProfilesId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.skills.operations.get", + "id": "aiplatform.servingProfiles.operations.get", "parameterOrder": [ "name" ], @@ -43889,7 +44721,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^skills/[^/]+/operations/[^/]+$", + "pattern": "^servingProfiles/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -43904,9 +44736,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/skills/{skillsId}/operations", + "flatPath": "v1beta1/servingProfiles/{servingProfilesId}/operations", "httpMethod": "GET", - "id": "aiplatform.skills.operations.list", + "id": "aiplatform.servingProfiles.operations.list", "parameterOrder": [ "name" ], @@ -43919,7 +44751,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^skills/[^/]+$", + "pattern": "^servingProfiles/[^/]+$", "required": true, "type": "string" }, @@ -43950,9 +44782,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/skills/{skillsId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/servingProfiles/{servingProfilesId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.skills.operations.wait", + "id": "aiplatform.servingProfiles.operations.wait", "parameterOrder": [ "name" ], @@ -43960,7 +44792,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^skills/[^/]+/operations/[^/]+$", + "pattern": "^servingProfiles/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -43983,15 +44815,40 @@ } } }, - "solvers": { + "skills": { "resources": { "operations": { "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/skills/{skillsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.skills.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^skills/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/solvers/{solversId}/operations/{operationsId}", + "flatPath": "v1beta1/skills/{skillsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.solvers.operations.delete", + "id": "aiplatform.skills.operations.delete", "parameterOrder": [ "name" ], @@ -43999,7 +44856,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^solvers/[^/]+/operations/[^/]+$", + "pattern": "^skills/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -44014,9 +44871,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/solvers/{solversId}/operations/{operationsId}", + "flatPath": "v1beta1/skills/{skillsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.solvers.operations.get", + "id": "aiplatform.skills.operations.get", "parameterOrder": [ "name" ], @@ -44024,7 +44881,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^solvers/[^/]+/operations/[^/]+$", + "pattern": "^skills/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -44039,9 +44896,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/solvers/{solversId}/operations", + "flatPath": "v1beta1/skills/{skillsId}/operations", "httpMethod": "GET", - "id": "aiplatform.solvers.operations.list", + "id": "aiplatform.skills.operations.list", "parameterOrder": [ "name" ], @@ -44054,7 +44911,142 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^solvers/[^/]+$", + "pattern": "^skills/[^/]+$", + "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": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/skills/{skillsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.skills.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^skills/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "solvers": { + "resources": { + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/solvers/{solversId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.solvers.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^solvers/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/solvers/{solversId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.solvers.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^solvers/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/solvers/{solversId}/operations", + "httpMethod": "GET", + "id": "aiplatform.solvers.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^solvers/[^/]+$", "required": true, "type": "string" }, @@ -45523,13 +46515,27 @@ } } }, - "revision": "20260506", + "revision": "20260515", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoExperiments": { "description": "Experimental parameters for video generation.", "id": "CloudAiLargeModelsVisionGenerateVideoExperiments", "properties": { + "codec": { + "description": "Optional. Video codec to use for output.", + "enum": [ + "VIDEO_CODEC_UNSPECIFIED", + "VIDEO_CODEC_H264", + "VIDEO_CODEC_PRORES" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, "conditioningFrames": { "description": "Conditioning frames for veo experimental models ONLY, not to be confused with keyframes (ID:31) in GenerateVideoRequest.", "items": { @@ -45818,264 +46824,3615 @@ }, "type": "object" }, - "CloudAiLargeModelsVisionPromptInputs": { - "description": "\"Direct\" prompting for Experimental Video Generation. These will be sent directly to the LDM without being rewritten.", - "id": "CloudAiLargeModelsVisionPromptInputs", + "CloudAiLargeModelsVisionPromptInputs": { + "description": "\"Direct\" prompting for Experimental Video Generation. These will be sent directly to the LDM without being rewritten.", + "id": "CloudAiLargeModelsVisionPromptInputs", + "properties": { + "audioPrompt": { + "description": "Description of audio content in the video, without speech.", + "type": "string" + }, + "negativeAudioPrompt": { + "description": "Negative description of audio content in the video.", + "type": "string" + }, + "negativePrompt": { + "description": "Single negative prompt for what not to generate.", + "type": "string" + }, + "promptChunks": { + "description": "2s, 256 tokens per chunk, 4 total chunks. Required.", + "items": { + "type": "string" + }, + "type": "array" + }, + "transcript": { + "description": "Spoken transcript of the video for characters.", + "type": "string" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionRaiInfo": { + "description": "Next ID: 6", + "id": "CloudAiLargeModelsVisionRaiInfo", + "properties": { + "blockedEntities": { + "description": "List of blocked entities from the blocklist if it is detected.", + "items": { + "type": "string" + }, + "type": "array" + }, + "detectedLabels": { + "description": "The list of detected labels for different rai categories.", + "items": { + "$ref": "CloudAiLargeModelsVisionRaiInfoDetectedLabels" + }, + "type": "array" + }, + "modelName": { + "description": "The model name used to indexing into the RaiFilterConfig map. Would either be one of imagegeneration@002-006, imagen-3.0-... api endpoint names, or internal names used for mapping to different filter configs (genselfie, ai_watermark) than its api endpoint.", + "type": "string" + }, + "raiCategories": { + "description": "List of rai categories' information to return", + "items": { + "type": "string" + }, + "type": "array" + }, + "scores": { + "description": "List of rai scores mapping to the rai categories. Rounded to 1 decimal place.", + "items": { + "format": "float", + "type": "number" + }, + "type": "array" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionRaiInfoDetectedLabels": { + "description": "Filters returning list of deteceted labels, scores, and bounding boxes.", + "id": "CloudAiLargeModelsVisionRaiInfoDetectedLabels", + "properties": { + "entities": { + "description": "The list of detected entities for the rai signal.", + "items": { + "$ref": "CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity" + }, + "type": "array" + }, + "raiCategory": { + "description": "The RAI category for the deteceted labels.", + "type": "string" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox": { + "description": "An integer bounding box of original pixels of the image for the detected labels.", + "id": "CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox", + "properties": { + "x1": { + "description": "The X coordinate of the top-left corner, in pixels.", + "format": "int32", + "type": "integer" + }, + "x2": { + "description": "The X coordinate of the bottom-right corner, in pixels.", + "format": "int32", + "type": "integer" + }, + "y1": { + "description": "The Y coordinate of the top-left corner, in pixels.", + "format": "int32", + "type": "integer" + }, + "y2": { + "description": "The Y coordinate of the bottom-right corner, in pixels.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity": { + "description": "The properties for a detected entity from the rai signal.", + "id": "CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity", + "properties": { + "boundingBox": { + "$ref": "CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox", + "description": "Bounding box of the label" + }, + "description": { + "description": "Description of the label", + "type": "string" + }, + "iouScore": { + "description": "The intersection ratio between the detection bounding box and the mask.", + "format": "float", + "type": "number" + }, + "mid": { + "description": "MID of the label", + "type": "string" + }, + "score": { + "description": "Confidence score of the label", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionSemanticFilterResponse": { + "id": "CloudAiLargeModelsVisionSemanticFilterResponse", + "properties": { + "namedBoundingBoxes": { + "description": "Class labels of the bounding boxes that failed the semantic filtering. Bounding box coordinates.", + "items": { + "$ref": "CloudAiLargeModelsVisionNamedBoundingBox" + }, + "type": "array" + }, + "passedSemanticFilter": { + "description": "This response is added when semantic filter config is turned on in EditConfig. It reports if this image is passed semantic filter response. If passed_semantic_filter is false, the bounding box information will be populated for user to check what caused the semantic filter to fail.", + "type": "boolean" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionVideo": { + "description": "Video", + "id": "CloudAiLargeModelsVisionVideo", + "properties": { + "encodedVideo": { + "description": "Base 64 encoded video bytes.", + "type": "string" + }, + "encoding": { + "description": "Video encoding, for example \"video/mp4\".", + "type": "string" + }, + "text": { + "description": "Text/Expanded text input for Help Me Write.", + "type": "string" + }, + "uri": { + "description": "Path to another storage (typically Google Cloud Storage).", + "type": "string" + }, + "video": { + "description": "Raw bytes.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "CloudAiPlatformCommonCreatePipelineJobApiErrorDetail": { + "description": "Create API error message for Vertex Pipeline.", + "id": "CloudAiPlatformCommonCreatePipelineJobApiErrorDetail", + "properties": { + "errorCause": { + "description": "The error root cause returned by CreatePipelineJob API.", + "enum": [ + "ERROR_CAUSE_UNSPECIFIED", + "INVALID_PIPELINE_SPEC_FORMAT", + "INVALID_PIPELINE_SPEC", + "INVALID_DEPLOYMENT_CONFIG", + "INVALID_DEPLOYMENT_SPEC", + "INVALID_INSTANCE_SCHEMA", + "INVALID_CUSTOM_JOB", + "INVALID_CONTAINER_SPEC", + "INVALID_NOTIFICATION_EMAIL_SETUP", + "INVALID_SERVICE_ACCOUNT_SETUP", + "INVALID_KMS_SETUP", + "INVALID_NETWORK_SETUP", + "INVALID_PIPELINE_TASK_SPEC", + "INVALID_PIPELINE_TASK_ARTIFACT", + "INVALID_IMPORTER_SPEC", + "INVALID_RESOLVER_SPEC", + "INVALID_RUNTIME_PARAMETERS", + "CLOUD_API_NOT_ENABLED", + "INVALID_GCS_INPUT_URI", + "INVALID_GCS_OUTPUT_URI", + "INVALID_COMPONENT_SPEC", + "INVALID_DAG_OUTPUTS_SPEC", + "INVALID_DAG_SPEC", + "INSUFFICIENT_QUOTA", + "INTERNAL" + ], + "enumDescriptions": [ + "Should never be used.", + "IR Pipeline Spec can not been parsed to yaml or json format.", + "A pipeline spec is invalid.", + "A deployment config is invalid.", + "A deployment spec is invalid.", + "An instance schema is invalid.", + "A custom job is invalid.", + "A container spec is invalid.", + "Notification email setup is invalid.", + "Service account setup is invalid.", + "KMS setup is invalid.", + "Network setup is invalid.", + "Task spec is invalid.", + "Task artifact is invalid.", + "Importer spec is invalid.", + "Resolver spec is invalid.", + "Runtime Parameters are invalid.", + "Cloud API not enabled.", + "Invalid Cloud Storage input uri", + "Invalid Cloud Storage output uri", + "Component spec of pipeline is invalid.", + "DagOutputsSpec is invalid.", + "DagSpec is invalid.", + "Project does not have enough quota.", + "An internal error with unknown cause." + ], + "type": "string" + }, + "publicMessage": { + "description": "Public messages contains actionable items for the error cause.", + "type": "string" + } + }, + "type": "object" + }, + "GenaiField": { + "description": "Represents a single field in a struct.", + "id": "GenaiField", + "properties": { + "name": { + "type": "string" + }, + "value": { + "$ref": "GenaiValue" + } + }, + "type": "object" + }, + "GenaiListValue": { + "description": "`ListValue` is a wrapper around a repeated field of values.", + "id": "GenaiListValue", + "properties": { + "values": { + "description": "Repeated field of dynamically typed values.", + "items": { + "$ref": "GenaiValue" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenaiStruct": { + "description": "`Struct` represents a structured data value, consisting of fields which map to dynamically typed values.", + "id": "GenaiStruct", + "properties": { + "fields": { + "description": "Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.", + "items": { + "$ref": "GenaiField" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenaiValue": { + "description": "`Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.", + "id": "GenaiValue", + "properties": { + "boolValue": { + "description": "Represents a boolean value.", + "type": "boolean" + }, + "listValue": { + "$ref": "GenaiListValue", + "description": "Represents a repeated `Value`." + }, + "nullValue": { + "description": "Represents a null value.", + "enum": [ + "NULL_VALUE" + ], + "enumDescriptions": [ + "Null value." + ], + "type": "string" + }, + "numberValue": { + "description": "Represents a double value.", + "format": "double", + "type": "number" + }, + "stringValue": { + "description": "Represents a string value.", + "type": "string" + }, + "structValue": { + "$ref": "GenaiStruct", + "description": "Represents a structured value." + } + }, + "type": "object" + }, + "GenaiVertexV1beta1AgentInteraction": { + "description": "Interaction for generating the completion using agents.", + "id": "GenaiVertexV1beta1AgentInteraction", + "properties": { + "agent": { + "description": "The name of the `Agent` used for generating the completion.", + "type": "string" + }, + "deep_research_config": { + "$ref": "GenaiVertexV1beta1DeepResearchAgentConfig" + }, + "dynamic_config": { + "$ref": "GenaiVertexV1beta1DynamicAgentConfig" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1AllowedTools": { + "description": "The configuration for allowed tools.", + "id": "GenaiVertexV1beta1AllowedTools", + "properties": { + "mode": { + "description": "The mode of the tool choice.", + "enum": [ + "TOOL_CHOICE_TYPE_UNSPECIFIED", + "AUTO", + "ANY", + "NONE", + "VALIDATED" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Auto tool choice.", + "Any tool choice.", + "No tool choice.", + "Validated tool choice." + ], + "type": "string" + }, + "tools": { + "description": "The names of the allowed tools.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1ArgumentsDelta": { + "id": "GenaiVertexV1beta1ArgumentsDelta", + "properties": { + "partial_arguments": { + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1AudioContent": { + "description": "An audio content block.", + "id": "GenaiVertexV1beta1AudioContent", + "properties": { + "channels": { + "description": "The number of audio channels.", + "format": "int32", + "type": "integer" + }, + "data": { + "description": "The audio content.", + "format": "byte", + "type": "string" + }, + "mime_type": { + "description": "The mime type of the audio.", + "enum": [ + "TYPE_UNSPECIFIED", + "TYPE_WAV", + "TYPE_MP3", + "TYPE_AIFF", + "TYPE_AAC", + "TYPE_OGG", + "TYPE_FLAC", + "TYPE_MPEG", + "TYPE_M4A", + "TYPE_L16", + "TYPE_OPUS", + "TYPE_ALAW", + "TYPE_MULAW" + ], + "enumDescriptions": [ + "", + "WAV audio format", + "MP3 audio format", + "AIFF audio format", + "AAC audio format", + "OGG audio format", + "FLAC audio format", + "MPEG audio format", + "M4A audio format", + "L16 audio format", + "OPUS audio format", + "ALAW audio format", + "MULAW audio format" + ], + "type": "string" + }, + "sample_rate": { + "description": "The sample rate of the audio.", + "format": "int32", + "type": "integer" + }, + "uri": { + "description": "The URI of the audio.", + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1AudioDelta": { + "id": "GenaiVertexV1beta1AudioDelta", + "properties": { + "channels": { + "description": "The number of audio channels.", + "format": "int32", + "type": "integer" + }, + "data": { + "format": "byte", + "type": "string" + }, + "mime_type": { + "enum": [ + "TYPE_UNSPECIFIED", + "TYPE_WAV", + "TYPE_MP3", + "TYPE_AIFF", + "TYPE_AAC", + "TYPE_OGG", + "TYPE_FLAC", + "TYPE_MPEG", + "TYPE_M4A", + "TYPE_L16", + "TYPE_OPUS", + "TYPE_ALAW", + "TYPE_MULAW" + ], + "enumDescriptions": [ + "", + "WAV audio format", + "MP3 audio format", + "AIFF audio format", + "AAC audio format", + "OGG audio format", + "FLAC audio format", + "MPEG audio format", + "M4A audio format", + "L16 audio format", + "OPUS audio format", + "ALAW audio format", + "MULAW audio format" + ], + "type": "string" + }, + "rate": { + "deprecated": true, + "description": "Deprecated. Use sample_rate instead. The value is ignored.", + "format": "int32", + "type": "integer" + }, + "sample_rate": { + "description": "The sample rate of the audio.", + "format": "int32", + "type": "integer" + }, + "uri": { + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1AudioResponseFormat": { + "description": "Configuration for audio output format.", + "id": "GenaiVertexV1beta1AudioResponseFormat", + "properties": { + "bit_rate": { + "description": "Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus).", + "format": "int32", + "type": "integer" + }, + "delivery": { + "description": "The delivery mode for the audio output.", + "enum": [ + "DELIVERY_UNSPECIFIED", + "INLINE", + "URL" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Audio data is returned inline in the response.", + "Audio data is returned as a URL." + ], + "type": "string" + }, + "mime_type": { + "description": "The MIME type of the audio output.", + "enum": [ + "TYPE_UNSPECIFIED", + "TYPE_MP3", + "TYPE_OGG_OPUS", + "TYPE_L16", + "TYPE_WAV", + "TYPE_ALAW", + "TYPE_MULAW" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "MP3 audio format.", + "OGG Opus audio format.", + "Raw PCM (L16) audio format.", + "WAV audio format.", + "A-law audio format.", + "Mu-law audio format." + ], + "type": "string" + }, + "sample_rate": { + "description": "Sample rate in Hz.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1CodeExecution": { + "description": "A tool that can be used by the model to execute code.", + "id": "GenaiVertexV1beta1CodeExecution", + "properties": {}, + "type": "object" + }, + "GenaiVertexV1beta1CodeExecutionCallContent": { + "description": "Code execution content.", + "id": "GenaiVertexV1beta1CodeExecutionCallContent", + "properties": { + "arguments": { + "$ref": "GenaiVertexV1beta1CodeExecutionCallContentCodeExecutionCallArguments", + "description": "Required. The arguments to pass to the code execution." + } + }, + "type": "object" + }, + "GenaiVertexV1beta1CodeExecutionCallContentCodeExecutionCallArguments": { + "description": "The arguments to pass to the code execution.", + "id": "GenaiVertexV1beta1CodeExecutionCallContentCodeExecutionCallArguments", + "properties": { + "code": { + "description": "The code to be executed.", + "type": "string" + }, + "language": { + "description": "Programming language of the `code`.", + "enum": [ + "LANGUAGE_UNSPECIFIED", + "PYTHON" + ], + "enumDescriptions": [ + "Unspecified language. This value should not be used.", + "Python >= 3.10, with numpy and simpy available." + ], + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1CodeExecutionCallDelta": { + "id": "GenaiVertexV1beta1CodeExecutionCallDelta", + "properties": { + "arguments": { + "$ref": "GenaiVertexV1beta1CodeExecutionCallContentCodeExecutionCallArguments" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1CodeExecutionCallStep": { + "description": "Code execution call step.", + "id": "GenaiVertexV1beta1CodeExecutionCallStep", + "properties": { + "arguments": { + "$ref": "GenaiVertexV1beta1CodeExecutionCallStepCodeExecutionCallStepArguments", + "description": "Required. The arguments to pass to the code execution." + } + }, + "type": "object" + }, + "GenaiVertexV1beta1CodeExecutionCallStepCodeExecutionCallStepArguments": { + "description": "The arguments to pass to the code execution.", + "id": "GenaiVertexV1beta1CodeExecutionCallStepCodeExecutionCallStepArguments", + "properties": { + "code": { + "description": "The code to be executed.", + "type": "string" + }, + "language": { + "description": "Programming language of the `code`.", + "enum": [ + "LANGUAGE_UNSPECIFIED", + "PYTHON" + ], + "enumDescriptions": [ + "Unspecified language. This value should not be used.", + "Python >= 3.10, with numpy and simpy available." + ], + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1CodeExecutionResultContent": { + "description": "Code execution result content.", + "id": "GenaiVertexV1beta1CodeExecutionResultContent", + "properties": { + "is_error": { + "description": "Whether the code execution resulted in an error.", + "type": "boolean" + }, + "result": { + "description": "Required. The output of the code execution.", + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1CodeExecutionResultDelta": { + "id": "GenaiVertexV1beta1CodeExecutionResultDelta", + "properties": { + "is_error": { + "type": "boolean" + }, + "result": { + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1CodeExecutionResultStep": { + "description": "Code execution result step.", + "id": "GenaiVertexV1beta1CodeExecutionResultStep", + "properties": { + "is_error": { + "description": "Whether the code execution resulted in an error.", + "type": "boolean" + }, + "result": { + "description": "Required. The output of the code execution.", + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1ComputerUse": { + "description": "A tool that can be used by the model to interact with the computer.", + "id": "GenaiVertexV1beta1ComputerUse", + "properties": { + "environment": { + "description": "The environment being operated.", + "enum": [ + "ENVIRONMENT_UNSPECIFIED", + "BROWSER" + ], + "enumDescriptions": [ + "Defaults to browser.", + "Operates in a web browser." + ], + "type": "string" + }, + "excluded_predefined_functions": { + "description": "The list of predefined functions that are excluded from the model call.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1Content": { + "description": "The content of the response.", + "id": "GenaiVertexV1beta1Content", + "properties": { + "audio": { + "$ref": "GenaiVertexV1beta1AudioContent" + }, + "document": { + "$ref": "GenaiVertexV1beta1DocumentContent" + }, + "image": { + "$ref": "GenaiVertexV1beta1ImageContent" + }, + "text": { + "$ref": "GenaiVertexV1beta1TextContent" + }, + "thought": { + "$ref": "GenaiVertexV1beta1ThoughtContent", + "deprecated": true + }, + "toolCall": { + "$ref": "GenaiVertexV1beta1ToolCallContent", + "deprecated": true + }, + "toolResult": { + "$ref": "GenaiVertexV1beta1ToolResultContent", + "deprecated": true + }, + "video": { + "$ref": "GenaiVertexV1beta1VideoContent" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1ContentDelta": { + "id": "GenaiVertexV1beta1ContentDelta", + "properties": { + "delta": { + "$ref": "GenaiVertexV1beta1ContentDeltaData" + }, + "index": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1ContentDeltaData": { + "description": "The delta content data for a content block.", + "id": "GenaiVertexV1beta1ContentDeltaData", + "properties": { + "audio": { + "$ref": "GenaiVertexV1beta1AudioDelta" + }, + "document": { + "$ref": "GenaiVertexV1beta1DocumentDelta" + }, + "image": { + "$ref": "GenaiVertexV1beta1ImageDelta" + }, + "text": { + "$ref": "GenaiVertexV1beta1TextDelta" + }, + "textAnnotation": { + "$ref": "GenaiVertexV1beta1TextAnnotationDelta" + }, + "thoughtSignature": { + "$ref": "GenaiVertexV1beta1ThoughtSignatureDelta" + }, + "thoughtSummary": { + "$ref": "GenaiVertexV1beta1ThoughtSummaryDelta" + }, + "toolCall": { + "$ref": "GenaiVertexV1beta1ToolCallDelta" + }, + "toolResult": { + "$ref": "GenaiVertexV1beta1ToolResultDelta" + }, + "video": { + "$ref": "GenaiVertexV1beta1VideoDelta" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1ContentList": { + "description": "A list of Content.", + "id": "GenaiVertexV1beta1ContentList", + "properties": { + "contents": { + "description": "The contents of the list.", + "items": { + "$ref": "GenaiVertexV1beta1Content" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1ContentStart": { + "id": "GenaiVertexV1beta1ContentStart", + "properties": { + "content": { + "$ref": "GenaiVertexV1beta1Content" + }, + "index": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1ContentStop": { + "id": "GenaiVertexV1beta1ContentStop", + "properties": { + "index": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1CreateInteractionRequest": { + "description": "Configuration parameters for creating an interaction.", + "id": "GenaiVertexV1beta1CreateInteractionRequest", + "properties": { + "background": { + "description": "Input only. Whether to run the model interaction in the background.", + "type": "boolean" + }, + "interaction": { + "$ref": "GenaiVertexV1beta1Interaction", + "description": "The interaction to create." + }, + "store": { + "description": "Input only. Whether to store the response and request for later retrieval.", + "type": "boolean" + }, + "stream": { + "description": "Input only. Whether the interaction will be streamed.", + "type": "boolean" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1DeepResearchAgentConfig": { + "description": "Configuration for the Deep Research agent.", + "id": "GenaiVertexV1beta1DeepResearchAgentConfig", + "properties": { + "collaborative_planning": { + "description": "Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn.", + "type": "boolean" + }, + "thinking_summaries": { + "description": "Whether to include thought summaries in the response.", + "enum": [ + "THINKING_SUMMARIES_UNSPECIFIED", + "THINKING_SUMMARIES_AUTO", + "THINKING_SUMMARIES_NONE" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Auto thinking summaries.", + "No thinking summaries." + ], + "type": "string" + }, + "visualization": { + "description": "Whether to include visualizations in the response.", + "enum": [ + "UNSPECIFIED", + "OFF", + "AUTO" + ], + "enumDescriptions": [ + "The default visualization mode. Will default to AUTO.", + "Do not include visualizations.", + "Automatically include visualizations." + ], + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1DocumentContent": { + "description": "A document content block.", + "id": "GenaiVertexV1beta1DocumentContent", + "properties": { + "data": { + "description": "The document content.", + "format": "byte", + "type": "string" + }, + "mime_type": { + "description": "The mime type of the document.", + "enum": [ + "TYPE_UNSPECIFIED", + "TYPE_PDF" + ], + "enumDescriptions": [ + "", + "PDF document format" + ], + "type": "string" + }, + "uri": { + "description": "The URI of the document.", + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1DocumentDelta": { + "id": "GenaiVertexV1beta1DocumentDelta", + "properties": { + "data": { + "format": "byte", + "type": "string" + }, + "mime_type": { + "enum": [ + "TYPE_UNSPECIFIED", + "TYPE_PDF" + ], + "enumDescriptions": [ + "", + "PDF document format" + ], + "type": "string" + }, + "uri": { + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1DynamicAgentConfig": { + "description": "Configuration for dynamic agents.", + "id": "GenaiVertexV1beta1DynamicAgentConfig", + "properties": { + "config": { + "$ref": "GenaiStruct", + "description": "For agents that are not supported statically in the API definition." + } + }, + "type": "object" + }, + "GenaiVertexV1beta1Error": { + "description": "Error message from an interaction.", + "id": "GenaiVertexV1beta1Error", + "properties": { + "code": { + "description": "A URI that identifies the error type.", + "type": "string" + }, + "message": { + "description": "A human-readable error message.", + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1ErrorEvent": { + "id": "GenaiVertexV1beta1ErrorEvent", + "properties": { + "error": { + "$ref": "GenaiVertexV1beta1Error" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1FileCitation": { + "description": "A file citation annotation.", + "id": "GenaiVertexV1beta1FileCitation", + "properties": { + "custom_metadata": { + "$ref": "GenaiStruct", + "description": "User provided metadata about the retrieved context." + }, + "document_uri": { + "description": "The URI of the file.", + "type": "string" + }, + "file_name": { + "description": "The name of the file.", + "type": "string" + }, + "media_id": { + "description": "Media ID in-case of image citations, if applicable.", + "type": "string" + }, + "page_number": { + "description": "Page number of the cited document, if applicable.", + "format": "int32", + "type": "integer" + }, + "source": { + "description": "Source attributed for a portion of the text.", + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1FileSearch": { + "description": "A tool that can be used by the model to search files.", + "id": "GenaiVertexV1beta1FileSearch", + "properties": { + "file_search_store_names": { + "description": "The file search store names to search.", + "items": { + "type": "string" + }, + "type": "array" + }, + "metadata_filter": { + "description": "Metadata filter to apply to the semantic retrieval documents and chunks.", + "type": "string" + }, + "top_k": { + "description": "The number of semantic retrieval chunks to retrieve.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1FileSearchCallContent": { + "description": "File Search content.", + "id": "GenaiVertexV1beta1FileSearchCallContent", + "properties": {}, + "type": "object" + }, + "GenaiVertexV1beta1FileSearchCallDelta": { + "id": "GenaiVertexV1beta1FileSearchCallDelta", + "properties": {}, + "type": "object" + }, + "GenaiVertexV1beta1FileSearchCallStep": { + "description": "File Search call step.", + "id": "GenaiVertexV1beta1FileSearchCallStep", + "properties": {}, + "type": "object" + }, + "GenaiVertexV1beta1FileSearchResultContent": { + "description": "File Search result content.", + "id": "GenaiVertexV1beta1FileSearchResultContent", + "properties": { + "result": { + "description": "Optional. The results of the File Search.", + "items": { + "$ref": "GenaiVertexV1beta1FileSearchResultContentFileSearchResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1FileSearchResultContentFileSearchResult": { + "description": "The result of the File Search.", + "id": "GenaiVertexV1beta1FileSearchResultContentFileSearchResult", + "properties": {}, + "type": "object" + }, + "GenaiVertexV1beta1FileSearchResultDelta": { + "id": "GenaiVertexV1beta1FileSearchResultDelta", + "properties": { + "result": { + "items": { + "$ref": "GenaiVertexV1beta1FileSearchResultContentFileSearchResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1FileSearchResultStep": { + "description": "File Search result step.", + "id": "GenaiVertexV1beta1FileSearchResultStep", + "properties": {}, + "type": "object" + }, + "GenaiVertexV1beta1Function": { + "description": "A tool that can be used by the model.", + "id": "GenaiVertexV1beta1Function", + "properties": { + "description": { + "description": "A description of the function.", + "type": "string" + }, + "name": { + "description": "The name of the function.", + "type": "string" + }, + "parameters": { + "$ref": "GenaiValue", + "description": "The JSON Schema for the function's parameters." + } + }, + "type": "object" + }, + "GenaiVertexV1beta1FunctionCallContent": { + "description": "A function tool call content block.", + "id": "GenaiVertexV1beta1FunctionCallContent", + "properties": { + "arguments": { + "$ref": "GenaiStruct", + "description": "Required. The arguments to pass to the function." + }, + "name": { + "description": "Required. The name of the tool to call.", + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1FunctionCallDelta": { + "id": "GenaiVertexV1beta1FunctionCallDelta", + "properties": { + "arguments": { + "$ref": "GenaiStruct" + }, + "name": { + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1FunctionCallStep": { + "description": "A function tool call step.", + "id": "GenaiVertexV1beta1FunctionCallStep", + "properties": { + "arguments": { + "$ref": "GenaiStruct", + "description": "Required. The arguments to pass to the function." + }, + "name": { + "description": "Required. The name of the tool to call.", + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1FunctionResultContent": { + "description": "A function tool result content block.", + "id": "GenaiVertexV1beta1FunctionResultContent", + "properties": { + "contentList": { + "$ref": "GenaiVertexV1beta1FunctionResultSubcontentList" + }, + "is_error": { + "description": "Whether the tool call resulted in an error.", + "type": "boolean" + }, + "name": { + "description": "The name of the tool that was called.", + "type": "string" + }, + "stringResult": { + "type": "string" + }, + "structResult": { + "$ref": "GenaiStruct" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1FunctionResultDelta": { + "id": "GenaiVertexV1beta1FunctionResultDelta", + "properties": { + "contentList": { + "$ref": "GenaiVertexV1beta1FunctionResultSubcontentList" + }, + "is_error": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "stringResult": { + "type": "string" + }, + "structResult": { + "$ref": "GenaiStruct" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1FunctionResultStep": { + "description": "Result of a function tool call.", + "id": "GenaiVertexV1beta1FunctionResultStep", + "properties": { + "contentList": { + "$ref": "GenaiVertexV1beta1FunctionResultSubcontentList" + }, + "is_error": { + "description": "Whether the tool call resulted in an error.", + "type": "boolean" + }, + "name": { + "description": "The name of the tool that was called.", + "type": "string" + }, + "stringResult": { + "type": "string" + }, + "structResult": { + "$ref": "GenaiStruct" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1FunctionResultSubcontent": { + "id": "GenaiVertexV1beta1FunctionResultSubcontent", + "properties": { + "image": { + "$ref": "GenaiVertexV1beta1ImageContent" + }, + "text": { + "$ref": "GenaiVertexV1beta1TextContent" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1FunctionResultSubcontentList": { + "id": "GenaiVertexV1beta1FunctionResultSubcontentList", + "properties": { + "contents": { + "items": { + "$ref": "GenaiVertexV1beta1FunctionResultSubcontent" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1GenerationConfig": { + "description": "Configuration parameters for model interactions.", + "id": "GenaiVertexV1beta1GenerationConfig", + "properties": { + "image_config": { + "$ref": "GenaiVertexV1beta1ImageConfig", + "description": "Configuration for image interaction." + }, + "max_output_tokens": { + "description": "The maximum number of tokens to include in the response.", + "format": "int32", + "type": "integer" + }, + "seed": { + "description": "Seed used in decoding for reproducibility.", + "format": "int32", + "type": "integer" + }, + "speech_config": { + "description": "Configuration for speech interaction.", + "items": { + "$ref": "GenaiVertexV1beta1SpeechConfig" + }, + "type": "array" + }, + "stop_sequences": { + "description": "A list of character sequences that will stop output interaction.", + "items": { + "type": "string" + }, + "type": "array" + }, + "temperature": { + "description": "Controls the randomness of the output.", + "format": "float", + "type": "number" + }, + "thinking_level": { + "description": "The level of thought tokens that the model should generate.", + "enum": [ + "THINKING_LEVEL_UNSPECIFIED", + "THINKING_LEVEL_MINIMAL", + "THINKING_LEVEL_LOW", + "THINKING_LEVEL_MEDIUM", + "THINKING_LEVEL_HIGH" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Little to no thinking.", + "Low thinking level.", + "Medium thinking level.", + "High thinking level." + ], + "type": "string" + }, + "thinking_summaries": { + "description": "Whether to include thought summaries in the response.", + "enum": [ + "THINKING_SUMMARIES_UNSPECIFIED", + "THINKING_SUMMARIES_AUTO", + "THINKING_SUMMARIES_NONE" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Auto thinking summaries.", + "No thinking summaries." + ], + "type": "string" + }, + "toolChoiceConfig": { + "$ref": "GenaiVertexV1beta1ToolChoiceConfig", + "description": "The config for the tool choice." + }, + "toolChoiceMode": { + "description": "The mode of the tool choice.", + "enum": [ + "TOOL_CHOICE_TYPE_UNSPECIFIED", + "AUTO", + "ANY", + "NONE", + "VALIDATED" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Auto tool choice.", + "Any tool choice.", + "No tool choice.", + "Validated tool choice." + ], + "type": "string" + }, + "top_p": { + "description": "The maximum cumulative probability of tokens to consider when sampling.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1GoogleMaps": { + "description": "A tool that can be used by the model to call Google Maps.", + "id": "GenaiVertexV1beta1GoogleMaps", + "properties": { + "enable_widget": { + "description": "Whether to return a widget context token in the tool call result of the response.", + "type": "boolean" + }, + "latitude": { + "description": "The latitude of the user's location.", + "format": "double", + "type": "number" + }, + "longitude": { + "description": "The longitude of the user's location.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1GoogleMapsCallContent": { + "description": "Google Maps content.", + "id": "GenaiVertexV1beta1GoogleMapsCallContent", + "properties": { + "arguments": { + "$ref": "GenaiVertexV1beta1GoogleMapsCallContentGoogleMapsCallArguments", + "description": "The arguments to pass to the Google Maps tool." + } + }, + "type": "object" + }, + "GenaiVertexV1beta1GoogleMapsCallContentGoogleMapsCallArguments": { + "description": "The arguments to pass to the Google Maps tool.", + "id": "GenaiVertexV1beta1GoogleMapsCallContentGoogleMapsCallArguments", + "properties": { + "queries": { + "description": "The queries to be executed.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1GoogleMapsCallDelta": { + "id": "GenaiVertexV1beta1GoogleMapsCallDelta", + "properties": { + "arguments": { + "$ref": "GenaiVertexV1beta1GoogleMapsCallContentGoogleMapsCallArguments", + "description": "The arguments to pass to the Google Maps tool." + } + }, + "type": "object" + }, + "GenaiVertexV1beta1GoogleMapsCallStep": { + "description": "Google Maps call step.", + "id": "GenaiVertexV1beta1GoogleMapsCallStep", + "properties": { + "arguments": { + "$ref": "GenaiVertexV1beta1GoogleMapsCallStepGoogleMapsCallStepArguments", + "description": "The arguments to pass to the Google Maps tool." + } + }, + "type": "object" + }, + "GenaiVertexV1beta1GoogleMapsCallStepGoogleMapsCallStepArguments": { + "description": "The arguments to pass to the Google Maps tool.", + "id": "GenaiVertexV1beta1GoogleMapsCallStepGoogleMapsCallStepArguments", + "properties": { + "queries": { + "description": "The queries to be executed.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1GoogleMapsResultContent": { + "description": "Google Maps result content.", + "id": "GenaiVertexV1beta1GoogleMapsResultContent", + "properties": { + "result": { + "description": "Required. The results of the Google Maps.", + "items": { + "$ref": "GenaiVertexV1beta1GoogleMapsResultContentGoogleMapsResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1GoogleMapsResultContentGoogleMapsResult": { + "description": "The result of the Google Maps.", + "id": "GenaiVertexV1beta1GoogleMapsResultContentGoogleMapsResult", + "properties": { + "places": { + "description": "The places that were found.", + "items": { + "$ref": "GenaiVertexV1beta1GoogleMapsResultContentGoogleMapsResultPlaces" + }, + "type": "array" + }, + "widget_context_token": { + "description": "Resource name of the Google Maps widget context token.", + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1GoogleMapsResultContentGoogleMapsResultPlaces": { + "id": "GenaiVertexV1beta1GoogleMapsResultContentGoogleMapsResultPlaces", + "properties": { + "name": { + "description": "Title of the place.", + "type": "string" + }, + "place_id": { + "description": "The ID of the place, in `places/{place_id}` format.", + "type": "string" + }, + "review_snippets": { + "description": "Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.", + "items": { + "$ref": "GenaiVertexV1beta1ReviewSnippet" + }, + "type": "array" + }, + "url": { + "description": "URI reference of the place.", + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1GoogleMapsResultDelta": { + "id": "GenaiVertexV1beta1GoogleMapsResultDelta", + "properties": { + "result": { + "description": "The results of the Google Maps.", + "items": { + "$ref": "GenaiVertexV1beta1GoogleMapsResultContentGoogleMapsResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1GoogleMapsResultStep": { + "description": "Google Maps result step.", + "id": "GenaiVertexV1beta1GoogleMapsResultStep", + "properties": { + "result": { + "items": { + "$ref": "GenaiVertexV1beta1GoogleMapsResultStepGoogleMapsResultItem" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1GoogleMapsResultStepGoogleMapsResultItem": { + "description": "The result of the Google Maps.", + "id": "GenaiVertexV1beta1GoogleMapsResultStepGoogleMapsResultItem", + "properties": { + "places": { + "items": { + "$ref": "GenaiVertexV1beta1GoogleMapsResultStepGoogleMapsResultItemGoogleMapsResultPlaces" + }, + "type": "array" + }, + "widget_context_token": { + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1GoogleMapsResultStepGoogleMapsResultItemGoogleMapsResultPlaces": { + "id": "GenaiVertexV1beta1GoogleMapsResultStepGoogleMapsResultItemGoogleMapsResultPlaces", + "properties": { + "name": { + "type": "string" + }, + "place_id": { + "type": "string" + }, + "review_snippets": { + "items": { + "$ref": "GenaiVertexV1beta1ReviewSnippet" + }, + "type": "array" + }, + "url": { + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1GoogleSearch": { + "description": "A tool that can be used by the model to search Google.", + "id": "GenaiVertexV1beta1GoogleSearch", + "properties": { + "search_types": { + "description": "The types of search grounding to enable.", + "items": { + "enum": [ + "SEARCH_TYPE_UNSPECIFIED", + "SEARCH_TYPE_WEB_SEARCH", + "SEARCH_TYPE_IMAGE_SEARCH", + "SEARCH_TYPE_ENTERPRISE_WEB_SEARCH" + ], + "enumDescriptions": [ + "Unspecified search type. This value should not be used.", + "Setting this field enables web search. Only text results are returned.", + "Setting this field enables image search. Image bytes are returned.", + "Setting this field enables enterprise web search." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1GoogleSearchCallContent": { + "description": "Google Search content.", + "id": "GenaiVertexV1beta1GoogleSearchCallContent", + "properties": { + "arguments": { + "$ref": "GenaiVertexV1beta1GoogleSearchCallContentGoogleSearchCallArguments", + "description": "Required. The arguments to pass to Google Search." + }, + "search_type": { + "description": "The type of search grounding enabled.", + "enum": [ + "SEARCH_TYPE_UNSPECIFIED", + "SEARCH_TYPE_WEB_SEARCH", + "SEARCH_TYPE_IMAGE_SEARCH", + "SEARCH_TYPE_ENTERPRISE_WEB_SEARCH" + ], + "enumDescriptions": [ + "Unspecified search type. This value should not be used.", + "Setting this field enables web search. Only text results are returned.", + "Setting this field enables image search. Image bytes are returned.", + "Setting this field enables enterprise web search." + ], + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1GoogleSearchCallContentGoogleSearchCallArguments": { + "description": "The arguments to pass to Google Search.", + "id": "GenaiVertexV1beta1GoogleSearchCallContentGoogleSearchCallArguments", + "properties": { + "queries": { + "description": "Web search queries for the following-up web search.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1GoogleSearchCallDelta": { + "id": "GenaiVertexV1beta1GoogleSearchCallDelta", + "properties": { + "arguments": { + "$ref": "GenaiVertexV1beta1GoogleSearchCallContentGoogleSearchCallArguments" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1GoogleSearchCallStep": { + "description": "Google Search call step.", + "id": "GenaiVertexV1beta1GoogleSearchCallStep", + "properties": { + "arguments": { + "$ref": "GenaiVertexV1beta1GoogleSearchCallStepGoogleSearchCallStepArguments", + "description": "Required. The arguments to pass to Google Search." + }, + "search_type": { + "description": "The type of search grounding enabled.", + "enum": [ + "SEARCH_TYPE_UNSPECIFIED", + "SEARCH_TYPE_WEB_SEARCH", + "SEARCH_TYPE_IMAGE_SEARCH", + "SEARCH_TYPE_ENTERPRISE_WEB_SEARCH" + ], + "enumDescriptions": [ + "Unspecified search type. This value should not be used.", + "Setting this field enables web search. Only text results are returned.", + "Setting this field enables image search. Image bytes are returned.", + "Setting this field enables enterprise web search." + ], + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1GoogleSearchCallStepGoogleSearchCallStepArguments": { + "description": "The arguments to pass to Google Search.", + "id": "GenaiVertexV1beta1GoogleSearchCallStepGoogleSearchCallStepArguments", + "properties": { + "queries": { + "description": "Web search queries for the following-up web search.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1GoogleSearchResultContent": { + "description": "Google Search result content.", + "id": "GenaiVertexV1beta1GoogleSearchResultContent", + "properties": { + "is_error": { + "description": "Whether the Google Search resulted in an error.", + "type": "boolean" + }, + "result": { + "description": "Required. The results of the Google Search.", + "items": { + "$ref": "GenaiVertexV1beta1GoogleSearchResultContentGoogleSearchResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1GoogleSearchResultContentGoogleSearchResult": { + "description": "The result of the Google Search.", + "id": "GenaiVertexV1beta1GoogleSearchResultContentGoogleSearchResult", + "properties": { + "search_suggestions": { + "description": "Web content snippet that can be embedded in a web page or an app webview.", + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1GoogleSearchResultDelta": { + "id": "GenaiVertexV1beta1GoogleSearchResultDelta", + "properties": { + "is_error": { + "type": "boolean" + }, + "result": { + "items": { + "$ref": "GenaiVertexV1beta1GoogleSearchResultContentGoogleSearchResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1GoogleSearchResultStep": { + "description": "Google Search result step.", + "id": "GenaiVertexV1beta1GoogleSearchResultStep", + "properties": { + "is_error": { + "description": "Whether the Google Search resulted in an error.", + "type": "boolean" + }, + "result": { + "description": "Required. The results of the Google Search.", + "items": { + "$ref": "GenaiVertexV1beta1GoogleSearchResultStepGoogleSearchResultItem" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1GoogleSearchResultStepGoogleSearchResultItem": { + "description": "The result of the Google Search.", + "id": "GenaiVertexV1beta1GoogleSearchResultStepGoogleSearchResultItem", + "properties": { + "search_suggestions": { + "description": "Web content snippet that can be embedded in a web page or an app webview.", + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1ImageConfig": { + "description": "The configuration for image interaction.", + "id": "GenaiVertexV1beta1ImageConfig", + "properties": { + "aspect_ratio": { + "description": "The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided.", + "type": "string" + }, + "image_size": { + "description": "Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`.", + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1ImageContent": { + "description": "An image content block.", + "id": "GenaiVertexV1beta1ImageContent", + "properties": { + "data": { + "description": "The image content.", + "format": "byte", + "type": "string" + }, + "mime_type": { + "description": "The mime type of the image.", + "enum": [ + "TYPE_UNSPECIFIED", + "TYPE_PNG", + "TYPE_JPEG", + "TYPE_WEBP", + "TYPE_HEIC", + "TYPE_HEIF", + "TYPE_GIF", + "TYPE_BMP", + "TYPE_TIFF" + ], + "enumDescriptions": [ + "", + "PNG image format", + "JPEG image format", + "WebP image format", + "HEIC image format", + "HEIF image format", + "GIF image format", + "BMP image format", + "TIFF image format" + ], + "type": "string" + }, + "resolution": { + "description": "The resolution of the media.", + "enum": [ + "MEDIA_RESOLUTION_UNSPECIFIED", + "LOW", + "MEDIUM", + "HIGH", + "ULTRA_HIGH" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Low resolution.", + "Medium resolution.", + "High resolution.", + "Ultra high resolution." + ], + "type": "string" + }, + "uri": { + "description": "The URI of the image.", + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1ImageDelta": { + "id": "GenaiVertexV1beta1ImageDelta", + "properties": { + "data": { + "format": "byte", + "type": "string" + }, + "mime_type": { + "enum": [ + "TYPE_UNSPECIFIED", + "TYPE_PNG", + "TYPE_JPEG", + "TYPE_WEBP", + "TYPE_HEIC", + "TYPE_HEIF", + "TYPE_GIF", + "TYPE_BMP", + "TYPE_TIFF" + ], + "enumDescriptions": [ + "", + "PNG image format", + "JPEG image format", + "WebP image format", + "HEIC image format", + "HEIF image format", + "GIF image format", + "BMP image format", + "TIFF image format" + ], + "type": "string" + }, + "resolution": { + "description": "The resolution of the media.", + "enum": [ + "MEDIA_RESOLUTION_UNSPECIFIED", + "LOW", + "MEDIUM", + "HIGH", + "ULTRA_HIGH" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Low resolution.", + "Medium resolution.", + "High resolution.", + "Ultra high resolution." + ], + "type": "string" + }, + "uri": { + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1ImageResponseFormat": { + "description": "Configuration for image output format.", + "id": "GenaiVertexV1beta1ImageResponseFormat", + "properties": { + "aspect_ratio": { + "description": "The aspect ratio for the image output.", + "enum": [ + "ASPECT_RATIO_UNSPECIFIED", + "ASPECT_RATIO_ONE_BY_ONE", + "ASPECT_RATIO_TWO_BY_THREE", + "ASPECT_RATIO_THREE_BY_TWO", + "ASPECT_RATIO_THREE_BY_FOUR", + "ASPECT_RATIO_FOUR_BY_THREE", + "ASPECT_RATIO_FOUR_BY_FIVE", + "ASPECT_RATIO_FIVE_BY_FOUR", + "ASPECT_RATIO_NINE_BY_SIXTEEN", + "ASPECT_RATIO_SIXTEEN_BY_NINE", + "ASPECT_RATIO_TWENTY_ONE_BY_NINE", + "ASPECT_RATIO_ONE_BY_EIGHT", + "ASPECT_RATIO_EIGHT_BY_ONE", + "ASPECT_RATIO_ONE_BY_FOUR", + "ASPECT_RATIO_FOUR_BY_ONE" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "1:1 aspect ratio.", + "2:3 aspect ratio.", + "3:2 aspect ratio.", + "3:4 aspect ratio.", + "4:3 aspect ratio.", + "4:5 aspect ratio.", + "5:4 aspect ratio.", + "9:16 aspect ratio.", + "16:9 aspect ratio.", + "21:9 aspect ratio.", + "1:8 aspect ratio.", + "8:1 aspect ratio.", + "1:4 aspect ratio.", + "4:1 aspect ratio." + ], + "type": "string" + }, + "delivery": { + "description": "The delivery mode for the image output.", + "enum": [ + "DELIVERY_UNSPECIFIED", + "INLINE", + "URL" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Image data is returned inline in the response.", + "Image data is returned as a URL." + ], + "type": "string" + }, + "image_size": { + "description": "The size of the image output.", + "enum": [ + "IMAGE_SIZE_UNSPECIFIED", + "IMAGE_SIZE_FIVE_TWELVE", + "IMAGE_SIZE_ONE_K", + "IMAGE_SIZE_TWO_K", + "IMAGE_SIZE_FOUR_K" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "512px image size.", + "1K image size.", + "2K image size.", + "4K image size." + ], + "type": "string" + }, + "mime_type": { + "description": "The MIME type of the image output.", + "enum": [ + "TYPE_UNSPECIFIED", + "TYPE_JPEG" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "JPEG image format." + ], + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1Interaction": { + "description": "Response for InteractionService.CreateInteraction.", + "id": "GenaiVertexV1beta1Interaction", + "properties": { + "agentInteraction": { + "$ref": "GenaiVertexV1beta1AgentInteraction", + "description": "Interaction for generating the completion using agents." + }, + "content": { + "$ref": "GenaiVertexV1beta1Content", + "description": "The content for the interaction." + }, + "contentList": { + "$ref": "GenaiVertexV1beta1ContentList", + "deprecated": true, + "description": "The inputs for the interaction." + }, + "created": { + "description": "Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Required. Output only. A unique identifier for the interaction completion.", + "readOnly": true, + "type": "string" + }, + "modelInteraction": { + "$ref": "GenaiVertexV1beta1ModelInteraction", + "description": "Interaction for generating the completion using models." + }, + "outputs": { + "deprecated": true, + "description": "Output only. Responses from the model.", + "items": { + "$ref": "GenaiVertexV1beta1Content" + }, + "readOnly": true, + "type": "array" + }, + "previous_interaction_id": { + "description": "The ID of the previous interaction, if any.", + "type": "string" + }, + "responseFormatList": { + "$ref": "GenaiVertexV1beta1ResponseFormatList" + }, + "responseFormatSingleton": { + "$ref": "GenaiVertexV1beta1ResponseFormat" + }, + "response_format": { + "$ref": "GenaiValue", + "deprecated": true, + "description": "Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field." + }, + "response_mime_type": { + "description": "The mime type of the response. This is required if response_format is set.", + "type": "string" + }, + "response_modalities": { + "description": "The requested modalities of the response (TEXT, IMAGE, AUDIO).", + "items": { + "enum": [ + "RESPONSE_MODALITY_UNSPECIFIED", + "TEXT", + "IMAGE", + "AUDIO", + "VIDEO", + "DOCUMENT" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Indicates the model should return text.", + "Indicates the model should return images.", + "Indicates the model should return audio.", + "Indicates the model should return video.", + "Indicates the model should return documents." + ], + "type": "string" + }, + "type": "array" + }, + "role": { + "deprecated": true, + "description": "Output only. The role of the interaction.", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "Required. Output only. The status of the interaction.", + "enum": [ + "UNSPECIFIED", + "IN_PROGRESS", + "REQUIRES_ACTION", + "COMPLETED", + "FAILED", + "CANCELLED", + "INCOMPLETE" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "The interaction is in progress.", + "The interaction requires action/input from the user.", + "The interaction is completed.", + "The interaction failed.", + "The interaction was cancelled.", + "The interaction is completed, but contains incomplete results (e.g. hitting max_tokens)." + ], + "readOnly": true, + "type": "string" + }, + "stepList": { + "$ref": "GenaiVertexV1beta1StepList", + "description": "Input only. The steps for the interaction." + }, + "steps": { + "description": "Output only. The steps that make up the interaction.", + "items": { + "$ref": "GenaiVertexV1beta1Step" + }, + "readOnly": true, + "type": "array" + }, + "stringContent": { + "description": "A string input for the interaction, it will be processed as a single text input.", + "type": "string" + }, + "system_instruction": { + "description": "System instruction for the interaction.", + "type": "string" + }, + "tools": { + "description": "A list of tool declarations the model may call during interaction.", + "items": { + "$ref": "GenaiVertexV1beta1Tool" + }, + "type": "array" + }, + "turnList": { + "$ref": "GenaiVertexV1beta1TurnList", + "deprecated": true, + "description": "The turns for the interaction." + }, + "updated": { + "description": "Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).", + "readOnly": true, + "type": "string" + }, + "usage": { + "$ref": "GenaiVertexV1beta1InteractionUsage", + "description": "Output only. Statistics on the interaction request's token usage.", + "readOnly": true + } + }, + "type": "object" + }, + "GenaiVertexV1beta1InteractionCompleteEvent": { + "deprecated": true, + "id": "GenaiVertexV1beta1InteractionCompleteEvent", + "properties": { + "interaction": { + "$ref": "GenaiVertexV1beta1Interaction", + "description": "Required. The completed interaction with empty outputs to reduce the payload size. Use the preceding ContentDelta events for the actual output." + } + }, + "type": "object" + }, + "GenaiVertexV1beta1InteractionCompletedSseEvent": { + "id": "GenaiVertexV1beta1InteractionCompletedSseEvent", + "properties": { + "interaction": { + "$ref": "GenaiVertexV1beta1Interaction", + "description": "Required. The completed interaction with empty outputs to reduce the payload size. Use the preceding ContentDelta events for the actual output." + } + }, + "type": "object" + }, + "GenaiVertexV1beta1InteractionCreatedSseEvent": { + "id": "GenaiVertexV1beta1InteractionCreatedSseEvent", + "properties": { + "interaction": { + "$ref": "GenaiVertexV1beta1Interaction" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1InteractionStartEvent": { + "deprecated": true, + "id": "GenaiVertexV1beta1InteractionStartEvent", + "properties": { + "interaction": { + "$ref": "GenaiVertexV1beta1Interaction" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1InteractionStatusUpdate": { + "id": "GenaiVertexV1beta1InteractionStatusUpdate", + "properties": { + "interaction_id": { + "type": "string" + }, + "status": { + "enum": [ + "UNSPECIFIED", + "IN_PROGRESS", + "REQUIRES_ACTION", + "COMPLETED", + "FAILED", + "CANCELLED", + "INCOMPLETE" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "The interaction is in progress.", + "The interaction requires action/input from the user.", + "The interaction is completed.", + "The interaction failed.", + "The interaction was cancelled.", + "The interaction is completed, but contains incomplete results (e.g. hitting max_tokens)." + ], + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1InteractionStreamingEvent": { + "id": "GenaiVertexV1beta1InteractionStreamingEvent", + "properties": { + "contentDelta": { + "$ref": "GenaiVertexV1beta1ContentDelta", + "description": "The content block delta data, used for content.delta events." + }, + "contentStart": { + "$ref": "GenaiVertexV1beta1ContentStart", + "description": "The content block start data, used for content.start events." + }, + "contentStop": { + "$ref": "GenaiVertexV1beta1ContentStop", + "description": "The content block stop data, used for content.stop events." + }, + "errorEvent": { + "$ref": "GenaiVertexV1beta1ErrorEvent", + "description": "The error event data, used for error events." + }, + "event_id": { + "description": "The event_id token to be used to resume the interaction stream, from this event.", + "type": "string" + }, + "interactionCompleteEvent": { + "$ref": "GenaiVertexV1beta1InteractionCompleteEvent", + "deprecated": true, + "description": "The interaction data, used for interaction.complete events." + }, + "interactionCompletedEvent": { + "$ref": "GenaiVertexV1beta1InteractionCompletedSseEvent", + "description": "The interaction data, used for interaction.completed events." + }, + "interactionCreatedEvent": { + "$ref": "GenaiVertexV1beta1InteractionCreatedSseEvent", + "description": "The interaction data, used for interaction.created events." + }, + "interactionStartEvent": { + "$ref": "GenaiVertexV1beta1InteractionStartEvent", + "deprecated": true, + "description": "The interaction data, used for interaction.start events." + }, + "interactionStatusUpdate": { + "$ref": "GenaiVertexV1beta1InteractionStatusUpdate", + "description": "The interaction status data, used for interaction.status_update events." + }, + "stepDelta": { + "$ref": "GenaiVertexV1beta1StepDelta", + "description": "The step delta data, used for step.delta events." + }, + "stepStart": { + "$ref": "GenaiVertexV1beta1StepStart", + "description": "The step start data, used for step.start events." + }, + "stepStop": { + "$ref": "GenaiVertexV1beta1StepStop", + "description": "The step stop data, used for step.stop events." + } + }, + "type": "object" + }, + "GenaiVertexV1beta1InteractionUsage": { + "description": "Statistics on the interaction request's token usage.", + "id": "GenaiVertexV1beta1InteractionUsage", + "properties": { + "cached_tokens_by_modality": { + "description": "A breakdown of cached token usage by modality.", + "items": { + "$ref": "GenaiVertexV1beta1InteractionUsageModalityTokens" + }, + "type": "array" + }, + "grounding_tool_count": { + "description": "Grounding tool count.", + "items": { + "$ref": "GenaiVertexV1beta1InteractionUsageGroundingToolCount" + }, + "type": "array" + }, + "input_tokens_by_modality": { + "description": "A breakdown of input token usage by modality.", + "items": { + "$ref": "GenaiVertexV1beta1InteractionUsageModalityTokens" + }, + "type": "array" + }, + "output_tokens_by_modality": { + "description": "A breakdown of output token usage by modality.", + "items": { + "$ref": "GenaiVertexV1beta1InteractionUsageModalityTokens" + }, + "type": "array" + }, + "tool_use_tokens_by_modality": { + "description": "A breakdown of tool-use token usage by modality.", + "items": { + "$ref": "GenaiVertexV1beta1InteractionUsageModalityTokens" + }, + "type": "array" + }, + "total_cached_tokens": { + "description": "Number of tokens in the cached part of the prompt (the cached content).", + "format": "int32", + "type": "integer" + }, + "total_input_tokens": { + "description": "Number of tokens in the prompt (context).", + "format": "int32", + "type": "integer" + }, + "total_output_tokens": { + "description": "Total number of tokens across all the generated responses.", + "format": "int32", + "type": "integer" + }, + "total_thought_tokens": { + "description": "Number of tokens of thoughts for thinking models.", + "format": "int32", + "type": "integer" + }, + "total_tokens": { + "description": "Total token count for the interaction request (prompt + responses + other internal tokens).", + "format": "int32", + "type": "integer" + }, + "total_tool_use_tokens": { + "description": "Number of tokens present in tool-use prompt(s).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1InteractionUsageGroundingToolCount": { + "description": "The number of grounding tool counts.", + "id": "GenaiVertexV1beta1InteractionUsageGroundingToolCount", + "properties": { + "count": { + "description": "The number of grounding tool counts.", + "format": "int32", + "type": "integer" + }, + "type": { + "description": "The grounding tool type associated with the count.", + "enum": [ + "TYPE_UNSPECIFIED", + "GOOGLE_SEARCH", + "GOOGLE_MAPS", + "RETRIEVAL" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Grounding with Google Web Search and Image Search, & Web Grounding for Enterprise.", + "Grounding with Google Maps.", + "Grounding with customer's data, for example, VertexAISearch." + ], + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1InteractionUsageModalityTokens": { + "description": "The token count for a single response modality.", + "id": "GenaiVertexV1beta1InteractionUsageModalityTokens", + "properties": { + "modality": { + "description": "The modality associated with the token count.", + "enum": [ + "RESPONSE_MODALITY_UNSPECIFIED", + "TEXT", + "IMAGE", + "AUDIO", + "VIDEO", + "DOCUMENT" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Indicates the model should return text.", + "Indicates the model should return images.", + "Indicates the model should return audio.", + "Indicates the model should return video.", + "Indicates the model should return documents." + ], + "type": "string" + }, + "tokens": { + "description": "Number of tokens for the modality.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1McpServer": { + "description": "A MCPServer is a server that can be called by the model to perform actions.", + "id": "GenaiVertexV1beta1McpServer", + "properties": { + "allowed_tools": { + "description": "The allowed tools.", + "items": { + "$ref": "GenaiVertexV1beta1AllowedTools" + }, + "type": "array" + }, + "headers": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional: Fields for authentication headers, timeouts, etc., if needed.", + "type": "object" + }, + "name": { + "description": "The name of the MCPServer.", + "type": "string" + }, + "url": { + "description": "The full URL for the MCPServer endpoint. Example: \"https://api.example.com/mcp\"", + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1McpServerToolCallContent": { + "description": "MCPServer tool call content.", + "id": "GenaiVertexV1beta1McpServerToolCallContent", + "properties": { + "arguments": { + "$ref": "GenaiStruct", + "description": "Required. The JSON object of arguments for the function." + }, + "name": { + "description": "Required. The name of the tool which was called.", + "type": "string" + }, + "server_name": { + "description": "Required. The name of the used MCP server.", + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1McpServerToolCallDelta": { + "id": "GenaiVertexV1beta1McpServerToolCallDelta", + "properties": { + "arguments": { + "$ref": "GenaiStruct" + }, + "name": { + "type": "string" + }, + "server_name": { + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1McpServerToolCallStep": { + "description": "MCPServer tool call step.", + "id": "GenaiVertexV1beta1McpServerToolCallStep", + "properties": { + "arguments": { + "$ref": "GenaiStruct", + "description": "Required. The JSON object of arguments for the function." + }, + "name": { + "description": "Required. The name of the tool which was called.", + "type": "string" + }, + "server_name": { + "description": "Required. The name of the used MCP server.", + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1McpServerToolResultContent": { + "description": "MCPServer tool result content.", + "id": "GenaiVertexV1beta1McpServerToolResultContent", + "properties": { + "contentList": { + "$ref": "GenaiVertexV1beta1FunctionResultSubcontentList" + }, + "name": { + "description": "Name of the tool which is called for this specific tool call.", + "type": "string" + }, + "server_name": { + "description": "The name of the used MCP server.", + "type": "string" + }, + "stringResult": { + "type": "string" + }, + "structResult": { + "$ref": "GenaiStruct" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1McpServerToolResultDelta": { + "id": "GenaiVertexV1beta1McpServerToolResultDelta", + "properties": { + "contentList": { + "$ref": "GenaiVertexV1beta1FunctionResultSubcontentList" + }, + "name": { + "type": "string" + }, + "server_name": { + "type": "string" + }, + "stringResult": { + "type": "string" + }, + "structResult": { + "$ref": "GenaiStruct" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1McpServerToolResultStep": { + "description": "MCPServer tool result step.", + "id": "GenaiVertexV1beta1McpServerToolResultStep", + "properties": { + "contentList": { + "$ref": "GenaiVertexV1beta1FunctionResultSubcontentList" + }, + "name": { + "description": "Name of the tool which is called for this specific tool call.", + "type": "string" + }, + "server_name": { + "description": "The name of the used MCP server.", + "type": "string" + }, + "stringResult": { + "type": "string" + }, + "structResult": { + "$ref": "GenaiStruct" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1ModelInteraction": { + "description": "Interaction for generating the completion using models.", + "id": "GenaiVertexV1beta1ModelInteraction", + "properties": { + "generation_config": { + "$ref": "GenaiVertexV1beta1GenerationConfig", + "description": "Input only. Configuration parameters for the model interaction." + }, + "model": { + "description": "The name of the `Model` used for generating the completion.", + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1ModelOutputStep": { + "description": "Output generated by the model.", + "id": "GenaiVertexV1beta1ModelOutputStep", + "properties": { + "content": { + "items": { + "$ref": "GenaiVertexV1beta1Content" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1PlaceCitation": { + "description": "A place citation annotation.", + "id": "GenaiVertexV1beta1PlaceCitation", + "properties": { + "name": { + "description": "Title of the place.", + "type": "string" + }, + "place_id": { + "description": "The ID of the place, in `places/{place_id}` format.", + "type": "string" + }, + "review_snippets": { + "description": "Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.", + "items": { + "$ref": "GenaiVertexV1beta1ReviewSnippet" + }, + "type": "array" + }, + "url": { + "description": "URI reference of the place.", + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1ResponseFormat": { + "id": "GenaiVertexV1beta1ResponseFormat", + "properties": { + "audio": { + "$ref": "GenaiVertexV1beta1AudioResponseFormat" + }, + "image": { + "$ref": "GenaiVertexV1beta1ImageResponseFormat" + }, + "structValue": { + "$ref": "GenaiStruct", + "description": "Multi-discriminator values is already enabled in GAOS" + }, + "text": { + "$ref": "GenaiVertexV1beta1TextResponseFormat" + }, + "video": { + "$ref": "GenaiVertexV1beta1VideoResponseFormat" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1ResponseFormatList": { + "id": "GenaiVertexV1beta1ResponseFormatList", + "properties": { + "response_formats": { + "items": { + "$ref": "GenaiVertexV1beta1ResponseFormat" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1Retrieval": { + "description": "A tool that can be used by the model to retrieve files.", + "id": "GenaiVertexV1beta1Retrieval", + "properties": { + "retrieval_types": { + "description": "The types of file retrieval to enable.", + "items": { + "enum": [ + "RETRIEVAL_TYPE_UNSPECIFIED", + "RETRIEVAL_TYPE_VERTEX_AI_SEARCH" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "type": "array" + }, + "vertex_ai_search_config": { + "$ref": "GenaiVertexV1beta1VertexAISearchConfig", + "description": "Used to specify configuration for VertexAISearch." + } + }, + "type": "object" + }, + "GenaiVertexV1beta1ReviewSnippet": { + "description": "Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.", + "id": "GenaiVertexV1beta1ReviewSnippet", + "properties": { + "review_id": { + "description": "The ID of the review snippet.", + "type": "string" + }, + "title": { + "description": "Title of the review.", + "type": "string" + }, + "url": { + "description": "A link that corresponds to the user review on Google Maps.", + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1SpeechConfig": { + "description": "The configuration for speech interaction.", + "id": "GenaiVertexV1beta1SpeechConfig", + "properties": { + "language": { + "description": "The language of the speech.", + "type": "string" + }, + "speaker": { + "description": "The speaker's name, it should match the speaker name given in the prompt.", + "type": "string" + }, + "voice": { + "description": "The voice of the speaker.", + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1Step": { + "description": "A step in the interaction.", + "id": "GenaiVertexV1beta1Step", + "properties": { + "modelOutput": { + "$ref": "GenaiVertexV1beta1ModelOutputStep" + }, + "thought": { + "$ref": "GenaiVertexV1beta1ThoughtStep" + }, + "toolCall": { + "$ref": "GenaiVertexV1beta1ToolCallStep" + }, + "toolResult": { + "$ref": "GenaiVertexV1beta1ToolResultStep" + }, + "userInput": { + "$ref": "GenaiVertexV1beta1UserInputStep" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1StepDelta": { + "id": "GenaiVertexV1beta1StepDelta", + "properties": { + "delta": { + "$ref": "GenaiVertexV1beta1StepDeltaData" + }, + "index": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1StepDeltaData": { + "id": "GenaiVertexV1beta1StepDeltaData", + "properties": { + "argumentsDelta": { + "$ref": "GenaiVertexV1beta1ArgumentsDelta" + }, + "audio": { + "$ref": "GenaiVertexV1beta1AudioDelta" + }, + "document": { + "$ref": "GenaiVertexV1beta1DocumentDelta" + }, + "image": { + "$ref": "GenaiVertexV1beta1ImageDelta" + }, + "text": { + "$ref": "GenaiVertexV1beta1TextDelta" + }, + "textAnnotationDelta": { + "$ref": "GenaiVertexV1beta1TextAnnotationDelta" + }, + "thoughtSignature": { + "$ref": "GenaiVertexV1beta1ThoughtSignatureDelta" + }, + "thoughtSummary": { + "$ref": "GenaiVertexV1beta1ThoughtSummaryDelta" + }, + "video": { + "$ref": "GenaiVertexV1beta1VideoDelta" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1StepList": { + "description": "A list of Steps.", + "id": "GenaiVertexV1beta1StepList", + "properties": { + "steps": { + "description": "The steps of the list.", + "items": { + "$ref": "GenaiVertexV1beta1Step" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1StepStart": { + "id": "GenaiVertexV1beta1StepStart", + "properties": { + "index": { + "format": "int32", + "type": "integer" + }, + "step": { + "$ref": "GenaiVertexV1beta1Step" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1StepStop": { + "id": "GenaiVertexV1beta1StepStop", + "properties": { + "index": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1TextAnnotationDelta": { + "id": "GenaiVertexV1beta1TextAnnotationDelta", + "properties": { + "annotations": { + "description": "Citation information for model-generated content.", + "items": { + "$ref": "GenaiVertexV1beta1TextContentAnnotation" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1TextContent": { + "description": "A text content block.", + "id": "GenaiVertexV1beta1TextContent", + "properties": { + "annotations": { + "description": "Citation information for model-generated content.", + "items": { + "$ref": "GenaiVertexV1beta1TextContentAnnotation" + }, + "type": "array" + }, + "text": { + "description": "Required. The text content.", + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1TextContentAnnotation": { + "description": "Citation information for model-generated content.", + "id": "GenaiVertexV1beta1TextContentAnnotation", + "properties": { + "end_index": { + "description": "End of the attributed segment, exclusive.", + "format": "int32", + "type": "integer" + }, + "file_citation": { + "$ref": "GenaiVertexV1beta1FileCitation", + "description": "A file citation annotation." + }, + "place_citation": { + "$ref": "GenaiVertexV1beta1PlaceCitation", + "description": "A place citation annotation." + }, + "start_index": { + "description": "Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.", + "format": "int32", + "type": "integer" + }, + "url_citation": { + "$ref": "GenaiVertexV1beta1UrlCitation", + "description": "A URL citation annotation." + } + }, + "type": "object" + }, + "GenaiVertexV1beta1TextDelta": { + "id": "GenaiVertexV1beta1TextDelta", + "properties": { + "text": { + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1TextResponseFormat": { + "description": "Configuration for text output format.", + "id": "GenaiVertexV1beta1TextResponseFormat", + "properties": { + "mime_type": { + "description": "The MIME type of the text output.", + "enum": [ + "TYPE_UNSPECIFIED", + "TYPE_APPLICATION_JSON", + "TYPE_TEXT_PLAIN" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "JSON output format.", + "Plain text output format." + ], + "type": "string" + }, + "schema": { + "$ref": "GenaiStruct", + "description": "The JSON schema that the output should conform to. Only applicable when mime_type is application/json." + } + }, + "type": "object" + }, + "GenaiVertexV1beta1ThoughtContent": { + "description": "A thought content block.", + "id": "GenaiVertexV1beta1ThoughtContent", + "properties": { + "signature": { + "description": "Signature to match the backend source to be part of the generation.", + "format": "byte", + "type": "string" + }, + "summary": { + "description": "A summary of the thought.", + "items": { + "$ref": "GenaiVertexV1beta1ThoughtSummaryContent" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1ThoughtSignatureDelta": { + "id": "GenaiVertexV1beta1ThoughtSignatureDelta", + "properties": { + "signature": { + "description": "Signature to match the backend source to be part of the generation.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1ThoughtStep": { + "description": "A thought step.", + "id": "GenaiVertexV1beta1ThoughtStep", + "properties": { + "signature": { + "description": "A signature hash for backend validation.", + "format": "byte", + "type": "string" + }, + "summary": { + "description": "A summary of the thought.", + "items": { + "$ref": "GenaiVertexV1beta1ThoughtSummaryContent" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1ThoughtSummaryContent": { + "id": "GenaiVertexV1beta1ThoughtSummaryContent", + "properties": { + "image": { + "$ref": "GenaiVertexV1beta1ImageContent" + }, + "text": { + "$ref": "GenaiVertexV1beta1TextContent" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1ThoughtSummaryDelta": { + "id": "GenaiVertexV1beta1ThoughtSummaryDelta", + "properties": { + "content": { + "$ref": "GenaiVertexV1beta1ThoughtSummaryContent", + "description": "A new summary item to be added to the thought." + } + }, + "type": "object" + }, + "GenaiVertexV1beta1Tool": { + "description": "A tool that can be used by the model.", + "id": "GenaiVertexV1beta1Tool", + "properties": { + "codeExecution": { + "$ref": "GenaiVertexV1beta1CodeExecution", + "description": "A tool that can be used by the model to execute code." + }, + "computerUse": { + "$ref": "GenaiVertexV1beta1ComputerUse", + "description": "Tool to support the model interacting directly with the computer." + }, + "fileSearch": { + "$ref": "GenaiVertexV1beta1FileSearch", + "description": "A tool that can be used by the model to search files." + }, + "function": { + "$ref": "GenaiVertexV1beta1Function", + "description": "A function that can be used by the model." + }, + "googleMaps": { + "$ref": "GenaiVertexV1beta1GoogleMaps", + "description": "A tool that can be used by the model to search Google Maps." + }, + "googleSearch": { + "$ref": "GenaiVertexV1beta1GoogleSearch", + "description": "A tool that can be used by the model to search Google." + }, + "mcpServer": { + "$ref": "GenaiVertexV1beta1McpServer", + "description": "A MCPServer is a server that can be called by the model to perform actions." + }, + "retrieval": { + "$ref": "GenaiVertexV1beta1Retrieval", + "description": "A tool that can be used by the model to retrieve files." + }, + "urlContext": { + "$ref": "GenaiVertexV1beta1UrlContext", + "description": "A tool that can be used by the model to fetch URL context." + } + }, + "type": "object" + }, + "GenaiVertexV1beta1ToolCallContent": { + "description": "Tool call content.", + "id": "GenaiVertexV1beta1ToolCallContent", + "properties": { + "codeExecutionCall": { + "$ref": "GenaiVertexV1beta1CodeExecutionCallContent" + }, + "fileSearchCall": { + "$ref": "GenaiVertexV1beta1FileSearchCallContent" + }, + "functionCall": { + "$ref": "GenaiVertexV1beta1FunctionCallContent" + }, + "googleMapsCall": { + "$ref": "GenaiVertexV1beta1GoogleMapsCallContent" + }, + "googleSearchCall": { + "$ref": "GenaiVertexV1beta1GoogleSearchCallContent" + }, + "id": { + "description": "Required. A unique ID for this specific tool call.", + "type": "string" + }, + "mcpServerToolCall": { + "$ref": "GenaiVertexV1beta1McpServerToolCallContent" + }, + "signature": { + "description": "A signature hash for backend validation.", + "format": "byte", + "type": "string" + }, + "urlContextCall": { + "$ref": "GenaiVertexV1beta1UrlContextCallContent" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1ToolCallDelta": { + "id": "GenaiVertexV1beta1ToolCallDelta", + "properties": { + "codeExecutionCall": { + "$ref": "GenaiVertexV1beta1CodeExecutionCallDelta" + }, + "fileSearchCall": { + "$ref": "GenaiVertexV1beta1FileSearchCallDelta" + }, + "functionCall": { + "$ref": "GenaiVertexV1beta1FunctionCallDelta" + }, + "googleMapsCall": { + "$ref": "GenaiVertexV1beta1GoogleMapsCallDelta" + }, + "googleSearchCall": { + "$ref": "GenaiVertexV1beta1GoogleSearchCallDelta" + }, + "id": { + "description": "Required. A unique ID for this specific tool call.", + "type": "string" + }, + "mcpServerToolCall": { + "$ref": "GenaiVertexV1beta1McpServerToolCallDelta" + }, + "signature": { + "description": "A signature hash for backend validation.", + "format": "byte", + "type": "string" + }, + "urlContextCall": { + "$ref": "GenaiVertexV1beta1UrlContextCallDelta" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1ToolCallStep": { + "description": "Tool call step.", + "id": "GenaiVertexV1beta1ToolCallStep", + "properties": { + "codeExecutionCall": { + "$ref": "GenaiVertexV1beta1CodeExecutionCallStep" + }, + "fileSearchCall": { + "$ref": "GenaiVertexV1beta1FileSearchCallStep" + }, + "functionCall": { + "$ref": "GenaiVertexV1beta1FunctionCallStep" + }, + "googleMapsCall": { + "$ref": "GenaiVertexV1beta1GoogleMapsCallStep" + }, + "googleSearchCall": { + "$ref": "GenaiVertexV1beta1GoogleSearchCallStep" + }, + "id": { + "description": "Required. A unique ID for this specific tool call.", + "type": "string" + }, + "mcpServerToolCall": { + "$ref": "GenaiVertexV1beta1McpServerToolCallStep" + }, + "signature": { + "description": "A signature hash for backend validation.", + "format": "byte", + "type": "string" + }, + "urlContextCall": { + "$ref": "GenaiVertexV1beta1UrlContextCallStep" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1ToolChoiceConfig": { + "description": "The tool choice configuration containing allowed tools.", + "id": "GenaiVertexV1beta1ToolChoiceConfig", + "properties": { + "allowed_tools": { + "$ref": "GenaiVertexV1beta1AllowedTools", + "description": "The allowed tools." + } + }, + "type": "object" + }, + "GenaiVertexV1beta1ToolResultContent": { + "description": "Tool result content.", + "id": "GenaiVertexV1beta1ToolResultContent", + "properties": { + "call_id": { + "description": "Required. ID to match the ID from the function call block.", + "type": "string" + }, + "codeExecutionResult": { + "$ref": "GenaiVertexV1beta1CodeExecutionResultContent" + }, + "fileSearchResult": { + "$ref": "GenaiVertexV1beta1FileSearchResultContent" + }, + "functionResult": { + "$ref": "GenaiVertexV1beta1FunctionResultContent" + }, + "googleMapsResult": { + "$ref": "GenaiVertexV1beta1GoogleMapsResultContent" + }, + "googleSearchResult": { + "$ref": "GenaiVertexV1beta1GoogleSearchResultContent" + }, + "mcpServerToolResult": { + "$ref": "GenaiVertexV1beta1McpServerToolResultContent" + }, + "signature": { + "description": "A signature hash for backend validation.", + "format": "byte", + "type": "string" + }, + "urlContextResult": { + "$ref": "GenaiVertexV1beta1UrlContextResultContent" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1ToolResultDelta": { + "id": "GenaiVertexV1beta1ToolResultDelta", + "properties": { + "call_id": { + "description": "Required. ID to match the ID from the function call block.", + "type": "string" + }, + "codeExecutionResult": { + "$ref": "GenaiVertexV1beta1CodeExecutionResultDelta" + }, + "fileSearchResult": { + "$ref": "GenaiVertexV1beta1FileSearchResultDelta" + }, + "functionResult": { + "$ref": "GenaiVertexV1beta1FunctionResultDelta" + }, + "googleMapsResult": { + "$ref": "GenaiVertexV1beta1GoogleMapsResultDelta" + }, + "googleSearchResult": { + "$ref": "GenaiVertexV1beta1GoogleSearchResultDelta" + }, + "mcpServerToolResult": { + "$ref": "GenaiVertexV1beta1McpServerToolResultDelta" + }, + "signature": { + "description": "A signature hash for backend validation.", + "format": "byte", + "type": "string" + }, + "urlContextResult": { + "$ref": "GenaiVertexV1beta1UrlContextResultDelta" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1ToolResultStep": { + "description": "Tool result step.", + "id": "GenaiVertexV1beta1ToolResultStep", + "properties": { + "call_id": { + "description": "Required. ID to match the ID from the function call block.", + "type": "string" + }, + "codeExecutionResult": { + "$ref": "GenaiVertexV1beta1CodeExecutionResultStep" + }, + "fileSearchResult": { + "$ref": "GenaiVertexV1beta1FileSearchResultStep" + }, + "functionResult": { + "$ref": "GenaiVertexV1beta1FunctionResultStep" + }, + "googleMapsResult": { + "$ref": "GenaiVertexV1beta1GoogleMapsResultStep" + }, + "googleSearchResult": { + "$ref": "GenaiVertexV1beta1GoogleSearchResultStep" + }, + "mcpServerToolResult": { + "$ref": "GenaiVertexV1beta1McpServerToolResultStep" + }, + "signature": { + "description": "A signature hash for backend validation.", + "format": "byte", + "type": "string" + }, + "urlContextResult": { + "$ref": "GenaiVertexV1beta1UrlContextResultStep" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1Turn": { + "deprecated": true, + "id": "GenaiVertexV1beta1Turn", + "properties": { + "contentList": { + "$ref": "GenaiVertexV1beta1ContentList", + "description": "The content of the turn. An array of Content objects." + }, + "contentString": { + "description": "The content of the turn. A single string.", + "type": "string" + }, + "role": { + "description": "The originator of this turn. Must be user for input or model for model output.", + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1TurnList": { + "deprecated": true, + "description": "A list of Turns.", + "id": "GenaiVertexV1beta1TurnList", + "properties": { + "turns": { + "items": { + "$ref": "GenaiVertexV1beta1Turn" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1UrlCitation": { + "description": "A URL citation annotation.", + "id": "GenaiVertexV1beta1UrlCitation", "properties": { - "audioPrompt": { - "description": "Description of audio content in the video, without speech.", - "type": "string" - }, - "negativeAudioPrompt": { - "description": "Negative description of audio content in the video.", + "title": { + "description": "The title of the URL.", "type": "string" }, - "negativePrompt": { - "description": "Single negative prompt for what not to generate.", + "url": { + "description": "The URL.", "type": "string" - }, - "promptChunks": { - "description": "2s, 256 tokens per chunk, 4 total chunks. Required.", + } + }, + "type": "object" + }, + "GenaiVertexV1beta1UrlContext": { + "description": "A tool that can be used by the model to fetch URL context.", + "id": "GenaiVertexV1beta1UrlContext", + "properties": {}, + "type": "object" + }, + "GenaiVertexV1beta1UrlContextCallContent": { + "description": "URL context content.", + "id": "GenaiVertexV1beta1UrlContextCallContent", + "properties": { + "arguments": { + "$ref": "GenaiVertexV1beta1UrlContextCallContentUrlContextCallArguments", + "description": "Required. The arguments to pass to the URL context." + } + }, + "type": "object" + }, + "GenaiVertexV1beta1UrlContextCallContentUrlContextCallArguments": { + "description": "The arguments to pass to the URL context.", + "id": "GenaiVertexV1beta1UrlContextCallContentUrlContextCallArguments", + "properties": { + "urls": { + "description": "The URLs to fetch.", "items": { "type": "string" }, "type": "array" - }, - "transcript": { - "description": "Spoken transcript of the video for characters.", - "type": "string" } }, "type": "object" }, - "CloudAiLargeModelsVisionRaiInfo": { - "description": "Next ID: 6", - "id": "CloudAiLargeModelsVisionRaiInfo", + "GenaiVertexV1beta1UrlContextCallDelta": { + "id": "GenaiVertexV1beta1UrlContextCallDelta", "properties": { - "blockedEntities": { - "description": "List of blocked entities from the blocklist if it is detected.", + "arguments": { + "$ref": "GenaiVertexV1beta1UrlContextCallContentUrlContextCallArguments" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1UrlContextCallStep": { + "description": "URL context call step.", + "id": "GenaiVertexV1beta1UrlContextCallStep", + "properties": { + "arguments": { + "$ref": "GenaiVertexV1beta1UrlContextCallStepUrlContextCallStepArguments", + "description": "Required. The arguments to pass to the URL context." + } + }, + "type": "object" + }, + "GenaiVertexV1beta1UrlContextCallStepUrlContextCallStepArguments": { + "description": "The arguments to pass to the URL context.", + "id": "GenaiVertexV1beta1UrlContextCallStepUrlContextCallStepArguments", + "properties": { + "urls": { + "description": "The URLs to fetch.", "items": { "type": "string" }, "type": "array" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1UrlContextResultContent": { + "description": "URL context result content.", + "id": "GenaiVertexV1beta1UrlContextResultContent", + "properties": { + "is_error": { + "description": "Whether the URL context resulted in an error.", + "type": "boolean" }, - "detectedLabels": { - "description": "The list of detected labels for different rai categories.", + "result": { + "description": "Required. The results of the URL context.", "items": { - "$ref": "CloudAiLargeModelsVisionRaiInfoDetectedLabels" + "$ref": "GenaiVertexV1beta1UrlContextResultContentUrlContextResult" }, "type": "array" - }, - "modelName": { - "description": "The model name used to indexing into the RaiFilterConfig map. Would either be one of imagegeneration@002-006, imagen-3.0-... api endpoint names, or internal names used for mapping to different filter configs (genselfie, ai_watermark) than its api endpoint.", + } + }, + "type": "object" + }, + "GenaiVertexV1beta1UrlContextResultContentUrlContextResult": { + "description": "The result of the URL context.", + "id": "GenaiVertexV1beta1UrlContextResultContentUrlContextResult", + "properties": { + "status": { + "description": "The status of the URL retrieval.", + "enum": [ + "STATUS_UNSPECIFIED", + "SUCCESS", + "ERROR", + "PAYWALL", + "UNSAFE" + ], + "enumDescriptions": [ + "Unspecified status. This value should not be used.", + "Url retrieval is successful.", + "Url retrieval is failed due to error.", + "Url retrieval is failed because the content is behind paywall.", + "Url retrieval is failed because the content is unsafe." + ], "type": "string" }, - "raiCategories": { - "description": "List of rai categories' information to return", - "items": { - "type": "string" - }, - "type": "array" + "url": { + "description": "The URL that was fetched.", + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1UrlContextResultDelta": { + "id": "GenaiVertexV1beta1UrlContextResultDelta", + "properties": { + "is_error": { + "type": "boolean" }, - "scores": { - "description": "List of rai scores mapping to the rai categories. Rounded to 1 decimal place.", + "result": { "items": { - "format": "float", - "type": "number" + "$ref": "GenaiVertexV1beta1UrlContextResultContentUrlContextResult" }, "type": "array" } }, "type": "object" }, - "CloudAiLargeModelsVisionRaiInfoDetectedLabels": { - "description": "Filters returning list of deteceted labels, scores, and bounding boxes.", - "id": "CloudAiLargeModelsVisionRaiInfoDetectedLabels", + "GenaiVertexV1beta1UrlContextResultStep": { + "description": "URL context result step.", + "id": "GenaiVertexV1beta1UrlContextResultStep", "properties": { - "entities": { - "description": "The list of detected entities for the rai signal.", + "is_error": { + "description": "Whether the URL context resulted in an error.", + "type": "boolean" + }, + "result": { + "description": "Required. The results of the URL context.", "items": { - "$ref": "CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity" + "$ref": "GenaiVertexV1beta1UrlContextResultStepUrlContextResultItem" }, "type": "array" - }, - "raiCategory": { - "description": "The RAI category for the deteceted labels.", - "type": "string" } }, "type": "object" }, - "CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox": { - "description": "An integer bounding box of original pixels of the image for the detected labels.", - "id": "CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox", + "GenaiVertexV1beta1UrlContextResultStepUrlContextResultItem": { + "description": "The result of the URL context.", + "id": "GenaiVertexV1beta1UrlContextResultStepUrlContextResultItem", "properties": { - "x1": { - "description": "The X coordinate of the top-left corner, in pixels.", - "format": "int32", - "type": "integer" - }, - "x2": { - "description": "The X coordinate of the bottom-right corner, in pixels.", - "format": "int32", - "type": "integer" - }, - "y1": { - "description": "The Y coordinate of the top-left corner, in pixels.", - "format": "int32", - "type": "integer" + "status": { + "description": "The status of the URL retrieval.", + "enum": [ + "STATUS_UNSPECIFIED", + "SUCCESS", + "ERROR", + "PAYWALL", + "UNSAFE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "type": "string" }, - "y2": { - "description": "The Y coordinate of the bottom-right corner, in pixels.", - "format": "int32", - "type": "integer" + "url": { + "description": "The URL that was fetched.", + "type": "string" } }, "type": "object" }, - "CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity": { - "description": "The properties for a detected entity from the rai signal.", - "id": "CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity", + "GenaiVertexV1beta1UserInputStep": { + "description": "Input provided by the user.", + "id": "GenaiVertexV1beta1UserInputStep", "properties": { - "boundingBox": { - "$ref": "CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox", - "description": "Bounding box of the label" - }, - "description": { - "description": "Description of the label", - "type": "string" - }, - "iouScore": { - "description": "The intersection ratio between the detection bounding box and the mask.", - "format": "float", - "type": "number" - }, - "mid": { - "description": "MID of the label", - "type": "string" - }, - "score": { - "description": "Confidence score of the label", - "format": "float", - "type": "number" + "content": { + "items": { + "$ref": "GenaiVertexV1beta1Content" + }, + "type": "array" } }, "type": "object" }, - "CloudAiLargeModelsVisionSemanticFilterResponse": { - "id": "CloudAiLargeModelsVisionSemanticFilterResponse", + "GenaiVertexV1beta1VertexAISearchConfig": { + "description": "Used to specify configuration for VertexAISearch.", + "id": "GenaiVertexV1beta1VertexAISearchConfig", "properties": { - "namedBoundingBoxes": { - "description": "Class labels of the bounding boxes that failed the semantic filtering. Bounding box coordinates.", + "datastores": { + "description": "Optional. Used to specify Vertex AI Search datastores.", "items": { - "$ref": "CloudAiLargeModelsVisionNamedBoundingBox" + "type": "string" }, "type": "array" }, - "passedSemanticFilter": { - "description": "This response is added when semantic filter config is turned on in EditConfig. It reports if this image is passed semantic filter response. If passed_semantic_filter is false, the bounding box information will be populated for user to check what caused the semantic filter to fail.", - "type": "boolean" + "engine": { + "description": "Optional. Used to specify Vertex AI Search engine.", + "type": "string" } }, "type": "object" }, - "CloudAiLargeModelsVisionVideo": { - "description": "Video", - "id": "CloudAiLargeModelsVisionVideo", + "GenaiVertexV1beta1VideoContent": { + "description": "A video content block.", + "id": "GenaiVertexV1beta1VideoContent", "properties": { - "encodedVideo": { - "description": "Base 64 encoded video bytes.", + "data": { + "description": "The video content.", + "format": "byte", "type": "string" }, - "encoding": { - "description": "Video encoding, for example \"video/mp4\".", + "mime_type": { + "description": "The mime type of the video.", + "enum": [ + "TYPE_UNSPECIFIED", + "TYPE_MP4", + "TYPE_MPEG", + "TYPE_MPG", + "TYPE_MOV", + "TYPE_AVI", + "TYPE_X_FLV", + "TYPE_WEBM", + "TYPE_WMV", + "TYPE_3GPP" + ], + "enumDescriptions": [ + "", + "MP4 video format", + "MPEG video format", + "MPG video format", + "MOV video format", + "AVI video format", + "FLV video format", + "WebM video format", + "WMV video format", + "3GPP video format" + ], "type": "string" }, - "text": { - "description": "Text/Expanded text input for Help Me Write.", + "resolution": { + "description": "The resolution of the media.", + "enum": [ + "MEDIA_RESOLUTION_UNSPECIFIED", + "LOW", + "MEDIUM", + "HIGH", + "ULTRA_HIGH" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Low resolution.", + "Medium resolution.", + "High resolution.", + "Ultra high resolution." + ], "type": "string" }, "uri": { - "description": "Path to another storage (typically Google Cloud Storage).", - "type": "string" - }, - "video": { - "description": "Raw bytes.", - "format": "byte", + "description": "The URI of the video.", "type": "string" } }, "type": "object" }, - "CloudAiPlatformCommonCreatePipelineJobApiErrorDetail": { - "description": "Create API error message for Vertex Pipeline.", - "id": "CloudAiPlatformCommonCreatePipelineJobApiErrorDetail", + "GenaiVertexV1beta1VideoDelta": { + "id": "GenaiVertexV1beta1VideoDelta", "properties": { - "errorCause": { - "description": "The error root cause returned by CreatePipelineJob API.", + "data": { + "format": "byte", + "type": "string" + }, + "mime_type": { "enum": [ - "ERROR_CAUSE_UNSPECIFIED", - "INVALID_PIPELINE_SPEC_FORMAT", - "INVALID_PIPELINE_SPEC", - "INVALID_DEPLOYMENT_CONFIG", - "INVALID_DEPLOYMENT_SPEC", - "INVALID_INSTANCE_SCHEMA", - "INVALID_CUSTOM_JOB", - "INVALID_CONTAINER_SPEC", - "INVALID_NOTIFICATION_EMAIL_SETUP", - "INVALID_SERVICE_ACCOUNT_SETUP", - "INVALID_KMS_SETUP", - "INVALID_NETWORK_SETUP", - "INVALID_PIPELINE_TASK_SPEC", - "INVALID_PIPELINE_TASK_ARTIFACT", - "INVALID_IMPORTER_SPEC", - "INVALID_RESOLVER_SPEC", - "INVALID_RUNTIME_PARAMETERS", - "CLOUD_API_NOT_ENABLED", - "INVALID_GCS_INPUT_URI", - "INVALID_GCS_OUTPUT_URI", - "INVALID_COMPONENT_SPEC", - "INVALID_DAG_OUTPUTS_SPEC", - "INVALID_DAG_SPEC", - "INSUFFICIENT_QUOTA", - "INTERNAL" + "TYPE_UNSPECIFIED", + "TYPE_MP4", + "TYPE_MPEG", + "TYPE_MPG", + "TYPE_MOV", + "TYPE_AVI", + "TYPE_X_FLV", + "TYPE_WEBM", + "TYPE_WMV", + "TYPE_3GPP" ], "enumDescriptions": [ - "Should never be used.", - "IR Pipeline Spec can not been parsed to yaml or json format.", - "A pipeline spec is invalid.", - "A deployment config is invalid.", - "A deployment spec is invalid.", - "An instance schema is invalid.", - "A custom job is invalid.", - "A container spec is invalid.", - "Notification email setup is invalid.", - "Service account setup is invalid.", - "KMS setup is invalid.", - "Network setup is invalid.", - "Task spec is invalid.", - "Task artifact is invalid.", - "Importer spec is invalid.", - "Resolver spec is invalid.", - "Runtime Parameters are invalid.", - "Cloud API not enabled.", - "Invalid Cloud Storage input uri", - "Invalid Cloud Storage output uri", - "Component spec of pipeline is invalid.", - "DagOutputsSpec is invalid.", - "DagSpec is invalid.", - "Project does not have enough quota.", - "An internal error with unknown cause." + "", + "MP4 video format", + "MPEG video format", + "MPG video format", + "MOV video format", + "AVI video format", + "FLV video format", + "WebM video format", + "WMV video format", + "3GPP video format" ], "type": "string" }, - "publicMessage": { - "description": "Public messages contains actionable items for the error cause.", + "resolution": { + "description": "The resolution of the media.", + "enum": [ + "MEDIA_RESOLUTION_UNSPECIFIED", + "LOW", + "MEDIUM", + "HIGH", + "ULTRA_HIGH" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Low resolution.", + "Medium resolution.", + "High resolution.", + "Ultra high resolution." + ], + "type": "string" + }, + "uri": { "type": "string" } }, "type": "object" }, + "GenaiVertexV1beta1VideoResponseFormat": { + "description": "Configuration for video output format.", + "id": "GenaiVertexV1beta1VideoResponseFormat", + "properties": {}, + "type": "object" + }, "GoogleApiHttpBody": { "description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.", "id": "GoogleApiHttpBody", @@ -46322,6 +50679,68 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1Agent": { + "description": "A Vertex agent contains instructions and configurations for the LLM to execute a certain task.", + "id": "GoogleCloudAiplatformV1beta1Agent", + "properties": { + "base_agent": { + "description": "Required. The base agent of the agent. Supported values: - \"antigravity-preview-05-2026\"", + "type": "string" + }, + "base_environment": { + "description": "Optional. The environment config of the agent. Valid types are: - string value for environment_id, or 'remote' for default - struct value for EnvironmentConfig.", + "type": "any" + }, + "created": { + "description": "Output only. Timestamp when the agent was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. The description of the agent.", + "type": "string" + }, + "id": { + "description": "Immutable. The ID to use for agent, which will become the final component of the agent resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, the last character must be a letter or number.", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The metadata of the agent.", + "type": "object" + }, + "name": { + "description": "Identifier. The resource name of the Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.", + "type": "string" + }, + "object": { + "description": "Output only. The object type of this resource. Always set to \"agent\" in this case.", + "readOnly": true, + "type": "string" + }, + "system_instruction": { + "description": "Optional. The detailed struction that the agent should follow. The instruction is passed to LLM as system instruction.", + "type": "string" + }, + "tools": { + "description": "Optional. A list of tools that are available for the agent during the process of execucting the task.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1AgentTool" + }, + "type": "array" + }, + "updated": { + "description": "Output only. Timestamp when the agent was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1AgentConfig": { "description": "Represents configuration for an Agent.", "id": "GoogleCloudAiplatformV1beta1AgentConfig", @@ -46415,6 +50834,32 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1AgentTool": { + "description": "A tool provides a list of actions that are available for the Agent during the process of executing the task.", + "id": "GoogleCloudAiplatformV1beta1AgentTool", + "properties": { + "headers": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Headers for the MCP server (e.g., authentication). Only applicable when `type` is \"mcp\".", + "type": "object" + }, + "name": { + "description": "Optional. The name of the MCP server. Only applicable when `type` is \"mcp\".", + "type": "string" + }, + "type": { + "description": "Required. Type of the tool. Supported types: - \"code_execution\" - \"filesystem\" - \"google_search\" - \"mcp\" - \"url_context\"", + "type": "string" + }, + "url": { + "description": "Optional. The full URL for the MCP server endpoint. Only applicable when `type` is \"mcp\".", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1AggregationOutput": { "description": "The aggregation result for the entire dataset and all metrics.", "id": "GoogleCloudAiplatformV1beta1AggregationOutput", @@ -46895,11 +51340,11 @@ "id": "GoogleCloudAiplatformV1beta1AsyncQueryReasoningEngineRequest", "properties": { "inputGcsUri": { - "description": "Optional. Input Cloud Storage URI for the Async query.", + "description": "Optional. Input Cloud Storage URI for the Async query. If you are not bringing your own container (BYOC), the content of the file should be a JSON object with an `input` field matching the `input` field of `QueryReasoningEngineRequest` (e.g. `{ \"input\": { \"user_id\": \"hello\", \"message\":\"$QUERY\"} }`). For BYOC, the content of the file depends on the the agent application.", "type": "string" }, "outputGcsUri": { - "description": "Optional. Output Cloud Storage URI for the Async query.", + "description": "Optional. Output Cloud Storage URI for the Async query. This contains the final response of the query.", "type": "string" } }, @@ -48319,6 +52764,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1CancelAsyncQueryReasoningEngineRequest": { + "description": "Request message for ReasoningEngineExecutionService.CancelAsyncQueryReasoningEngine.", + "id": "GoogleCloudAiplatformV1beta1CancelAsyncQueryReasoningEngineRequest", + "properties": { + "operationName": { + "description": "Required. The name of the longrunning operation returned from AsyncQueryReasoningEngine. Format: `projects/{project}/locations/{location}/operations/{operation}`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1CancelAsyncQueryReasoningEngineResponse": { "description": "Response message for ReasoningEngineExecutionService.CancelAsyncQueryReasoningEngine.", "id": "GoogleCloudAiplatformV1beta1CancelAsyncQueryReasoningEngineResponse", @@ -49858,6 +54314,18 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1CreateServingProfileOperationMetadata": { + "description": "Runtime operation metadata for ServingProfileService.CreateServingProfile.", + "id": "GoogleCloudAiplatformV1beta1CreateServingProfileOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", + "description": "Output only. The standard operation metadata for Vertex AI.", + "readOnly": true + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1CreateSolverOperationMetadata": { "description": "Runtime operation information for SolverService.CreateSolver.", "id": "GoogleCloudAiplatformV1beta1CreateSolverOperationMetadata", @@ -53505,7 +57973,7 @@ "type": "array" }, "metrics": { - "description": "Required. The metrics to be calculated in the evaluation run.", + "description": "Optional. The metrics to be calculated in the evaluation run. Required when analysis_configs is not set.", "items": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunMetric" }, @@ -57799,6 +62267,20 @@ "description": "Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.", "id": "GoogleCloudAiplatformV1beta1FunctionDeclaration", "properties": { + "behavior": { + "description": "Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method.", + "enum": [ + "UNSPECIFIED", + "BLOCKING", + "NON_BLOCKING" + ], + "enumDescriptions": [ + "This value is unspecified.", + "If set, the system will wait to receive the function response before continuing the conversation.", + "If set, the system will not wait to receive the function response. Instead, it will attempt to handle function responses as they become available while maintaining the conversation between the user and the model." + ], + "type": "string" + }, "description": { "description": "Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.", "type": "string" @@ -60996,6 +65478,24 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ListAgentsResponse": { + "description": "Response message for AgentService.ListAgents.", + "id": "GoogleCloudAiplatformV1beta1ListAgentsResponse", + "properties": { + "agents": { + "description": "A list of agents matching the request.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Agent" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as ListAgentsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ListAnnotationsResponse": { "description": "Response message for DatasetService.ListAnnotations.", "id": "GoogleCloudAiplatformV1beta1ListAnnotationsResponse", @@ -62185,6 +66685,42 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ListSkillRevisionsResponse": { + "description": "Response message for SkillRegistryService.ListSkillRevisions.", + "id": "GoogleCloudAiplatformV1beta1ListSkillRevisionsResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "skillRevisions": { + "description": "The list of Skill Revisions in the request page.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1SkillRevision" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ListSkillsResponse": { + "description": "Response message for SkillRegistryService.ListSkills.", + "id": "GoogleCloudAiplatformV1beta1ListSkillsResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as ListSkillsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "skills": { + "description": "The Skills.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Skill" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ListSpecialistPoolsResponse": { "description": "Response message for SpecialistPoolService.ListSpecialistPools.", "id": "GoogleCloudAiplatformV1beta1ListSpecialistPoolsResponse", @@ -73245,6 +77781,35 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1RetrieveSkillsResponse": { + "description": "Response message for SkillRegistryService.RetrieveSkills.", + "id": "GoogleCloudAiplatformV1beta1RetrieveSkillsResponse", + "properties": { + "retrievedSkills": { + "description": "Skills ranked by similarity if applicable; otherwise, the order is undefined.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1RetrieveSkillsResponseRetrievedSkill" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RetrieveSkillsResponseRetrievedSkill": { + "description": "A retrieved skill.", + "id": "GoogleCloudAiplatformV1beta1RetrieveSkillsResponseRetrievedSkill", + "properties": { + "description": { + "description": "The skill description.", + "type": "string" + }, + "skillName": { + "description": "The skill resource name. Format: projects/{project}/locations/{location}/skills/{skill}", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1RollbackMemoryRequest": { "description": "Request message for MemoryBankService.RollbackMemory.", "id": "GoogleCloudAiplatformV1beta1RollbackMemoryRequest", @@ -74053,7 +78618,7 @@ "type": "string" }, "sandboxEnvironmentTemplate": { - "description": "Optional. The name of the SandboxEnvironmentTemplate specified in the parent Agent Engine resource that this SandboxEnvironment is created from. Only one of `sandbox_environment_template` and `spec` should be set.", + "description": "Optional. The name of the SandboxEnvironmentTemplate specified in the parent Agent Engine resource that this SandboxEnvironment is created from.", "type": "string" }, "spec": { @@ -79720,6 +84285,137 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1Skill": { + "description": "A skill.", + "id": "GoogleCloudAiplatformV1beta1Skill", + "properties": { + "compatibility": { + "description": "Optional. Specifies the compatibility of the Skill. Indicates environment requirements (intended product, system packages, network access, etc.). This should align with `compatibility` in the `SKILL.md` file.", + "type": "string" + }, + "createTime": { + "description": "Output only. Timestamp when this Skill was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Required. Describes the Skill. Should describe both what the skill does and when to use it. Should include specific keywords that help agents identify relevant tasks. This should align with `description` in the `SKILL.md` file.", + "type": "string" + }, + "displayName": { + "description": "Required. Provides the display name of the Skill. This should align with `name` in the `SKILL.md` file.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The labels with user-defined metadata to organize Skills.", + "type": "object" + }, + "license": { + "description": "Optional. Specifies the license of the Skill. This should be an SPDX license identifier (e.g., \"MIT\", \"Apache-2.0\"). See https://spdx.org/licenses/. This should align with `license` in the `SKILL.md` file.", + "type": "string" + }, + "name": { + "description": "Identifier. The resource name of the Skill. Format: `projects/{project}/locations/{location}/skills/{skill}`", + "type": "string" + }, + "sha256": { + "description": "Output only. The SHA256 checksum of the zipped filesystem.", + "readOnly": true, + "type": "string" + }, + "skillSource": { + "description": "Output only. The source of the Skill.", + "enum": [ + "SKILL_SOURCE_UNSPECIFIED", + "USER", + "SYSTEM" + ], + "enumDescriptions": [ + "The skill source is unspecified.", + "The skill is created by a user.", + "The skill is a system skill." + ], + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The state of the Skill.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "CREATING", + "FAILED", + "DELETING" + ], + "enumDescriptions": [ + "The state of the Skill is unspecified.", + "The Skill is active.", + "The Skill is being created.", + "The Skill was created, but failed to process.", + "The Skill is being deleted." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when this Skill was most recently updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "zippedFilesystem": { + "description": "Required. Provides the zipped filesystem of the Skill. This should contain the `SKILL.md` file at the root of the zip and optional directories for scripts, references, and assets. Directory should align with the directory structure specified at https://agentskills.io/specification#directory-structure.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1SkillRevision": { + "description": "A revision of a Skill.", + "id": "GoogleCloudAiplatformV1beta1SkillRevision", + "properties": { + "createTime": { + "description": "Output only. Timestamp when this Skill Revision was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The resource name of the Skill Revision. Format: `projects/{project}/locations/{location}/skills/{skill}/revisions/{revision}`", + "type": "string" + }, + "skill": { + "$ref": "GoogleCloudAiplatformV1beta1Skill", + "description": "Output only. The state of the Skill at this revision. TODO(b/503772996) Use a different proto for skill data included in skill revision", + "readOnly": true + }, + "state": { + "description": "Output only. The state of the Skill Revision.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "CREATING", + "FAILED", + "DELETING" + ], + "enumDescriptions": [ + "The state of the Skill Revision is unspecified.", + "The Skill Revision is active.", + "The Skill Revision is being created.", + "The Skill Revision was created, but failed to process.", + "The Skill Revision is being deleted." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1SlackSource": { "description": "The Slack source for the ImportRagFilesRequest.", "id": "GoogleCloudAiplatformV1beta1SlackSource", diff --git a/discovery/alloydb-v1.json b/discovery/alloydb-v1.json index 96a3b6e1c42..282da4240d2 100644 --- a/discovery/alloydb-v1.json +++ b/discovery/alloydb-v1.json @@ -1879,7 +1879,7 @@ } } }, - "revision": "20260423", + "revision": "20260507", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2701,6 +2701,12 @@ "description": "Configuration for Managed Connection Pool (MCP).", "id": "ConnectionPoolConfig", "properties": { + "authproxyPoolerCount": { + "description": "Output only. The number of running AuthProxy poolers per instance.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, "enabled": { "description": "Optional. Whether to enable Managed Connection Pool (MCP).", "type": "boolean" diff --git a/discovery/alloydb-v1alpha.json b/discovery/alloydb-v1alpha.json index eb7a0cd8065..4f70a3afa1a 100644 --- a/discovery/alloydb-v1alpha.json +++ b/discovery/alloydb-v1alpha.json @@ -2086,7 +2086,7 @@ } } }, - "revision": "20260423", + "revision": "20260507", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2967,6 +2967,12 @@ "description": "Configuration for Managed Connection Pool (MCP).", "id": "ConnectionPoolConfig", "properties": { + "authproxyPoolerCount": { + "description": "Output only. The number of running AuthProxy poolers per instance.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, "enabled": { "description": "Optional. Whether to enable Managed Connection Pool (MCP).", "type": "boolean" diff --git a/discovery/alloydb-v1beta.json b/discovery/alloydb-v1beta.json index ea5fb2c7281..22f3753c662 100644 --- a/discovery/alloydb-v1beta.json +++ b/discovery/alloydb-v1beta.json @@ -2083,7 +2083,7 @@ } } }, - "revision": "20260423", + "revision": "20260507", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2948,6 +2948,12 @@ "description": "Configuration for Managed Connection Pool (MCP).", "id": "ConnectionPoolConfig", "properties": { + "authproxyPoolerCount": { + "description": "Output only. The number of running AuthProxy poolers per instance.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, "enabled": { "description": "Optional. Whether to enable Managed Connection Pool (MCP).", "type": "boolean" diff --git a/discovery/androidpublisher-v3.json b/discovery/androidpublisher-v3.json index 60bd30895c2..1437bc99496 100644 --- a/discovery/androidpublisher-v3.json +++ b/discovery/androidpublisher-v3.json @@ -5637,7 +5637,7 @@ } } }, - "revision": "20260506", + "revision": "20260511", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Abi": { @@ -6308,7 +6308,7 @@ }, "recurringPrice": { "$ref": "Money", - "description": "The current recurring price of the auto renewing plan. Note that the price does not take into account discounts and does not include taxes for tax-exclusive pricing, please call orders.get API instead if transaction details are needed." + "description": "The current recurring price of the auto renewing plan. Note that the price does not take into account discounts and does not include taxes. For tax-exclusive pricing, please call orders.get API instead if transaction details are needed." } }, "type": "object" diff --git a/discovery/apigee-v1.json b/discovery/apigee-v1.json index 6385784b0df..32e9e48105f 100644 --- a/discovery/apigee-v1.json +++ b/discovery/apigee-v1.json @@ -11964,7 +11964,7 @@ } } }, - "revision": "20260430", + "revision": "20260511", "rootUrl": "https://apigee.googleapis.com/", "schemas": { "EdgeConfigstoreBundleBadBundle": { @@ -12781,6 +12781,11 @@ "format": "int64", "type": "string" }, + "mcp": { + "description": "Output only. Whether this proxy revision is detected as an MCP (Model Context Protocol) proxy. A proxy revision is identified as MCP if it has a proxy endpoint with the `/mcp` base path that routes to the MCP target URL.", + "readOnly": true, + "type": "boolean" + }, "name": { "description": "Name of the API proxy.", "type": "string" diff --git a/discovery/backupdr-v1.json b/discovery/backupdr-v1.json index c9da067bd62..584c95da62a 100644 --- a/discovery/backupdr-v1.json +++ b/discovery/backupdr-v1.json @@ -2661,7 +2661,7 @@ } } }, - "revision": "20260507", + "revision": "20260510", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { "AbandonBackupRequest": { @@ -3675,7 +3675,7 @@ }, "computeInstanceBackupPlanProperties": { "$ref": "ComputeInstanceBackupPlanProperties", - "description": "Optional. Defines optional properties specific to backups of disk-based resources, such as Compute Engine. This includes settings like whether to perform a guest flush." + "description": "Optional. Defines optional properties specific to backups of compute instance-based resources, such as Compute Engine. This includes settings like whether to perform a guest flush." }, "createTime": { "description": "Output only. When the `BackupPlan` was created.", @@ -4245,7 +4245,7 @@ "type": "object" }, "ComputeInstanceBackupPlanProperties": { - "description": "--- ComputeInstanceBackupPlanProperties Message ---", + "description": "Properties for a compute instance backup plan.", "id": "ComputeInstanceBackupPlanProperties", "properties": { "guestFlush": { @@ -4879,7 +4879,7 @@ "type": "object" }, "DiskBackupPlanProperties": { - "description": "--- DiskBackupPlanProperties Message ---", + "description": "Properties for a disk backup plan.", "id": "DiskBackupPlanProperties", "properties": { "guestFlush": { diff --git a/discovery/ces-v1.json b/discovery/ces-v1.json index 52d7d15ba61..151e7d65f53 100644 --- a/discovery/ces-v1.json +++ b/discovery/ces-v1.json @@ -2283,7 +2283,7 @@ } } }, - "revision": "20260429", + "revision": "20260506", "rootUrl": "https://ces.googleapis.com/", "schemas": { "Action": { @@ -5880,178 +5880,6 @@ }, "type": "object" }, - "Omnichannel": { - "description": "Represents an Omnichannel resource.", - "id": "Omnichannel", - "properties": { - "createTime": { - "description": "Output only. Timestamp when the omnichannel resource was created.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "description": { - "description": "Optional. Human-readable description of the omnichannel resource.", - "type": "string" - }, - "displayName": { - "description": "Required. Display name of the omnichannel resource.", - "type": "string" - }, - "etag": { - "description": "Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation.", - "readOnly": true, - "type": "string" - }, - "integrationConfig": { - "$ref": "OmnichannelIntegrationConfig", - "description": "Optional. The integration config for the omnichannel resource." - }, - "name": { - "description": "Identifier. The unique identifier of the omnichannel resource. Format: `projects/{project}/locations/{location}/omnichannels/{omnichannel}`", - "type": "string" - }, - "updateTime": { - "description": "Output only. Timestamp when the omnichannel resource was last updated.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "OmnichannelIntegrationConfig": { - "description": "OmnichannelIntegrationConfig contains all App integration configs.", - "id": "OmnichannelIntegrationConfig", - "properties": { - "channelConfigs": { - "additionalProperties": { - "$ref": "OmnichannelIntegrationConfigChannelConfig" - }, - "description": "Optional. Various of configuration for handling App events.", - "type": "object" - }, - "routingConfigs": { - "additionalProperties": { - "$ref": "OmnichannelIntegrationConfigRoutingConfig" - }, - "description": "Optional. The key of routing_configs is a key of `app_configs`, value is a `RoutingConfig`, which contains subscriber's key.", - "type": "object" - }, - "subscriberConfigs": { - "additionalProperties": { - "$ref": "OmnichannelIntegrationConfigSubscriberConfig" - }, - "description": "Optional. Various of subscribers configs.", - "type": "object" - } - }, - "type": "object" - }, - "OmnichannelIntegrationConfigCesAppConfig": { - "description": "Configs for CES app.", - "id": "OmnichannelIntegrationConfigCesAppConfig", - "properties": { - "app": { - "description": "The unique identifier of the CES app. Format: `projects/{project}/locations/{location}/apps/{app}`", - "type": "string" - } - }, - "type": "object" - }, - "OmnichannelIntegrationConfigChannelConfig": { - "description": "ChannelConfig contains config for various of app integration.", - "id": "OmnichannelIntegrationConfigChannelConfig", - "properties": { - "whatsappConfig": { - "$ref": "OmnichannelIntegrationConfigWhatsappConfig", - "description": "WhatsApp config." - } - }, - "type": "object" - }, - "OmnichannelIntegrationConfigRoutingConfig": { - "description": "Routing config specify how/who to route app events to a subscriber.", - "id": "OmnichannelIntegrationConfigRoutingConfig", - "properties": { - "subscriberKey": { - "description": "The key of the subscriber.", - "type": "string" - } - }, - "type": "object" - }, - "OmnichannelIntegrationConfigSubscriberConfig": { - "description": "Configs of subscribers.", - "id": "OmnichannelIntegrationConfigSubscriberConfig", - "properties": { - "cesAppConfig": { - "$ref": "OmnichannelIntegrationConfigCesAppConfig", - "description": "Ces app config." - } - }, - "type": "object" - }, - "OmnichannelIntegrationConfigWhatsappConfig": { - "description": "How Omnichannel should receive/reply events from WhatsApp.", - "id": "OmnichannelIntegrationConfigWhatsappConfig", - "properties": { - "metaBusinessPortfolioId": { - "description": "The Meta Business Portfolio (MBP) ID. https://www.facebook.com/business/help/1710077379203657", - "type": "string" - }, - "phoneNumber": { - "description": "The phone number used for sending/receiving messages.", - "type": "string" - }, - "phoneNumberId": { - "description": "The Phone Number ID associated with the WhatsApp Business Account.", - "type": "string" - }, - "webhookVerifyToken": { - "description": "The verify token configured in the Meta App Dashboard for webhook verification.", - "type": "string" - }, - "whatsappBusinessAccountId": { - "description": "The customer's WhatsApp Business Account (WABA) ID.", - "type": "string" - }, - "whatsappBusinessToken": { - "description": "The access token for authenticating API calls to the WhatsApp Cloud API. https://developers.facebook.com/docs/whatsapp/business-management-api/get-started/#business-integration-system-user-access-tokens", - "type": "string" - } - }, - "type": "object" - }, - "OmnichannelOperationMetadata": { - "description": "Represents the metadata of the long-running operation.", - "id": "OmnichannelOperationMetadata", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "requestedCancellation": { - "description": "Output only. Identifies whether the user has requested cancellation of the operation.", - "readOnly": true, - "type": "boolean" - }, - "statusMessage": { - "description": "Output only. Human-readable status of the operation, if any.", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, "OpenApiTool": { "description": "A remote API tool defined by an OpenAPI schema.", "id": "OpenApiTool", diff --git a/discovery/ces-v1beta.json b/discovery/ces-v1beta.json index 169c51865f6..6ef341602f5 100644 --- a/discovery/ces-v1beta.json +++ b/discovery/ces-v1beta.json @@ -3542,7 +3542,7 @@ } } }, - "revision": "20260429", + "revision": "20260506", "rootUrl": "https://ces.googleapis.com/", "schemas": { "Action": { @@ -5965,6 +5965,14 @@ "readOnly": true, "type": "array" }, + "evaluationMetricsConfigOverride": { + "$ref": "EvaluationMetricsConfig", + "description": "Optional. Overrides metrics config for this specific evaluation." + }, + "evaluationMetricsThresholdOverride": { + "$ref": "EvaluationMetricsThresholds", + "description": "Optional. Overrides metrics thresholds for this specific evaluation." + }, "evaluationRuns": { "description": "Output only. The EvaluationRuns that this Evaluation is associated with.", "items": { @@ -6246,10 +6254,22 @@ "$ref": "Message", "description": "Optional. Check that the agent responded with the correct response. The role \"agent\" is implied." }, + "agentResponseHallucinationMetricsConfigOverride": { + "$ref": "EvaluationMetricsConfigHallucinationMetricsConfig", + "description": "Optional. Overrides for agent_response hallucination metrics." + }, + "agentResponseSemanticSimilarityMetricsConfigOverride": { + "$ref": "EvaluationMetricsConfigSemanticSimilarityMetricsConfig", + "description": "Optional. Overrides for agent_response semantic similarity metrics." + }, "agentTransfer": { "$ref": "AgentTransfer", "description": "Optional. Check that the agent transferred the conversation to a different agent." }, + "expectationLevelMetricsThresholdsOverride": { + "$ref": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsExpectationLevelMetricsThresholds", + "description": "Optional. Overrides metrics at the step level." + }, "mockToolResponse": { "$ref": "ToolResponse", "description": "Optional. The tool response to mock, with the parameters of interest specified. Any parameters not specified will be hallucinated by the LLM." @@ -6258,6 +6278,10 @@ "description": "Optional. A note for this requirement, useful in reporting when specific checks fail. E.g., \"Check_Payment_Tool_Called\".", "type": "string" }, + "skipEvaluation": { + "description": "Optional. If set to true, this specific expectation will not be evaluated.", + "type": "boolean" + }, "toolCall": { "$ref": "ToolCall", "description": "Optional. Check that a specific tool was called with the parameters." @@ -6281,9 +6305,23 @@ "description": "A golden turn defines a single turn in a golden conversation.", "id": "EvaluationGoldenTurn", "properties": { + "hallucinationMetricBehaviorOverride": { + "description": "Optional. Override for turn-level hallucination metric behavior.", + "enum": [ + "HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Unspecified hallucination metric behavior.", + "Disable hallucination metric.", + "Enable hallucination metric." + ], + "type": "string" + }, "rootSpan": { "$ref": "Span", - "description": "Optional. The root span of the golden turn for processing and maintaining audio information." + "description": "Optional. The root span of the golden turn for processing and maintaining audio information. The uri for the audio must contain audio saved in 16Khz sample rate." }, "steps": { "description": "Required. The steps required to replay a golden conversation.", @@ -6291,6 +6329,114 @@ "$ref": "EvaluationStep" }, "type": "array" + }, + "turnLevelMetricsThresholdsOverride": { + "$ref": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsTurnLevelMetricsThresholds", + "description": "Optional. Overrides for turn-level metric thresholds." + } + }, + "type": "object" + }, + "EvaluationMetricsConfig": { + "description": "Configures the metrics for an evaluation.", + "id": "EvaluationMetricsConfig", + "properties": { + "goldenMetricsConfig": { + "$ref": "EvaluationMetricsConfigGoldenMetricsConfig", + "description": "Optional. Configuration for the golden metrics for the evaluation." + }, + "scenarioMetricsConfig": { + "$ref": "EvaluationMetricsConfigScenarioMetricsConfig", + "description": "Optional. Configuration for the scenario metrics for the evaluation." + } + }, + "type": "object" + }, + "EvaluationMetricsConfigExpectationsMetMetricsConfig": { + "description": "Configuration for the expectation level metrics for the evaluation. To disable the metric, set the message but do not set the `enable_expectations_met_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely.", + "id": "EvaluationMetricsConfigExpectationsMetMetricsConfig", + "properties": { + "enableExpectationsMetMetrics": { + "description": "Optional. Whether to calculate the expectation level metrics for the evaluation.", + "type": "boolean" + } + }, + "type": "object" + }, + "EvaluationMetricsConfigGoldenMetricsConfig": { + "description": "Configuration for the golden metrics for the evaluation.", + "id": "EvaluationMetricsConfigGoldenMetricsConfig", + "properties": { + "semanticSimilarityMetricsConfig": { + "$ref": "EvaluationMetricsConfigSemanticSimilarityMetricsConfig", + "description": "Optional. Global configuration for semantic similarity metrics." + }, + "stepToolCorrectnessMetricsConfig": { + "$ref": "EvaluationMetricsConfigToolCorrectnessMetricsConfig", + "description": "Optional. Configuration for step level tool correctness metrics." + }, + "toolCorrectnessMetricsConfig": { + "$ref": "EvaluationMetricsConfigToolCorrectnessMetricsConfig", + "description": "Optional. Configuration for turn level tool correctness metrics." + } + }, + "type": "object" + }, + "EvaluationMetricsConfigHallucinationMetricsConfig": { + "description": "Configuration for the hallucination metrics for the evaluation. To disable the metric, set the message but do not set the `enable_hallucination_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely.", + "id": "EvaluationMetricsConfigHallucinationMetricsConfig", + "properties": { + "enableHallucinationMetrics": { + "description": "Optional. Whether to calculate hallucination metrics for the evaluation.", + "type": "boolean" + } + }, + "type": "object" + }, + "EvaluationMetricsConfigScenarioMetricsConfig": { + "description": "Configuration for the scenario metrics for the evaluation.", + "id": "EvaluationMetricsConfigScenarioMetricsConfig", + "properties": { + "expectationsMetMetricsConfig": { + "$ref": "EvaluationMetricsConfigExpectationsMetMetricsConfig", + "description": "Optional. Configuration for expectation level metrics." + }, + "userGoalMetMetricsConfig": { + "$ref": "EvaluationMetricsConfigUserGoalMetMetricsConfig", + "description": "Optional. Configuration for user goal met metrics." + } + }, + "type": "object" + }, + "EvaluationMetricsConfigSemanticSimilarityMetricsConfig": { + "description": "Configuration for similarity metrics for the evaluation. To disable the metric, set the message but do not set the `enable_semantic_similarity_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely.", + "id": "EvaluationMetricsConfigSemanticSimilarityMetricsConfig", + "properties": { + "enableSemanticSimilarityMetrics": { + "description": "Optional. Whether to calculate semantic similarity metrics for the evaluation.", + "type": "boolean" + } + }, + "type": "object" + }, + "EvaluationMetricsConfigToolCorrectnessMetricsConfig": { + "description": "Configuration for correctness metrics for the evaluation. To disable the metric, set the message but do not set the `enable_tool_correctness_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely.", + "id": "EvaluationMetricsConfigToolCorrectnessMetricsConfig", + "properties": { + "enableToolCorrectnessMetrics": { + "description": "Optional. Whether to calculate tool correctness metrics for the evaluation.", + "type": "boolean" + } + }, + "type": "object" + }, + "EvaluationMetricsConfigUserGoalMetMetricsConfig": { + "description": "Configuration for the user goal met metrics for the evaluation. To disable the metric, set the message but do not set the `enable_user_goal_met_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely.", + "id": "EvaluationMetricsConfigUserGoalMetMetricsConfig", + "properties": { + "enableUserGoalMetMetrics": { + "description": "Optional. Whether to calculate the user goal met metrics for the evaluation.", + "type": "boolean" } }, "type": "object" @@ -7682,6 +7828,10 @@ ], "type": "string" }, + "metricsConfig": { + "$ref": "EvaluationMetricsConfig", + "description": "Optional. Configures the default metrics for evaluations." + }, "scenarioConversationInitiator": { "description": "Optional. Who starts the conversation in a scenario evaluation.", "enum": [ @@ -9988,178 +10138,6 @@ }, "type": "object" }, - "Omnichannel": { - "description": "Represents an Omnichannel resource.", - "id": "Omnichannel", - "properties": { - "createTime": { - "description": "Output only. Timestamp when the omnichannel resource was created.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "description": { - "description": "Optional. Human-readable description of the omnichannel resource.", - "type": "string" - }, - "displayName": { - "description": "Required. Display name of the omnichannel resource.", - "type": "string" - }, - "etag": { - "description": "Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation.", - "readOnly": true, - "type": "string" - }, - "integrationConfig": { - "$ref": "OmnichannelIntegrationConfig", - "description": "Optional. The integration config for the omnichannel resource." - }, - "name": { - "description": "Identifier. The unique identifier of the omnichannel resource. Format: `projects/{project}/locations/{location}/omnichannels/{omnichannel}`", - "type": "string" - }, - "updateTime": { - "description": "Output only. Timestamp when the omnichannel resource was last updated.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "OmnichannelIntegrationConfig": { - "description": "OmnichannelIntegrationConfig contains all App integration configs.", - "id": "OmnichannelIntegrationConfig", - "properties": { - "channelConfigs": { - "additionalProperties": { - "$ref": "OmnichannelIntegrationConfigChannelConfig" - }, - "description": "Optional. Various of configuration for handling App events.", - "type": "object" - }, - "routingConfigs": { - "additionalProperties": { - "$ref": "OmnichannelIntegrationConfigRoutingConfig" - }, - "description": "Optional. The key of routing_configs is a key of `app_configs`, value is a `RoutingConfig`, which contains subscriber's key.", - "type": "object" - }, - "subscriberConfigs": { - "additionalProperties": { - "$ref": "OmnichannelIntegrationConfigSubscriberConfig" - }, - "description": "Optional. Various of subscribers configs.", - "type": "object" - } - }, - "type": "object" - }, - "OmnichannelIntegrationConfigCesAppConfig": { - "description": "Configs for CES app.", - "id": "OmnichannelIntegrationConfigCesAppConfig", - "properties": { - "app": { - "description": "The unique identifier of the CES app. Format: `projects/{project}/locations/{location}/apps/{app}`", - "type": "string" - } - }, - "type": "object" - }, - "OmnichannelIntegrationConfigChannelConfig": { - "description": "ChannelConfig contains config for various of app integration.", - "id": "OmnichannelIntegrationConfigChannelConfig", - "properties": { - "whatsappConfig": { - "$ref": "OmnichannelIntegrationConfigWhatsappConfig", - "description": "WhatsApp config." - } - }, - "type": "object" - }, - "OmnichannelIntegrationConfigRoutingConfig": { - "description": "Routing config specify how/who to route app events to a subscriber.", - "id": "OmnichannelIntegrationConfigRoutingConfig", - "properties": { - "subscriberKey": { - "description": "The key of the subscriber.", - "type": "string" - } - }, - "type": "object" - }, - "OmnichannelIntegrationConfigSubscriberConfig": { - "description": "Configs of subscribers.", - "id": "OmnichannelIntegrationConfigSubscriberConfig", - "properties": { - "cesAppConfig": { - "$ref": "OmnichannelIntegrationConfigCesAppConfig", - "description": "Ces app config." - } - }, - "type": "object" - }, - "OmnichannelIntegrationConfigWhatsappConfig": { - "description": "How Omnichannel should receive/reply events from WhatsApp.", - "id": "OmnichannelIntegrationConfigWhatsappConfig", - "properties": { - "metaBusinessPortfolioId": { - "description": "The Meta Business Portfolio (MBP) ID. https://www.facebook.com/business/help/1710077379203657", - "type": "string" - }, - "phoneNumber": { - "description": "The phone number used for sending/receiving messages.", - "type": "string" - }, - "phoneNumberId": { - "description": "The Phone Number ID associated with the WhatsApp Business Account.", - "type": "string" - }, - "webhookVerifyToken": { - "description": "The verify token configured in the Meta App Dashboard for webhook verification.", - "type": "string" - }, - "whatsappBusinessAccountId": { - "description": "The customer's WhatsApp Business Account (WABA) ID.", - "type": "string" - }, - "whatsappBusinessToken": { - "description": "The access token for authenticating API calls to the WhatsApp Cloud API. https://developers.facebook.com/docs/whatsapp/business-management-api/get-started/#business-integration-system-user-access-tokens", - "type": "string" - } - }, - "type": "object" - }, - "OmnichannelOperationMetadata": { - "description": "Represents the metadata of the long-running operation.", - "id": "OmnichannelOperationMetadata", - "properties": { - "createTime": { - "description": "Output only. The time the operation was created.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "endTime": { - "description": "Output only. The time the operation finished running.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "requestedCancellation": { - "description": "Output only. Identifies whether the user has requested cancellation of the operation.", - "readOnly": true, - "type": "boolean" - }, - "statusMessage": { - "description": "Output only. Human-readable status of the operation, if any.", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, "OpenApiTool": { "description": "A remote API tool defined by an OpenAPI schema.", "id": "OpenApiTool", diff --git a/discovery/chat-v1.json b/discovery/chat-v1.json index bc9761356cd..b82c94734be 100644 --- a/discovery/chat-v1.json +++ b/discovery/chat-v1.json @@ -687,7 +687,7 @@ "type": "string" }, "query": { - "description": "Required. A search query. You can search by using the following parameters: - `create_time` - `customer` - `display_name` - `external_user_allowed` - `last_active_time` - `space_history_state` - `space_type` `create_time` and `last_active_time` accept a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and the supported comparison operators are: `=`, `<`, `>`, `<=`, `>=`. `customer` is required and is used to indicate which customer to fetch spaces from. `customers/my_customer` is the only supported value. `display_name` only accepts the `HAS` (`:`) operator. The text to match is first tokenized into tokens and each token is prefix-matched case-insensitively and independently as a substring anywhere in the space's `display_name`. For example, `Fun Eve` matches `Fun event` or `The evening was fun`, but not `notFun event` or `even`. `external_user_allowed` accepts either `true` or `false`. `space_history_state` only accepts values from the [`historyState`] (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#Space.HistoryState) field of a `space` resource. `space_type` is required and the only valid value is `SPACE`. Across different fields, only `AND` operators are supported. A valid example is `space_type = \"SPACE\" AND display_name:\"Hello\"` and an invalid example is `space_type = \"SPACE\" OR display_name:\"Hello\"`. Among the same field, `space_type` doesn't support `AND` or `OR` operators. `display_name`, 'space_history_state', and 'external_user_allowed' only support `OR` operators. `last_active_time` and `create_time` support both `AND` and `OR` operators. `AND` can only be used to represent an interval, such as `last_active_time < \"2022-01-01T00:00:00+00:00\" AND last_active_time > \"2023-01-01T00:00:00+00:00\"`. The following example queries are valid: ``` customer = \"customers/my_customer\" AND space_type = \"SPACE\" customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND display_name:\"Hello World\" customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND (last_active_time < \"2020-01-01T00:00:00+00:00\" OR last_active_time > \"2022-01-01T00:00:00+00:00\") customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND (display_name:\"Hello World\" OR display_name:\"Fun event\") AND (last_active_time > \"2020-01-01T00:00:00+00:00\" AND last_active_time < \"2022-01-01T00:00:00+00:00\") customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND (create_time > \"2019-01-01T00:00:00+00:00\" AND create_time < \"2020-01-01T00:00:00+00:00\") AND (external_user_allowed = \"true\") AND (space_history_state = \"HISTORY_ON\" OR space_history_state = \"HISTORY_OFF\") ```", + "description": "Required. A search query. You can search by using the following parameters : - `create_time` - `customer` - `display_name` - `external_user_allowed` - `last_active_time` - `space_history_state` - `space_type` `create_time` and `last_active_time` accept a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and the supported comparison operators are: `=`, `<`, `>`, `<=`, `>=`. `customer` is required and is used to indicate which customer to fetch spaces from. `customers/my_customer` is the only supported value. `display_name` only accepts the `HAS` (`:`) operator. The text to match is first tokenized into tokens and each token is prefix-matched case-insensitively and independently as a substring anywhere in the space's `display_name`. For example, `Fun Eve` matches `Fun event` or `The evening was fun`, but not `notFun event` or `even`. `external_user_allowed` accepts either `true` or `false`. `space_history_state` only accepts values from the [`historyState`] (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#Space.HistoryState) field of a `space` resource. `space_type` is required and the only valid value is `SPACE`. Across different fields, only `AND` operators are supported. A valid example is `space_type = \"SPACE\" AND display_name:\"Hello\"` and an invalid example is `space_type = \"SPACE\" OR display_name:\"Hello\"`. Among the same field, `space_type` doesn't support `AND` or `OR` operators. `display_name`, 'space_history_state', and 'external_user_allowed' only support `OR` operators. `last_active_time` and `create_time` support both `AND` and `OR` operators. `AND` can only be used to represent an interval, such as `last_active_time < \"2022-01-01T00:00:00+00:00\" AND last_active_time > \"2023-01-01T00:00:00+00:00\"`. The following example queries are valid: ``` customer = \"customers/my_customer\" AND space_type = \"SPACE\" customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND display_name:\"Hello World\" customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND (last_active_time < \"2020-01-01T00:00:00+00:00\" OR last_active_time > \"2022-01-01T00:00:00+00:00\") customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND (display_name:\"Hello World\" OR display_name:\"Fun event\") AND (last_active_time > \"2020-01-01T00:00:00+00:00\" AND last_active_time < \"2022-01-01T00:00:00+00:00\") customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND (create_time > \"2019-01-01T00:00:00+00:00\" AND create_time < \"2020-01-01T00:00:00+00:00\") AND (external_user_allowed = \"true\") AND (space_history_state = \"HISTORY_ON\" OR space_history_state = \"HISTORY_OFF\") ```", "location": "query", "type": "string" }, @@ -1849,7 +1849,7 @@ } } }, - "revision": "20260503", + "revision": "20260510", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessSettings": { diff --git a/discovery/classroom-v1.json b/discovery/classroom-v1.json index 8876bdc938f..6feddc6bbeb 100644 --- a/discovery/classroom-v1.json +++ b/discovery/classroom-v1.json @@ -4376,7 +4376,7 @@ } } }, - "revision": "20260505", + "revision": "20260511", "rootUrl": "https://classroom.googleapis.com/", "schemas": { "AddOnAttachment": { @@ -4444,6 +4444,16 @@ "description": "Payload for grade update requests.", "id": "AddOnAttachmentStudentSubmission", "properties": { + "courseWorkSubmissionId": { + "description": "Output only. Identifier of the course work submission under which this attachment submission was made.", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Output only. Classroom-assigned identifier for this student submission. This is unique among submissions for the relevant course work and add-on attachment combination.", + "readOnly": true, + "type": "string" + }, "pointsEarned": { "description": "Student grade on this attachment. If unset, no grade was set.", "format": "double", diff --git a/discovery/clouderrorreporting-v1beta1.json b/discovery/clouderrorreporting-v1beta1.json index fae8d5e8783..45e2f7a8cfb 100644 --- a/discovery/clouderrorreporting-v1beta1.json +++ b/discovery/clouderrorreporting-v1beta1.json @@ -21,26 +21,121 @@ "endpointUrl": "https://clouderrorreporting.us.rep.googleapis.com/", "location": "us" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://clouderrorreporting.africa-south1.rep.googleapis.com/", + "location": "africa-south1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://clouderrorreporting.asia-east1.rep.googleapis.com/", "location": "asia-east1" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://clouderrorreporting.asia-east2.rep.googleapis.com/", + "location": "asia-east2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://clouderrorreporting.asia-northeast1.rep.googleapis.com/", + "location": "asia-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://clouderrorreporting.asia-northeast2.rep.googleapis.com/", + "location": "asia-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://clouderrorreporting.asia-northeast3.rep.googleapis.com/", + "location": "asia-northeast3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://clouderrorreporting.asia-south1.rep.googleapis.com/", + "location": "asia-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://clouderrorreporting.asia-south2.rep.googleapis.com/", + "location": "asia-south2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://clouderrorreporting.asia-southeast1.rep.googleapis.com/", + "location": "asia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://clouderrorreporting.asia-southeast2.rep.googleapis.com/", + "location": "asia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://clouderrorreporting.asia-southeast3.rep.googleapis.com/", + "location": "asia-southeast3" + }, { "description": "Regional Endpoint", "endpointUrl": "https://clouderrorreporting.australia-southeast1.rep.googleapis.com/", "location": "australia-southeast1" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://clouderrorreporting.australia-southeast2.rep.googleapis.com/", + "location": "australia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://clouderrorreporting.europe-central2.rep.googleapis.com/", + "location": "europe-central2" + }, { "description": "Regional Endpoint", "endpointUrl": "https://clouderrorreporting.europe-north1.rep.googleapis.com/", "location": "europe-north1" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://clouderrorreporting.europe-north2.rep.googleapis.com/", + "location": "europe-north2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://clouderrorreporting.europe-southwest1.rep.googleapis.com/", + "location": "europe-southwest1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://clouderrorreporting.europe-west1.rep.googleapis.com/", "location": "europe-west1" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://clouderrorreporting.europe-west10.rep.googleapis.com/", + "location": "europe-west10" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://clouderrorreporting.europe-west12.rep.googleapis.com/", + "location": "europe-west12" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://clouderrorreporting.europe-west2.rep.googleapis.com/", + "location": "europe-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://clouderrorreporting.europe-west3.rep.googleapis.com/", + "location": "europe-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://clouderrorreporting.europe-west4.rep.googleapis.com/", + "location": "europe-west4" + }, { "description": "Regional Endpoint", "endpointUrl": "https://clouderrorreporting.europe-west6.rep.googleapis.com/", @@ -51,6 +146,66 @@ "endpointUrl": "https://clouderrorreporting.europe-west8.rep.googleapis.com/", "location": "europe-west8" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://clouderrorreporting.europe-west9.rep.googleapis.com/", + "location": "europe-west9" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://clouderrorreporting.me-central1.rep.googleapis.com/", + "location": "me-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://clouderrorreporting.me-central2.rep.googleapis.com/", + "location": "me-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://clouderrorreporting.me-west1.rep.googleapis.com/", + "location": "me-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://clouderrorreporting.northamerica-northeast1.rep.googleapis.com/", + "location": "northamerica-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://clouderrorreporting.northamerica-northeast2.rep.googleapis.com/", + "location": "northamerica-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://clouderrorreporting.northamerica-south1.rep.googleapis.com/", + "location": "northamerica-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://clouderrorreporting.southamerica-east1.rep.googleapis.com/", + "location": "southamerica-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://clouderrorreporting.southamerica-west1.rep.googleapis.com/", + "location": "southamerica-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://clouderrorreporting.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://clouderrorreporting.us-central2.rep.googleapis.com/", + "location": "us-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://clouderrorreporting.us-east1.rep.googleapis.com/", + "location": "us-east1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://clouderrorreporting.us-east4.rep.googleapis.com/", @@ -58,33 +213,43 @@ }, { "description": "Regional Endpoint", - "endpointUrl": "https://clouderrorreporting.us-west8.rep.googleapis.com/", - "location": "us-west8" + "endpointUrl": "https://clouderrorreporting.us-east5.rep.googleapis.com/", + "location": "us-east5" }, { "description": "Regional Endpoint", - "endpointUrl": "https://clouderrorreporting.asia-northeast2.rep.googleapis.com/", - "location": "asia-northeast2" + "endpointUrl": "https://clouderrorreporting.us-east7.rep.googleapis.com/", + "location": "us-east7" }, { "description": "Regional Endpoint", - "endpointUrl": "https://clouderrorreporting.asia-northeast3.rep.googleapis.com/", - "location": "asia-northeast3" + "endpointUrl": "https://clouderrorreporting.us-south1.rep.googleapis.com/", + "location": "us-south1" }, { "description": "Regional Endpoint", - "endpointUrl": "https://clouderrorreporting.asia-south1.rep.googleapis.com/", - "location": "asia-south1" + "endpointUrl": "https://clouderrorreporting.us-west1.rep.googleapis.com/", + "location": "us-west1" }, { "description": "Regional Endpoint", - "endpointUrl": "https://clouderrorreporting.asia-south2.rep.googleapis.com/", - "location": "asia-south2" + "endpointUrl": "https://clouderrorreporting.us-west2.rep.googleapis.com/", + "location": "us-west2" }, { "description": "Regional Endpoint", - "endpointUrl": "https://clouderrorreporting.asia-southeast1.rep.googleapis.com/", - "location": "asia-southeast1" + "endpointUrl": "https://clouderrorreporting.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://clouderrorreporting.us-west4.rep.googleapis.com/", + "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://clouderrorreporting.us-west8.rep.googleapis.com/", + "location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -800,7 +965,7 @@ } } }, - "revision": "20260424", + "revision": "20260508", "rootUrl": "https://clouderrorreporting.googleapis.com/", "schemas": { "DeleteEventsResponse": { diff --git a/discovery/cloudidentity-v1.json b/discovery/cloudidentity-v1.json index dfaeef7e137..ff11e4b4ddf 100644 --- a/discovery/cloudidentity-v1.json +++ b/discovery/cloudidentity-v1.json @@ -2178,6 +2178,49 @@ }, "policies": { "methods": { + "create": { + "description": "Create a policy.", + "flatPath": "v1/policies", + "httpMethod": "POST", + "id": "cloudidentity.policies.create", + "parameterOrder": [], + "parameters": {}, + "path": "v1/policies", + "request": { + "$ref": "Policy" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-identity.policies" + ] + }, + "delete": { + "description": "Delete a policy.", + "flatPath": "v1/policies/{policiesId}", + "httpMethod": "DELETE", + "id": "cloudidentity.policies.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the policy to delete. Format: `policies/{policy}`.", + "location": "path", + "pattern": "^policies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-identity.policies" + ] + }, "get": { "description": "Get a policy.", "flatPath": "v1/policies/{policiesId}", @@ -2236,11 +2279,39 @@ "https://www.googleapis.com/auth/cloud-identity.policies", "https://www.googleapis.com/auth/cloud-identity.policies.readonly" ] + }, + "patch": { + "description": "Update a policy.", + "flatPath": "v1/policies/{policiesId}", + "httpMethod": "PATCH", + "id": "cloudidentity.policies.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Identifier. The [resource name](https://cloud.google.com/apis/design/resource_names) of the Policy. Format: policies/{policy}.", + "location": "path", + "pattern": "^policies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Policy" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-identity.policies" + ] } } } }, - "revision": "20260113", + "revision": "20260513", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AddIdpCredentialOperationMetadata": { diff --git a/discovery/cloudkms-v1.json b/discovery/cloudkms-v1.json index de5549bee49..26b403171eb 100644 --- a/discovery/cloudkms-v1.json +++ b/discovery/cloudkms-v1.json @@ -91,23 +91,23 @@ }, { "description": "Regional Endpoint", - "endpointUrl": "https://cloudkms.northamerica-northeast1.rep.googleapis.com/", - "location": "northamerica-northeast1" + "endpointUrl": "https://cloudkms.europe-west3.rep.googleapis.com/", + "location": "europe-west3" }, { "description": "Regional Endpoint", - "endpointUrl": "https://cloudkms.northamerica-northeast2.rep.googleapis.com/", - "location": "northamerica-northeast2" + "endpointUrl": "https://cloudkms.us-west8.rep.googleapis.com/", + "location": "us-west8" }, { "description": "Regional Endpoint", - "endpointUrl": "https://cloudkms.europe-west3.rep.googleapis.com/", - "location": "europe-west3" + "endpointUrl": "https://cloudkms.northamerica-northeast1.rep.googleapis.com/", + "location": "northamerica-northeast1" }, { "description": "Regional Endpoint", - "endpointUrl": "https://cloudkms.us-west8.rep.googleapis.com/", - "location": "us-west8" + "endpointUrl": "https://cloudkms.northamerica-northeast2.rep.googleapis.com/", + "location": "northamerica-northeast2" }, { "description": "Regional Endpoint", @@ -2948,7 +2948,7 @@ } } }, - "revision": "20260423", + "revision": "20260506", "rootUrl": "https://cloudkms.googleapis.com/", "schemas": { "AddQuorumMember": { diff --git a/discovery/cloudnumberregistry-v1alpha.json b/discovery/cloudnumberregistry-v1alpha.json new file mode 100644 index 00000000000..d4c544c5181 --- /dev/null +++ b/discovery/cloudnumberregistry-v1alpha.json @@ -0,0 +1,2534 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." + } + } + } + }, + "basePath": "", + "baseUrl": "https://cloudnumberregistry.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Cloud Number Registry", + "description": "", + "discoveryVersion": "v1", + "documentationLink": "https://docs.cloud.google.com/number-registry/reference/rest", + "fullyEncodeReservedExpansion": true, + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "cloudnumberregistry:v1alpha", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://cloudnumberregistry.mtls.googleapis.com/", + "name": "cloudnumberregistry", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "description": "Data format for response.", + "enum": [ + "json", + "media", + "proto" + ], + "enumDescriptions": [ + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" + ], + "location": "query", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", + "location": "query", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "projects": { + "resources": { + "locations": { + "methods": { + "get": { + "description": "Gets information about a location.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name for the location.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "Location" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", + "flatPath": "v1alpha/projects/{projectsId}/locations", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "extraLocationTypes": { + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", + "location": "query", + "repeated": true, + "type": "string" + }, + "filter": { + "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "name": { + "description": "The resource that owns the locations collection, if applicable.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The maximum number of results to return. If not set, the service selects a default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}/locations", + "response": { + "$ref": "ListLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "customRanges": { + "methods": { + "create": { + "description": "Creates a new CustomRange in a given project and location.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges", + "httpMethod": "POST", + "id": "cloudnumberregistry.projects.locations.customRanges.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "customRangeId": { + "description": "Required. Id of the requesting object.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Value for parent.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+parent}/customRanges", + "request": { + "$ref": "CustomRange" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single CustomRange.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges/{customRangesId}", + "httpMethod": "DELETE", + "id": "cloudnumberregistry.projects.locations.customRanges.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "Optional. If set to true, all associated resources will be deleted.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customRanges/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "findFreeIpRanges": { + "description": "Finds free IP ranges in a single CustomRange.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges/{customRangesId}:findFreeIpRanges", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.customRanges.findFreeIpRanges", + "parameterOrder": [ + "name" + ], + "parameters": { + "cidrPrefixLength": { + "description": "Required. The prefix length of the free IP ranges to find.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "name": { + "description": "Required. Name of the CustomRange.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customRanges/[^/]+$", + "required": true, + "type": "string" + }, + "rangeCount": { + "description": "Optional. The number of free IP ranges to find.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}:findFreeIpRanges", + "response": { + "$ref": "FindCustomRangeFreeIpRangesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single CustomRange.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges/{customRangesId}", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.customRanges.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customRanges/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "CustomRange" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists CustomRanges in a given project and location.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.customRanges.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filtering results.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent value for ListCustomRangesRequest", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/customRanges", + "response": { + "$ref": "ListCustomRangesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single CustomRange.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges/{customRangesId}", + "httpMethod": "PATCH", + "id": "cloudnumberregistry.projects.locations.customRanges.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Identifier. name of resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customRanges/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the CustomRange resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "CustomRange" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "showUtilization": { + "description": "Gets the details of a single CustomRange and its utilization.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges/{customRangesId}:showUtilization", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.customRanges.showUtilization", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customRanges/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:showUtilization", + "response": { + "$ref": "ShowCustomRangeUtilizationResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "discoveredRanges": { + "methods": { + "findFreeIpRanges": { + "description": "Finds free IP ranges in a single DiscoveredRange.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredRanges/{discoveredRangesId}:findFreeIpRanges", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.discoveredRanges.findFreeIpRanges", + "parameterOrder": [ + "name" + ], + "parameters": { + "cidrPrefixLength": { + "description": "Required. The prefix length of the free IP ranges to find.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "name": { + "description": "Required. Name of the DiscoveredRange.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/discoveredRanges/[^/]+$", + "required": true, + "type": "string" + }, + "rangeCount": { + "description": "Optional. The number of free IP ranges to find.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}:findFreeIpRanges", + "response": { + "$ref": "FindDiscoveredRangeFreeIpRangesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single DiscoveredRange.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredRanges/{discoveredRangesId}", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.discoveredRanges.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/discoveredRanges/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "DiscoveredRange" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists DiscoveredRanges in a given project and location.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredRanges", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.discoveredRanges.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filtering results.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent value for ListDiscoveredRangesRequest", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/discoveredRanges", + "response": { + "$ref": "ListDiscoveredRangesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "showUtilization": { + "description": "Gets the details of a single DiscoveredRange and its utilization.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredRanges/{discoveredRangesId}:showUtilization", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.discoveredRanges.showUtilization", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/discoveredRanges/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:showUtilization", + "response": { + "$ref": "ShowDiscoveredRangeUtilizationResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "ipamAdminScopes": { + "methods": { + "checkAvailability": { + "description": "Checks the availability of IPAM admin scopes in a given project and location.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes:checkAvailability", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.ipamAdminScopes.checkAvailability", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Parent value for the IpamAdminScopes.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "scopes": { + "description": "Required. The scopes of the IpamAdminScopes to look for.", + "location": "query", + "repeated": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/ipamAdminScopes:checkAvailability", + "response": { + "$ref": "CheckAvailabilityIpamAdminScopesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "cleanup": { + "description": "Cleans up a single IpamAdminScope.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes/{ipamAdminScopesId}:cleanup", + "httpMethod": "POST", + "id": "cloudnumberregistry.projects.locations.ipamAdminScopes.cleanup", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ipamAdminScopes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:cleanup", + "request": { + "$ref": "CleanupIpamAdminScopeRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a new IpamAdminScope in a given project and location.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes", + "httpMethod": "POST", + "id": "cloudnumberregistry.projects.locations.ipamAdminScopes.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "ipamAdminScopeId": { + "description": "Required. Id of the requesting object.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Value for parent.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+parent}/ipamAdminScopes", + "request": { + "$ref": "IpamAdminScope" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single IpamAdminScope.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes/{ipamAdminScopesId}", + "httpMethod": "DELETE", + "id": "cloudnumberregistry.projects.locations.ipamAdminScopes.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "Optional. If set to true, all associated resources will be deleted.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ipamAdminScopes/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "disable": { + "description": "Disables a single IpamAdminScope.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes/{ipamAdminScopesId}:disable", + "httpMethod": "POST", + "id": "cloudnumberregistry.projects.locations.ipamAdminScopes.disable", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ipamAdminScopes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:disable", + "request": { + "$ref": "DisableIpamAdminScopeRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single IpamAdminScope.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes/{ipamAdminScopesId}", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.ipamAdminScopes.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ipamAdminScopes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "IpamAdminScope" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List all IPAM admin scopes in a given project and location.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.ipamAdminScopes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filtering results", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent value for ListIpamAdminScopesRequest", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/ipamAdminScopes", + "response": { + "$ref": "ListIpamAdminScopesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single IpamAdminScope.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes/{ipamAdminScopesId}", + "httpMethod": "PATCH", + "id": "cloudnumberregistry.projects.locations.ipamAdminScopes.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Identifier. name of resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ipamAdminScopes/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the IpamAdminScope resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "IpamAdminScope" + }, + "response": { + "$ref": "Operation" + }, + "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": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "cloudnumberregistry.projects.locations.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:cancel", + "request": { + "$ref": "CancelOperationRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "cloudnumberregistry.projects.locations.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. 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": "v1alpha/{+name}/operations", + "response": { + "$ref": "ListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "realms": { + "methods": { + "create": { + "description": "Creates a new Realm in a given project and location.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/realms", + "httpMethod": "POST", + "id": "cloudnumberregistry.projects.locations.realms.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Value for parent.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "realmId": { + "description": "Required. Id of the requesting object.", + "location": "query", + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+parent}/realms", + "request": { + "$ref": "Realm" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single Realm.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}", + "httpMethod": "DELETE", + "id": "cloudnumberregistry.projects.locations.realms.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "Optional. If set to true, all associated resources will be deleted.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single Realm.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.realms.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Optional. The view of the Realm.", + "enum": [ + "REALM_VIEW_UNSPECIFIED", + "BASIC", + "FULL", + "AGGREGATE" + ], + "enumDescriptions": [ + "Unspecified view. Defaults to BASIC.", + "Basic view.", + "Full view. Includes the same data as the BASIC view.", + "Aggregate includes data about the child resources of the Realm." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "Realm" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Realms in a given project and location.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/realms", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.realms.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filtering results", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent value for ListRealmsRequest", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Optional. The view of the Realm.", + "enum": [ + "REALM_VIEW_UNSPECIFIED", + "BASIC", + "FULL", + "AGGREGATE" + ], + "enumDescriptions": [ + "Unspecified view. Defaults to BASIC.", + "Basic view.", + "Full view. Includes the same data as the BASIC view.", + "Aggregate includes data about the child resources of the Realm." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+parent}/realms", + "response": { + "$ref": "ListRealmsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single Realm.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}", + "httpMethod": "PATCH", + "id": "cloudnumberregistry.projects.locations.realms.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Identifier. Unique name/ID of the realm", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the Realm resource by the update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "Realm" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "registryBooks": { + "methods": { + "create": { + "description": "Creates a new RegistryBook in a given project and location.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/registryBooks", + "httpMethod": "POST", + "id": "cloudnumberregistry.projects.locations.registryBooks.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Value for parent.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "registryBookId": { + "description": "Required. Id of the requesting object.", + "location": "query", + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+parent}/registryBooks", + "request": { + "$ref": "RegistryBook" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single RegistryBook.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/registryBooks/{registryBooksId}", + "httpMethod": "DELETE", + "id": "cloudnumberregistry.projects.locations.registryBooks.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "Optional. If set to true, all associated resources will be deleted.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/registryBooks/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single RegistryBook.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/registryBooks/{registryBooksId}", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.registryBooks.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/registryBooks/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Optional. The view of the RegistryBook.", + "enum": [ + "REGISTRY_BOOK_VIEW_UNSPECIFIED", + "BASIC", + "FULL", + "AGGREGATE" + ], + "enumDescriptions": [ + "Unspecified view. Defaults to BASIC.", + "Basic view.", + "Full view. Includes the same data as the BASIC view.", + "Aggregate includes data about the child resources of the RegistryBook." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "RegistryBook" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists RegistryBooks in a given project and location.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/registryBooks", + "httpMethod": "GET", + "id": "cloudnumberregistry.projects.locations.registryBooks.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filtering results", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent value for ListRegistryBooksRequest", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Optional. The view of the RegistryBook.", + "enum": [ + "REGISTRY_BOOK_VIEW_UNSPECIFIED", + "BASIC", + "FULL", + "AGGREGATE" + ], + "enumDescriptions": [ + "Unspecified view. Defaults to BASIC.", + "Basic view.", + "Full view. Includes the same data as the BASIC view.", + "Aggregate includes data about the child resources of the RegistryBook." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+parent}/registryBooks", + "response": { + "$ref": "ListRegistryBooksResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single RegistryBook.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/registryBooks/{registryBooksId}", + "httpMethod": "PATCH", + "id": "cloudnumberregistry.projects.locations.registryBooks.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Identifier. name of resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/registryBooks/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the RegistryBook resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "RegistryBook" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "searchIpResources": { + "description": "Searches IP resources in a given RegistryBook.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/registryBooks/{registryBooksId}:searchIpResources", + "httpMethod": "POST", + "id": "cloudnumberregistry.projects.locations.registryBooks.searchIpResources", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the RegistryBook to search in.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/registryBooks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:searchIpResources", + "request": { + "$ref": "SearchIpResourcesRequest" + }, + "response": { + "$ref": "SearchIpResourcesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + }, + "revision": "20260506", + "rootUrl": "https://cloudnumberregistry.googleapis.com/", + "schemas": { + "AggregatedData": { + "description": "Aggregated data for the RegistryBook.", + "id": "AggregatedData", + "properties": { + "customRangesCount": { + "description": "Output only. Number of custom ranges in the RegistryBook.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "customRealmsCount": { + "description": "Output only. Number of custom realms in the RegistryBook.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "discoveredRangesCount": { + "description": "Output only. Number of discovered ranges in the RegistryBook.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "discoveredRealmsCount": { + "description": "Output only. Number of discovered realms in the RegistryBook.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "uniqueScopesCount": { + "description": "Output only. Number of scopes unique to the RegistryBook.", + "format": "int32", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, + "Attribute": { + "description": "Message describing Attribute object", + "id": "Attribute", + "properties": { + "key": { + "description": "Required. Key of attribute", + "type": "string" + }, + "value": { + "description": "Required. Value of attribute", + "type": "string" + } + }, + "type": "object" + }, + "CancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "id": "CancelOperationRequest", + "properties": {}, + "type": "object" + }, + "CheckAvailabilityIpamAdminScopesResponse": { + "description": "Message for response to checking the availability of IpamAdminScopes", + "id": "CheckAvailabilityIpamAdminScopesResponse", + "properties": { + "scopeAvailabilities": { + "description": "The details of the requested scopes.", + "items": { + "$ref": "IpamAdminScopeAvailability" + }, + "type": "array" + } + }, + "type": "object" + }, + "CleanupIpamAdminScopeRequest": { + "description": "Message for cleaning up a IpamAdminScope", + "id": "CleanupIpamAdminScopeRequest", + "properties": { + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "type": "string" + } + }, + "type": "object" + }, + "CustomRange": { + "description": "Message describing CustomRange object", + "id": "CustomRange", + "properties": { + "attributes": { + "description": "Optional. The attributes of the CustomRange.", + "items": { + "$ref": "Attribute" + }, + "type": "array" + }, + "description": { + "description": "Optional. Description of the CustomRange.", + "type": "string" + }, + "ipv4CidrRange": { + "description": "Optional. The IPv4 CIDR range of the CustomRange.", + "type": "string" + }, + "ipv6CidrRange": { + "description": "Optional. The IPv6 CIDR range of the CustomRange.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels as key value pairs", + "type": "object" + }, + "name": { + "description": "Required. Identifier. name of resource", + "type": "string" + }, + "parentRange": { + "description": "Optional. The parent range of the CustomRange. Do not allow setting parent range if realm is specified. Format must follow this pattern: projects/{project}/locations/{location}/customRanges/{custom_range}", + "type": "string" + }, + "realm": { + "description": "Optional. The realm of the CustomRange. The realm must be in the same project as the custom range. Do not allow setting realm if parent range is specified, since the realm should be inherited from the parent range. Format must follow this pattern: projects/{project}/locations/{location}/realms/{realm}", + "type": "string" + }, + "registryBook": { + "description": "Output only. The registry book of the CustomRange. This field is inherited from the realm or parent range depending on which one is specified.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "DisableIpamAdminScopeRequest": { + "description": "Message for disabling a IpamAdminScope", + "id": "DisableIpamAdminScopeRequest", + "properties": { + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "type": "string" + } + }, + "type": "object" + }, + "DiscoveredRange": { + "description": "Message describing DiscoveredRange object", + "id": "DiscoveredRange", + "properties": { + "attributes": { + "description": "Optional. The attributes of the DiscoveredRange.", + "items": { + "$ref": "Attribute" + }, + "type": "array" + }, + "childCidrOverlapAllowed": { + "description": "Output only. If true, allow child ranges of this range to overlap with each other.", + "readOnly": true, + "type": "boolean" + }, + "createTime": { + "description": "Output only. [Output only] Create time stamp", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. Description of the DiscoveredRange.", + "type": "string" + }, + "discoveryMetadata": { + "$ref": "DiscoveryMetadata", + "description": "Output only. Owner metadata for this DiscoveredRange. A unique set of metadata is associated with each DiscoveredRange. If an IP range is shared by multiple resources (e.g., an Address resource and an Instance resource, or multiple ForwardingRules),separate DiscoveredRanges are created, each with a distinct owner. This ensures each DiscoveredRange has its own unique set of attributes, labels, create time and update time.", + "readOnly": true + }, + "ipv4CidrRange": { + "description": "Optional. The IPv4 CIDR range of the DiscoveredRange.", + "type": "string" + }, + "ipv6CidrRange": { + "description": "Optional. The IPv6 CIDR range of the DiscoveredRange.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels as key value pairs", + "type": "object" + }, + "name": { + "description": "Required. Identifier. Name of the DiscoveredRange.", + "type": "string" + }, + "parentRange": { + "description": "Optional. The parent range of the DiscoveredRange.", + "type": "string" + }, + "realm": { + "description": "Optional. The realm of the DiscoveredRange.", + "type": "string" + }, + "registryBook": { + "description": "Output only. The registry book of the DiscoveredRange.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. [Output only] Update time stamp", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "DiscoveryMetadata": { + "description": "Discovery metadata of the discovered resource.", + "id": "DiscoveryMetadata", + "properties": { + "createTime": { + "description": "Output only. The time when the resource was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "eventTime": { + "description": "Output only. The time when the event happened.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "resource": { + "description": "Output only. The resource name of the discovered resource, should be API-agnostic. Example: \"projects/{project_number}/networks/{network_id}\".", + "readOnly": true, + "type": "string" + }, + "resourceUri": { + "description": "Output only. The resource uri of the discovered resource.", + "readOnly": true, + "type": "string" + }, + "sourceId": { + "description": "Output only. The canonical google.aip.dev/122 name of the source resource.", + "readOnly": true, + "type": "string" + }, + "sourceSubId": { + "description": "Output only. A single source resource can be the source of multiple CNR resources. This sub_id is used to distinguish between the different CNR resources derived from the same upstream resource. For example, a single subnetwork can be the source of multiple ranges, one for each protocol. In this case, the sub_id could be \"private-ipv4\" or \"private-ipv6\".", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The state of the resource.", + "enum": [ + "RESOURCE_STATE_UNSPECIFIED", + "INVALID", + "EXISTS", + "DOES_NOT_EXIST", + "ERROR" + ], + "enumDescriptions": [ + "Unspecified state.", + "The resource is in an invalid state.", + "The resource exists in the backing store (is not tombstoned or completely missing) and there were no failures reading out the resource level metadata.", + "Resource does not exist or has been deleted or soft-deleted.", + "There was an error reading out the resource level metadata." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time when the resource was last modified.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Empty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "FindCustomRangeFreeIpRangesResponse": { + "description": "Message for the response to finding free IP ranges.", + "id": "FindCustomRangeFreeIpRangesResponse", + "properties": { + "freeIpCidrRanges": { + "description": "Output only. Free IP CIDR ranges found in the CustomRange.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "FindDiscoveredRangeFreeIpRangesResponse": { + "description": "Message for the response to finding free IP ranges.", + "id": "FindDiscoveredRangeFreeIpRangesResponse", + "properties": { + "freeIpCidrRanges": { + "description": "Output only. Free IP CIDR ranges found in the DiscoveredRange.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "IpamAdminScope": { + "description": "Message describing IpamAdminScope object", + "id": "IpamAdminScope", + "properties": { + "createTime": { + "description": "Output only. [Output only] Create time stamp", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "enabledAddonPlatforms": { + "description": "Required. Addon platforms that are enabled for this IPAM admin scope. Cloud Number Registry only discovers the IP addresses from the enabled platforms.", + "items": { + "enum": [ + "ADD_ON_PLATFORM_UNSPECIFIED", + "COMPUTE_ENGINE", + "GCE" + ], + "enumDeprecated": [ + false, + false, + true + ], + "enumDescriptions": [ + "Unspecified add-on platform.", + "Google Compute Engine.", + "Deprecated: Use COMPUTE_ENGINE instead." + ], + "type": "string" + }, + "type": "array" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels as key value pairs", + "type": "object" + }, + "name": { + "description": "Required. Identifier. name of resource", + "type": "string" + }, + "scopes": { + "description": "Required. Administrative scopes enabled for IP address discovery and management. For example, \"organizations/1234567890\". Minimum of 1 scope is required. In preview, only one organization scope is allowed.", + "items": { + "type": "string" + }, + "type": "array" + }, + "state": { + "description": "Output only. State of resource discovery pipeline.", + "enum": [ + "DISCOVERY_PIPELINE_STATE_UNSPECIFIED", + "INTERNAL_FAILURE", + "FAILED", + "SETUP_IN_PROGRESS", + "READY_FOR_USE", + "DELETING_IN_PROGRESS", + "UPDATING", + "RECOVERING", + "DISABLED", + "DELETION_COMPLETED", + "CLEANUP_IN_PROGRESS", + "READY_FOR_DELETION" + ], + "enumDescriptions": [ + "Unspecified state.", + "Internal failure.", + "Failure.", + "Setup in progress.", + "Ready for use.", + "Deleting in progress.", + "Updating.", + "Recovering.", + "Disabled.", + "Deleting completed.", + "Cleanup in progress.", + "Ready for deletion." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. [Output only] Update time stamp", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "IpamAdminScopeAvailability": { + "description": "Message for the availability of an IpamAdminScope", + "id": "IpamAdminScopeAvailability", + "properties": { + "adminProject": { + "description": "The admin project of the IpamAdminScope if it exists.", + "format": "int64", + "type": "string" + }, + "availability": { + "description": "The availability of the scope.", + "enum": [ + "AVAILABILITY_UNSPECIFIED", + "AVAILABLE", + "UNAVAILABLE" + ], + "enumDescriptions": [ + "Unspecified availability.", + "The scope is available.", + "The scope is not available." + ], + "type": "string" + }, + "scope": { + "description": "The scope of the IpamAdminScope.", + "type": "string" + } + }, + "type": "object" + }, + "ListCustomRangesResponse": { + "description": "Message for response to listing CustomRanges", + "id": "ListCustomRangesResponse", + "properties": { + "customRanges": { + "description": "The list of CustomRange", + "items": { + "$ref": "CustomRange" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListDiscoveredRangesResponse": { + "description": "Message for response to listing DiscoveredRanges", + "id": "ListDiscoveredRangesResponse", + "properties": { + "discoveredRanges": { + "description": "The list of DiscoveredRange", + "items": { + "$ref": "DiscoveredRange" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListIpamAdminScopesResponse": { + "description": "Message for response to listing ipamAdminScopes", + "id": "ListIpamAdminScopesResponse", + "properties": { + "ipamAdminScopes": { + "description": "The list of IpamAdminScope", + "items": { + "$ref": "IpamAdminScope" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListLocationsResponse": { + "description": "The response message for Locations.ListLocations.", + "id": "ListLocationsResponse", + "properties": { + "locations": { + "description": "A list of locations that matches the specified filter in the request.", + "items": { + "$ref": "Location" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + } + }, + "type": "object" + }, + "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "ListOperationsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "Operation" + }, + "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListRealmsResponse": { + "description": "Message for response to listing Realms", + "id": "ListRealmsResponse", + "properties": { + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + }, + "realms": { + "description": "The list of Realm", + "items": { + "$ref": "Realm" + }, + "type": "array" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListRegistryBooksResponse": { + "description": "Message for response to listing RegistryBooks", + "id": "ListRegistryBooksResponse", + "properties": { + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + }, + "registryBooks": { + "description": "The list of RegistryBook", + "items": { + "$ref": "RegistryBook" + }, + "type": "array" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Location": { + "description": "A resource that represents a Google Cloud location.", + "id": "Location", + "properties": { + "displayName": { + "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", + "type": "object" + }, + "locationId": { + "description": "The canonical id for this location. For example: `\"us-east1\"`.", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata. For example the available capacity at the given location.", + "type": "object" + }, + "name": { + "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", + "type": "string" + } + }, + "type": "object" + }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "Operation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "type": "boolean" + }, + "error": { + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + }, + "OperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "OperationMetadata", + "properties": { + "apiVersion": { + "description": "Output only. API version used to start the operation.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time the operation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "requestedCancellation": { + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "readOnly": true, + "type": "boolean" + }, + "statusMessage": { + "description": "Output only. Human-readable status of the operation, if any.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "Output only. Server-defined resource path for the target of the operation.", + "readOnly": true, + "type": "string" + }, + "verb": { + "description": "Output only. Name of the verb executed by the operation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Range": { + "description": "Message describing either a CustomRange or a DiscoveredRange.", + "id": "Range", + "properties": { + "customRange": { + "$ref": "CustomRange", + "description": "A custom range." + }, + "discoveredRange": { + "$ref": "DiscoveredRange", + "description": "A discovered range." + }, + "utilization": { + "$ref": "RangeUtilization", + "description": "The utilization of the range." + } + }, + "type": "object" + }, + "RangeUtilization": { + "description": "Message for the utilization of an IP range", + "id": "RangeUtilization", + "properties": { + "totalConsumed": { + "description": "Output only. The total number of IP addresses consumed in the range.", + "readOnly": true, + "type": "string" + }, + "totalProduced": { + "description": "Output only. The total number of IP addresses produced in the range.", + "readOnly": true, + "type": "string" + }, + "usage": { + "description": "Output only. The usage of the range as a percentage. This is marked as optional so that we have presence tracking and API responses show 0.0 instead of NULL.", + "format": "double", + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, + "Realm": { + "description": "Message describing Realm object", + "id": "Realm", + "properties": { + "aggregatedData": { + "$ref": "RealmAggregatedData", + "description": "Output only. Aggregated data for the Realm. Populated only when the view is AGGREGATE.", + "readOnly": true + }, + "createTime": { + "description": "Output only. [Output only] Create time stamp", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "discoveryMetadata": { + "$ref": "DiscoveryMetadata", + "description": "Output only. Discovery metadata of the realm.", + "readOnly": true + }, + "ipVersion": { + "description": "Optional. IP version of the realm.", + "enum": [ + "IP_VERSION_UNSPECIFIED", + "IPV4", + "IPV6" + ], + "enumDescriptions": [ + "Unspecified IP version.", + "IPv4 IP version.", + "IPv6 IP version." + ], + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels as key value pairs", + "type": "object" + }, + "managementType": { + "description": "Required. Management type of realm.", + "enum": [ + "MANAGEMENT_TYPE_UNSPECIFIED", + "CNR", + "USER" + ], + "enumDescriptions": [ + "Unspecified management type.", + "Managed by Cloud Number Registry.", + "Managed by User." + ], + "type": "string" + }, + "name": { + "description": "Required. Identifier. Unique name/ID of the realm", + "type": "string" + }, + "registryBook": { + "description": "Required. URI of the registry book that claims the realm.", + "type": "string" + }, + "trafficType": { + "description": "Required. Traffic type of realm.", + "enum": [ + "TRAFFIC_TYPE_UNSPECIFIED", + "UNSET", + "INTERNET", + "PRIVATE", + "LINKLOCAL" + ], + "enumDescriptions": [ + "Unspecified traffic type.", + "Unset traffic type.", + "Internet traffic.", + "Private traffic.", + "Linklocal traffic." + ], + "type": "string" + }, + "updateTime": { + "description": "Output only. [Output only] Update time stamp", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "RealmAggregatedData": { + "description": "Aggregated data for the Realm.", + "id": "RealmAggregatedData", + "properties": { + "customRangesCount": { + "description": "Output only. Number of custom ranges in the Realm.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "discoveredRangesCount": { + "description": "Output only. Number of discovered ranges in the Realm.", + "format": "int32", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, + "RegistryBook": { + "description": "Message describing RegistryBook object", + "id": "RegistryBook", + "properties": { + "aggregatedData": { + "$ref": "AggregatedData", + "description": "Output only. Aggregated data for the RegistryBook. Populated only when the view is AGGREGATE.", + "readOnly": true + }, + "claimedScopes": { + "description": "Optional. List of scopes claimed by the RegistryBook. In Preview, Only project scope is supported. Each scope is in the format of projects/{project}. Each scope can only be claimed once.", + "items": { + "type": "string" + }, + "type": "array" + }, + "createTime": { + "description": "Output only. [Output only] Create time stamp", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "isDefault": { + "description": "Output only. Whether the RegistryBook is the default one.", + "readOnly": true, + "type": "boolean" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels as key value pairs", + "type": "object" + }, + "name": { + "description": "Required. Identifier. name of resource", + "type": "string" + }, + "updateTime": { + "description": "Output only. [Output only] Update time stamp", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "SearchIpResourcesRequest": { + "description": "Message for searching IP resources", + "id": "SearchIpResourcesRequest", + "properties": { + "orderBy": { + "description": "Optional. Hint for how to order the results", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", + "format": "int32", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return.", + "type": "string" + }, + "query": { + "description": "Optional. Search query. This string filters resources in an AIP-160-like format. It has some limitations. You can only specify top level conjunctions or attribute level negations. Each restriction can only be used once except the attribute restriction. The available restrictions for ranges are: - `realm`: The realm name to search in. - `ip_address`: The IP address to search for within ranges. - `ip_version`: The IP version to filter by (e.g., \"IPV4\", \"IPV6\"). - `parent_range`: The parent range of the range to search for. - `attribute_text`: The attribute text to search for within ranges. - `attribute`: The attribute key and value to filter by. The available restrictions for realms are: - `ip_version`: The IP version to search for. Only one of attribute_text or multiple attribute filters can be specified. Examples: - `realm=test-realm` - `realm=test-realm AND ip_address=10.0.0.0` - `realm=test-realm AND ip_version=IPV6` - `realm=test-realm AND attribute_text=test` - `ip_address=10.0.0.0 AND attribute:(key1=value1) AND attribute:(key2=value2)` - `attribute_text=test AND parent_range=projects/123/locations/global/discoveredRanges/test-parent-range`", + "type": "string" + }, + "searchResourceTypes": { + "description": "Optional. The type of resources to search for. If not specified, the server will return ranges.", + "items": { + "enum": [ + "SEARCH_RESOURCE_TYPE_UNSPECIFIED", + "RANGES", + "REALMS" + ], + "enumDescriptions": [ + "Unspecified search type.", + "Search for ranges.", + "Search for realms." + ], + "type": "string" + }, + "type": "array" + }, + "showUtilization": { + "description": "Optional. Whether to show the utilization of the ranges in the response.", + "type": "boolean" + } + }, + "type": "object" + }, + "SearchIpResourcesResponse": { + "description": "Message for response to searching IP resources", + "id": "SearchIpResourcesResponse", + "properties": { + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + }, + "ranges": { + "deprecated": true, + "description": "Deprecated: Use results field instead. The list of ranges matching the search query.", + "items": { + "$ref": "Range" + }, + "type": "array" + }, + "results": { + "description": "The list of results matching the search query.", + "items": { + "$ref": "SearchIpResourcesResult" + }, + "type": "array" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "SearchIpResourcesResult": { + "description": "A result matching the search query, which can be either a range or a realm.", + "id": "SearchIpResourcesResult", + "properties": { + "range": { + "$ref": "Range", + "description": "A range matching the search query." + }, + "realm": { + "$ref": "Realm", + "description": "A realm matching the search query." + } + }, + "type": "object" + }, + "ShowCustomRangeUtilizationResponse": { + "description": "Message for the response to getting the utilization of a CustomRange", + "id": "ShowCustomRangeUtilizationResponse", + "properties": { + "customRange": { + "$ref": "CustomRange", + "description": "The CustomRange resource." + }, + "rangeUtilization": { + "$ref": "RangeUtilization", + "description": "The utilization of the CustomRange." + } + }, + "type": "object" + }, + "ShowDiscoveredRangeUtilizationResponse": { + "description": "Message for the response to getting the utilization of a DiscoveredRange", + "id": "ShowDiscoveredRangeUtilizationResponse", + "properties": { + "discoveredRange": { + "$ref": "DiscoveredRange", + "description": "The DiscoveredRange resource." + }, + "rangeUtilization": { + "$ref": "RangeUtilization", + "description": "The utilization of the DiscoveredRange." + } + }, + "type": "object" + }, + "Status": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "Status", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Cloud Number Registry API", + "version": "v1alpha", + "version_module": true +} \ No newline at end of file diff --git a/discovery/cloudtrace-v1.json b/discovery/cloudtrace-v1.json index 064f15eba42..29ae12d0be0 100644 --- a/discovery/cloudtrace-v1.json +++ b/discovery/cloudtrace-v1.json @@ -21,6 +21,243 @@ "description": "Sends application trace data to Cloud Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API. This library is used to interact with the Cloud Trace API directly. If you are looking to instrument your application for Cloud Trace, we recommend using OpenTelemetry. ", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/trace/", + "endpoints": [ + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.africa-south1.rep.googleapis.com/", + "location": "africa-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.asia-east1.rep.googleapis.com/", + "location": "asia-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.asia-east2.rep.googleapis.com/", + "location": "asia-east2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.asia-northeast1.rep.googleapis.com/", + "location": "asia-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.asia-northeast2.rep.googleapis.com/", + "location": "asia-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.asia-northeast3.rep.googleapis.com/", + "location": "asia-northeast3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.asia-south1.rep.googleapis.com/", + "location": "asia-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.asia-south2.rep.googleapis.com/", + "location": "asia-south2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.asia-southeast1.rep.googleapis.com/", + "location": "asia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.asia-southeast2.rep.googleapis.com/", + "location": "asia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.australia-southeast1.rep.googleapis.com/", + "location": "australia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.australia-southeast2.rep.googleapis.com/", + "location": "australia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-central2.rep.googleapis.com/", + "location": "europe-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-north1.rep.googleapis.com/", + "location": "europe-north1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-north2.rep.googleapis.com/", + "location": "europe-north2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-southwest1.rep.googleapis.com/", + "location": "europe-southwest1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-west1.rep.googleapis.com/", + "location": "europe-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-west10.rep.googleapis.com/", + "location": "europe-west10" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-west12.rep.googleapis.com/", + "location": "europe-west12" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-west2.rep.googleapis.com/", + "location": "europe-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-west3.rep.googleapis.com/", + "location": "europe-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-west4.rep.googleapis.com/", + "location": "europe-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-west6.rep.googleapis.com/", + "location": "europe-west6" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-west8.rep.googleapis.com/", + "location": "europe-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-west9.rep.googleapis.com/", + "location": "europe-west9" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.me-central1.rep.googleapis.com/", + "location": "me-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.me-central2.rep.googleapis.com/", + "location": "me-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.me-west1.rep.googleapis.com/", + "location": "me-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.northamerica-northeast1.rep.googleapis.com/", + "location": "northamerica-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.northamerica-northeast2.rep.googleapis.com/", + "location": "northamerica-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.northamerica-south1.rep.googleapis.com/", + "location": "northamerica-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.southamerica-east1.rep.googleapis.com/", + "location": "southamerica-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.southamerica-west1.rep.googleapis.com/", + "location": "southamerica-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-central2.rep.googleapis.com/", + "location": "us-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-east1.rep.googleapis.com/", + "location": "us-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-east4.rep.googleapis.com/", + "location": "us-east4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-east7.rep.googleapis.com/", + "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-west4.rep.googleapis.com/", + "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-west8.rep.googleapis.com/", + "location": "us-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us.rep.googleapis.com/", + "location": "us" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.eu.rep.googleapis.com/", + "location": "eu" + } + ], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -257,7 +494,7 @@ } } }, - "revision": "20251003", + "revision": "20260508", "rootUrl": "https://cloudtrace.googleapis.com/", "schemas": { "Empty": { diff --git a/discovery/cloudtrace-v2.json b/discovery/cloudtrace-v2.json index 62c87d03ea1..fe4efc51243 100644 --- a/discovery/cloudtrace-v2.json +++ b/discovery/cloudtrace-v2.json @@ -18,6 +18,243 @@ "description": "Sends application trace data to Cloud Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API. This library is used to interact with the Cloud Trace API directly. If you are looking to instrument your application for Cloud Trace, we recommend using OpenTelemetry. ", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/trace/", + "endpoints": [ + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.africa-south1.rep.googleapis.com/", + "location": "africa-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.asia-east1.rep.googleapis.com/", + "location": "asia-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.asia-east2.rep.googleapis.com/", + "location": "asia-east2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.asia-northeast1.rep.googleapis.com/", + "location": "asia-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.asia-northeast2.rep.googleapis.com/", + "location": "asia-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.asia-northeast3.rep.googleapis.com/", + "location": "asia-northeast3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.asia-south1.rep.googleapis.com/", + "location": "asia-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.asia-south2.rep.googleapis.com/", + "location": "asia-south2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.asia-southeast1.rep.googleapis.com/", + "location": "asia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.asia-southeast2.rep.googleapis.com/", + "location": "asia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.australia-southeast1.rep.googleapis.com/", + "location": "australia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.australia-southeast2.rep.googleapis.com/", + "location": "australia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-central2.rep.googleapis.com/", + "location": "europe-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-north1.rep.googleapis.com/", + "location": "europe-north1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-north2.rep.googleapis.com/", + "location": "europe-north2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-southwest1.rep.googleapis.com/", + "location": "europe-southwest1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-west1.rep.googleapis.com/", + "location": "europe-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-west10.rep.googleapis.com/", + "location": "europe-west10" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-west12.rep.googleapis.com/", + "location": "europe-west12" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-west2.rep.googleapis.com/", + "location": "europe-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-west3.rep.googleapis.com/", + "location": "europe-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-west4.rep.googleapis.com/", + "location": "europe-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-west6.rep.googleapis.com/", + "location": "europe-west6" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-west8.rep.googleapis.com/", + "location": "europe-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-west9.rep.googleapis.com/", + "location": "europe-west9" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.me-central1.rep.googleapis.com/", + "location": "me-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.me-central2.rep.googleapis.com/", + "location": "me-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.me-west1.rep.googleapis.com/", + "location": "me-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.northamerica-northeast1.rep.googleapis.com/", + "location": "northamerica-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.northamerica-northeast2.rep.googleapis.com/", + "location": "northamerica-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.northamerica-south1.rep.googleapis.com/", + "location": "northamerica-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.southamerica-east1.rep.googleapis.com/", + "location": "southamerica-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.southamerica-west1.rep.googleapis.com/", + "location": "southamerica-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-central2.rep.googleapis.com/", + "location": "us-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-east1.rep.googleapis.com/", + "location": "us-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-east4.rep.googleapis.com/", + "location": "us-east4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-east7.rep.googleapis.com/", + "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-west4.rep.googleapis.com/", + "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-west8.rep.googleapis.com/", + "location": "us-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us.rep.googleapis.com/", + "location": "us" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.eu.rep.googleapis.com/", + "location": "eu" + } + ], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -181,7 +418,7 @@ } } }, - "revision": "20251003", + "revision": "20260508", "rootUrl": "https://cloudtrace.googleapis.com/", "schemas": { "Annotation": { diff --git a/discovery/cloudtrace-v2beta1.json b/discovery/cloudtrace-v2beta1.json index 37d43e71b95..4b82a710f1a 100644 --- a/discovery/cloudtrace-v2beta1.json +++ b/discovery/cloudtrace-v2beta1.json @@ -21,6 +21,243 @@ "description": "Sends application trace data to Cloud Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API. This library is used to interact with the Cloud Trace API directly. If you are looking to instrument your application for Cloud Trace, we recommend using OpenTelemetry. ", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/trace/", + "endpoints": [ + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.africa-south1.rep.googleapis.com/", + "location": "africa-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.asia-east1.rep.googleapis.com/", + "location": "asia-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.asia-east2.rep.googleapis.com/", + "location": "asia-east2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.asia-northeast1.rep.googleapis.com/", + "location": "asia-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.asia-northeast2.rep.googleapis.com/", + "location": "asia-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.asia-northeast3.rep.googleapis.com/", + "location": "asia-northeast3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.asia-south1.rep.googleapis.com/", + "location": "asia-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.asia-south2.rep.googleapis.com/", + "location": "asia-south2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.asia-southeast1.rep.googleapis.com/", + "location": "asia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.asia-southeast2.rep.googleapis.com/", + "location": "asia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.australia-southeast1.rep.googleapis.com/", + "location": "australia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.australia-southeast2.rep.googleapis.com/", + "location": "australia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-central2.rep.googleapis.com/", + "location": "europe-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-north1.rep.googleapis.com/", + "location": "europe-north1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-north2.rep.googleapis.com/", + "location": "europe-north2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-southwest1.rep.googleapis.com/", + "location": "europe-southwest1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-west1.rep.googleapis.com/", + "location": "europe-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-west10.rep.googleapis.com/", + "location": "europe-west10" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-west12.rep.googleapis.com/", + "location": "europe-west12" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-west2.rep.googleapis.com/", + "location": "europe-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-west3.rep.googleapis.com/", + "location": "europe-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-west4.rep.googleapis.com/", + "location": "europe-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-west6.rep.googleapis.com/", + "location": "europe-west6" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-west8.rep.googleapis.com/", + "location": "europe-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.europe-west9.rep.googleapis.com/", + "location": "europe-west9" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.me-central1.rep.googleapis.com/", + "location": "me-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.me-central2.rep.googleapis.com/", + "location": "me-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.me-west1.rep.googleapis.com/", + "location": "me-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.northamerica-northeast1.rep.googleapis.com/", + "location": "northamerica-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.northamerica-northeast2.rep.googleapis.com/", + "location": "northamerica-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.northamerica-south1.rep.googleapis.com/", + "location": "northamerica-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.southamerica-east1.rep.googleapis.com/", + "location": "southamerica-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.southamerica-west1.rep.googleapis.com/", + "location": "southamerica-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-central2.rep.googleapis.com/", + "location": "us-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-east1.rep.googleapis.com/", + "location": "us-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-east4.rep.googleapis.com/", + "location": "us-east4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-east7.rep.googleapis.com/", + "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-west4.rep.googleapis.com/", + "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us-west8.rep.googleapis.com/", + "location": "us-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.us.rep.googleapis.com/", + "location": "us" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudtrace.eu.rep.googleapis.com/", + "location": "eu" + } + ], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -273,7 +510,7 @@ } } }, - "revision": "20251003", + "revision": "20260508", "rootUrl": "https://cloudtrace.googleapis.com/", "schemas": { "Empty": { diff --git a/discovery/compute-alpha.json b/discovery/compute-alpha.json index 90b00798ebb..03ea7c88373 100644 --- a/discovery/compute-alpha.json +++ b/discovery/compute-alpha.json @@ -55121,7 +55121,7 @@ } } }, - "revision": "20260427", + "revision": "20260501", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -55977,7 +55977,7 @@ "A private network IP address that can be used to configure Private\nService Connect. This purpose can be specified only forGLOBAL addresses of Type INTERNAL", "A regional internal IP address range reserved for Serverless.", "A private network IP address that can be shared by multiple Internal\nLoad Balancer forwarding rules.", - "A regional internal IP address that is reserved and managed by Google\nCloud. It can not be assigned to Google Cloud compute resources such as\nVM and internal load balancer.", + "A regional internal IP address that is reserved and managed internally.\nIt can not be assigned to compute resources such as VM and internal load\nbalancer.", "IP range for peer networks." ], "type": "string" @@ -57068,7 +57068,6 @@ "type": "string" }, "diskType": { - "description": "Specifies the disk type to use to create the instance. If not specified,\nthe default is pd-standard, specified using the full URL.\nFor example:\n\nhttps://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard\n\n\nFor a full list of acceptable values, seePersistent disk\ntypes. If you specify this field when creating a VM, you can provide\neither the full or partial URL. For example, the following values are\nvalid:\n \n \n - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType \n - projects/project/zones/zone/diskTypes/diskType \n - zones/zone/diskTypes/diskType\n\n\nIf you specify this field when creating or updating an instance template\nor all-instances configuration, specify the type of the disk, not the\nURL. For example: pd-standard.", "type": "string" }, "enableConfidentialCompute": { @@ -63483,12 +63482,14 @@ "confidentialInstanceType": { "description": "Defines the type of technology used by the confidential instance.", "enum": [ + "CCA", "CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED", "SEV", "SEV_SNP", "TDX" ], "enumDescriptions": [ + "Arm Confidential Compute Architecture.", "No type specified. Do not use this value.", "AMD Secure Encrypted Virtualization.", "AMD Secure Encrypted Virtualization - Secure Nested Paging.", @@ -70748,6 +70749,7 @@ "description": "The ID of a supported feature. To add multiple values, use commas to\nseparate values. Set to one or more of the following values:\n \n - VIRTIO_SCSI_MULTIQUEUE\n - WINDOWS\n - MULTI_IP_SUBNET\n - UEFI_COMPATIBLE\n - GVNIC\n - SEV_CAPABLE\n - SUSPEND_RESUME_COMPATIBLE\n - SEV_LIVE_MIGRATABLE_V2\n - SEV_SNP_CAPABLE\n - TDX_CAPABLE\n - IDPF\n - SNP_SVSM_CAPABLE\n - CCA_CAPABLE\n\n\nFor more information, see\nEnabling guest operating system features.", "enum": [ "BARE_METAL_LINUX_COMPATIBLE", + "CCA_CAPABLE", "FEATURE_TYPE_UNSPECIFIED", "GVNIC", "IDPF", @@ -70778,6 +70780,7 @@ "", "", "", + "", "" ], "type": "string" @@ -92096,7 +92099,7 @@ "type": "string" }, "network": { - "description": "The URL of the network to which all network endpoints in the NEG belong.\nUses default project network if unspecified.", + "description": "The URL of the network to which all network endpoints in the NEG belong.\nFor networkEndpointType GCE_VM_IP_PORT,GCE_VM_IP_PORTMAP or NON_GCP_PRIVATE_IP_PORT,\nif this field is not specified, a default network will be used.\nThis field cannot be set for NEGs with networkEndpointType set toSERVERLESS or PRIVATE_SERVICE_CONNECT and for\nglobal NEGs.\nFor all other network endpoint types, this field is required.", "type": "string" }, "networkEndpointType": { @@ -92410,7 +92413,7 @@ }, "network": { "deprecated": true, - "description": "The URL of the network to which all network endpoints in the NEG belong.\nUses default project network if unspecified.\n[Deprecated] This field is deprecated.", + "description": "The URL of the network to which all network endpoints in the NEG belong.\nFor networkEndpointType GCE_VM_IP_PORT,GCE_VM_IP_PORTMAP or NON_GCP_PRIVATE_IP_PORT,\nif this field is not specified, a default network will be used.\nThis field cannot be set for NEGs with networkEndpointType set toSERVERLESS or PRIVATE_SERVICE_CONNECT and for\nglobal NEGs.\nFor all other network endpoint types, this field is required.\n [Deprecated] This field is deprecated.", "type": "string" }, "subnetwork": { @@ -94623,7 +94626,7 @@ "A private network IP address that can be used to configure Private\nService Connect. This purpose can be specified only forGLOBAL addresses of Type INTERNAL", "A regional internal IP address range reserved for Serverless.", "A private network IP address that can be shared by multiple Internal\nLoad Balancer forwarding rules.", - "A regional internal IP address that is reserved and managed by Google\nCloud. It can not be assigned to Google Cloud compute resources such as\nVM and internal load balancer.", + "A regional internal IP address that is reserved and managed internally.\nIt can not be assigned to compute resources such as VM and internal load\nbalancer.", "IP range for peer networks." ], "type": "string" diff --git a/discovery/compute-beta.json b/discovery/compute-beta.json index 311e7ec9e72..7dcc21b4319 100644 --- a/discovery/compute-beta.json +++ b/discovery/compute-beta.json @@ -41037,6 +41037,51 @@ }, "rollouts": { "methods": { + "advance": { + "description": "Advances a Rollout to the next wave, or completes it if no waves remain.", + "flatPath": "projects/{project}/global/rollouts/{rollout}/advance", + "httpMethod": "POST", + "id": "compute.rollouts.advance", + "parameterOrder": [ + "project", + "rollout" + ], + "parameters": { + "currentWaveNumber": { + "description": "Required. Wave number of the current wave.", + "format": "int64", + "location": "query", + "type": "string" + }, + "project": { + "description": "Required. Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "rollout": { + "description": "Required. Name of the Rollout resource to advance.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/rollouts/{rollout}/advance", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "cancel": { "description": "Cancels a Rollout.", "flatPath": "projects/{project}/global/rollouts/{rollout}", @@ -41209,6 +41254,94 @@ "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] + }, + "pause": { + "description": "Pauses a Rollout.", + "flatPath": "projects/{project}/global/rollouts/{rollout}/pause", + "httpMethod": "POST", + "id": "compute.rollouts.pause", + "parameterOrder": [ + "project", + "rollout" + ], + "parameters": { + "etag": { + "description": "The etag of the Rollout.\nIf this is provided, the request will only succeed if the etag matches\nthe current etag of the Rollout.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Required. Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "rollout": { + "description": "Required. Name of the Rollout resource to pause.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/rollouts/{rollout}/pause", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "resume": { + "description": "Resumes a Rollout.", + "flatPath": "projects/{project}/global/rollouts/{rollout}/resume", + "httpMethod": "POST", + "id": "compute.rollouts.resume", + "parameterOrder": [ + "project", + "rollout" + ], + "parameters": { + "etag": { + "description": "The etag of the Rollout.\nIf this is provided, the request will only succeed if the etag matches\nthe current etag of the Rollout.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Required. Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "rollout": { + "description": "Required. Name of the Rollout resource to resume.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/rollouts/{rollout}/resume", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] } } }, @@ -51797,7 +51930,7 @@ } } }, - "revision": "20260427", + "revision": "20260501", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -52618,6 +52751,7 @@ "PRIVATE_SERVICE_CONNECT", "SERVERLESS", "SHARED_LOADBALANCER_VIP", + "SYSTEM_MANAGED", "VPC_PEERING" ], "enumDescriptions": [ @@ -52630,6 +52764,7 @@ "A private network IP address that can be used to configure Private\nService Connect. This purpose can be specified only forGLOBAL addresses of Type INTERNAL", "A regional internal IP address range reserved for Serverless.", "A private network IP address that can be shared by multiple Internal\nLoad Balancer forwarding rules.", + "A regional internal IP address that is reserved and managed internally.\nIt can not be assigned to compute resources such as VM and internal load\nbalancer.", "IP range for peer networks." ], "type": "string" @@ -53667,7 +53802,6 @@ "type": "string" }, "diskType": { - "description": "Specifies the disk type to use to create the instance. If not specified,\nthe default is pd-standard, specified using the full URL.\nFor example:\n\nhttps://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard\n\n\nFor a full list of acceptable values, seePersistent disk\ntypes. If you specify this field when creating a VM, you can provide\neither the full or partial URL. For example, the following values are\nvalid:\n \n \n - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType \n - projects/project/zones/zone/diskTypes/diskType \n - zones/zone/diskTypes/diskType\n\n\nIf you specify this field when creating or updating an instance template\nor all-instances configuration, specify the type of the disk, not the\nURL. For example: pd-standard.", "type": "string" }, "enableConfidentialCompute": { @@ -59746,12 +59880,14 @@ "confidentialInstanceType": { "description": "Defines the type of technology used by the confidential instance.", "enum": [ + "CCA", "CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED", "SEV", "SEV_SNP", "TDX" ], "enumDescriptions": [ + "Arm Confidential Compute Architecture.", "No type specified. Do not use this value.", "AMD Secure Encrypted Virtualization.", "AMD Secure Encrypted Virtualization - Secure Nested Paging.", @@ -60490,6 +60626,23 @@ "readOnly": true, "type": "string" }, + "sourceMachineImage": { + "description": "The machine image to create the disk from. You can provide this as a\npartial or full URL to the resource. For example, the following are valid\nvalues:\n \n \n - https://www.googleapis.com/compute/v1/projects/project/global/machineImages/machineImage \n - projects/project/global/machineImages/machineImage\n - global/machineImages/machineImage", + "type": "string" + }, + "sourceMachineImageDiskDeviceName": { + "description": "The device name of a disk within a given machine image. The\nsource_machine_image must be specified.", + "type": "string" + }, + "sourceMachineImageEncryptionKey": { + "$ref": "CustomerEncryptionKey", + "description": "Thecustomer-supplied\nencryption key of the source machine image. Required if the source\nmachine image is protected by a customer-supplied encryption key." + }, + "sourceMachineImageId": { + "description": "Output only. [Output Only] The unique ID of the machine image used to create this disk.\nThis value identifies the exact machine image that was used to create this\npersistent disk. For example, if you created the persistent disk from a\nmachine image that was later deleted and recreated under the same name, the\nsource machine image ID would identify the exact version of the machine\nimage that was used.", + "readOnly": true, + "type": "string" + }, "sourceSnapshot": { "description": "The source snapshot used to create this disk. You can provide this as a\npartial or full URL to the resource. For example, the following are valid\nvalues:\n \n \n - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot \n - projects/project/global/snapshots/snapshot\n - global/snapshots/snapshot", "type": "string" @@ -66408,6 +66561,7 @@ "description": "The ID of a supported feature. To add multiple values, use commas to\nseparate values. Set to one or more of the following values:\n \n - VIRTIO_SCSI_MULTIQUEUE\n - WINDOWS\n - MULTI_IP_SUBNET\n - UEFI_COMPATIBLE\n - GVNIC\n - SEV_CAPABLE\n - SUSPEND_RESUME_COMPATIBLE\n - SEV_LIVE_MIGRATABLE_V2\n - SEV_SNP_CAPABLE\n - TDX_CAPABLE\n - IDPF\n - SNP_SVSM_CAPABLE\n - CCA_CAPABLE\n\n\nFor more information, see\nEnabling guest operating system features.", "enum": [ "BARE_METAL_LINUX_COMPATIBLE", + "CCA_CAPABLE", "FEATURE_TYPE_UNSPECIFIED", "GVNIC", "IDPF", @@ -66438,6 +66592,7 @@ "", "", "", + "", "" ], "type": "string" @@ -76772,6 +76927,11 @@ "description": "An optional description of this resource. Provide this property when you\ncreate the resource.", "type": "string" }, + "effectiveLocation": { + "description": "Output only. [Output Only] URL of the InterconnectLocation object that represents where\nthis connection is to be provisioned. By default it will be the same as the\nlocation field.", + "readOnly": true, + "type": "string" + }, "expectedOutages": { "description": "Output only. [Output Only] A list of outages expected for this Interconnect.", "items": { @@ -81792,6 +81952,20 @@ "description": "Machine Image parameters", "id": "MachineImageParams", "properties": { + "excludedDisks": { + "description": "Input only. [Input Only] Specifies the list of disk device names that must be\nexcluded from the new machine image.", + "items": { + "type": "string" + }, + "type": "array" + }, + "includedDisks": { + "description": "Input only. [Input Only] Specifies the list of disk device names that must be\nincluded with the new machine image.", + "items": { + "type": "string" + }, + "type": "array" + }, "resourceManagerTags": { "additionalProperties": { "type": "string" @@ -84685,7 +84859,7 @@ "type": "string" }, "network": { - "description": "The URL of the network to which all network endpoints in the NEG belong.\nUses default project network if unspecified.", + "description": "The URL of the network to which all network endpoints in the NEG belong.\nFor networkEndpointType GCE_VM_IP_PORT,GCE_VM_IP_PORTMAP or NON_GCP_PRIVATE_IP_PORT,\nif this field is not specified, a default network will be used.\nThis field cannot be set for NEGs with networkEndpointType set toSERVERLESS or PRIVATE_SERVICE_CONNECT and for\nglobal NEGs.\nFor all other network endpoint types, this field is required.", "type": "string" }, "networkEndpointType": { @@ -84982,7 +85156,7 @@ }, "network": { "deprecated": true, - "description": "The URL of the network to which all network endpoints in the NEG belong.\nUses default project network if unspecified.\n[Deprecated] This field is deprecated.", + "description": "The URL of the network to which all network endpoints in the NEG belong.\nFor networkEndpointType GCE_VM_IP_PORT,GCE_VM_IP_PORTMAP or NON_GCP_PRIVATE_IP_PORT,\nif this field is not specified, a default network will be used.\nThis field cannot be set for NEGs with networkEndpointType set toSERVERLESS or PRIVATE_SERVICE_CONNECT and for\nglobal NEGs.\nFor all other network endpoint types, this field is required.\n [Deprecated] This field is deprecated.", "type": "string" }, "subnetwork": { @@ -87112,6 +87286,7 @@ "PRIVATE_SERVICE_CONNECT", "SERVERLESS", "SHARED_LOADBALANCER_VIP", + "SYSTEM_MANAGED", "VPC_PEERING" ], "enumDescriptions": [ @@ -87124,6 +87299,7 @@ "A private network IP address that can be used to configure Private\nService Connect. This purpose can be specified only forGLOBAL addresses of Type INTERNAL", "A regional internal IP address range reserved for Serverless.", "A private network IP address that can be shared by multiple Internal\nLoad Balancer forwarding rules.", + "A regional internal IP address that is reserved and managed internally.\nIt can not be assigned to compute resources such as VM and internal load\nbalancer.", "IP range for peer networks." ], "type": "string" diff --git a/discovery/compute-v1.json b/discovery/compute-v1.json index 6cb01d15565..03f8c13a630 100644 --- a/discovery/compute-v1.json +++ b/discovery/compute-v1.json @@ -47746,7 +47746,7 @@ } } }, - "revision": "20260422", + "revision": "20260501", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -49571,7 +49571,6 @@ "type": "string" }, "diskType": { - "description": "Specifies the disk type to use to create the instance. If not specified,\nthe default is pd-standard, specified using the full URL.\nFor example:\n\nhttps://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard\n\n\nFor a full list of acceptable values, seePersistent disk\ntypes. If you specify this field when creating a VM, you can provide\neither the full or partial URL. For example, the following values are\nvalid:\n \n \n - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType \n - projects/project/zones/zone/diskTypes/diskType \n - zones/zone/diskTypes/diskType\n\n\nIf you specify this field when creating or updating an instance template\nor all-instances configuration, specify the type of the disk, not the\nURL. For example: pd-standard.", "type": "string" }, "enableConfidentialCompute": { @@ -55156,12 +55155,14 @@ "confidentialInstanceType": { "description": "Defines the type of technology used by the confidential instance.", "enum": [ + "CCA", "CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED", "SEV", "SEV_SNP", "TDX" ], "enumDescriptions": [ + "Arm Confidential Compute Architecture.", "No type specified. Do not use this value.", "AMD Secure Encrypted Virtualization.", "AMD Secure Encrypted Virtualization - Secure Nested Paging.", @@ -58580,6 +58581,13 @@ "description": "A fully-qualified URL of a SecurityProfile resource instance.\nExample:\nhttps://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group\nMust be specified if action is one of 'apply_security_profile_group' or\n'mirror'. Cannot be specified for other actions.", "type": "string" }, + "targetForwardingRules": { + "description": "A list of forwarding rules to which this rule applies.\nThis field allows you to control which load balancers get this rule.\nFor example, the following are valid values:\n \n \n - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule\n - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule\n - projects/project/global/\n forwardingRules/forwardingRule\n - projects/project/regions/region/forwardingRules/\n forwardingRule", + "items": { + "type": "string" + }, + "type": "array" + }, "targetResources": { "description": "A list of network resource URLs to which this rule applies. This field\nallows you to control which network's VMs get this rule. If this field\nis left blank, all VMs within the organization will receive the rule.", "items": { @@ -58601,6 +58609,18 @@ }, "type": "array" }, + "targetType": { + "description": "Target types of the firewall policy rule.\nDefault value is INSTANCES.", + "enum": [ + "INSTANCES", + "INTERNAL_MANAGED_LB" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, "tlsInspect": { "description": "Boolean flag indicating if the traffic should be TLS decrypted.\nCan be set only if action = 'apply_security_profile_group' and cannot\nbe set for other actions.", "type": "boolean" @@ -61560,6 +61580,7 @@ "description": "The ID of a supported feature. To add multiple values, use commas to\nseparate values. Set to one or more of the following values:\n \n - VIRTIO_SCSI_MULTIQUEUE\n - WINDOWS\n - MULTI_IP_SUBNET\n - UEFI_COMPATIBLE\n - GVNIC\n - SEV_CAPABLE\n - SUSPEND_RESUME_COMPATIBLE\n - SEV_LIVE_MIGRATABLE_V2\n - SEV_SNP_CAPABLE\n - TDX_CAPABLE\n - IDPF\n - SNP_SVSM_CAPABLE\n - CCA_CAPABLE\n\n\nFor more information, see\nEnabling guest operating system features.", "enum": [ "BARE_METAL_LINUX_COMPATIBLE", + "CCA_CAPABLE", "FEATURE_TYPE_UNSPECIFIED", "GVNIC", "IDPF", @@ -61590,6 +61611,7 @@ "", "", "", + "", "" ], "type": "string" @@ -78407,7 +78429,7 @@ "type": "string" }, "network": { - "description": "The URL of the network to which all network endpoints in the NEG belong.\nUses default project network if unspecified.", + "description": "The URL of the network to which all network endpoints in the NEG belong.\nFor networkEndpointType GCE_VM_IP_PORT,GCE_VM_IP_PORTMAP or NON_GCP_PRIVATE_IP_PORT,\nif this field is not specified, a default network will be used.\nThis field cannot be set for NEGs with networkEndpointType set toSERVERLESS or PRIVATE_SERVICE_CONNECT and for\nglobal NEGs.\nFor all other network endpoint types, this field is required.", "type": "string" }, "networkEndpointType": { diff --git a/discovery/contactcenterinsights-v1.json b/discovery/contactcenterinsights-v1.json index 0ff35fef156..7bb1797f879 100644 --- a/discovery/contactcenterinsights-v1.json +++ b/discovery/contactcenterinsights-v1.json @@ -6224,9 +6224,379 @@ } } }, - "revision": "20260410", + "revision": "20260510", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { + "GoogleCloudAiplatformV1Blob": { + "description": "A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video.", + "id": "GoogleCloudAiplatformV1Blob", + "properties": { + "data": { + "description": "Required. The raw bytes of the data.", + "format": "byte", + "type": "string" + }, + "displayName": { + "description": "Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.", + "type": "string" + }, + "mimeType": { + "description": "Required. The IANA standard MIME type of the source data.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CodeExecutionResult": { + "description": "Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used.", + "id": "GoogleCloudAiplatformV1CodeExecutionResult", + "properties": { + "outcome": { + "description": "Required. Outcome of the code execution.", + "enum": [ + "OUTCOME_UNSPECIFIED", + "OUTCOME_OK", + "OUTCOME_FAILED", + "OUTCOME_DEADLINE_EXCEEDED" + ], + "enumDescriptions": [ + "Unspecified status. This value should not be used.", + "Code execution completed successfully. `output` contains the stdout, if any.", + "Code execution failed. `output` contains the stderr and stdout, if any.", + "Code execution ran for too long, and was cancelled. There may or may not be a partial `output` present." + ], + "type": "string" + }, + "output": { + "description": "Optional. Contains stdout when code execution is successful, stderr or other description otherwise.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1Content": { + "description": "The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.", + "id": "GoogleCloudAiplatformV1Content", + "properties": { + "parts": { + "description": "Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.", + "items": { + "$ref": "GoogleCloudAiplatformV1Part" + }, + "type": "array" + }, + "role": { + "description": "Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ExecutableCode": { + "description": "Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated.", + "id": "GoogleCloudAiplatformV1ExecutableCode", + "properties": { + "code": { + "description": "Required. The code to be executed.", + "type": "string" + }, + "language": { + "description": "Required. Programming language of the `code`.", + "enum": [ + "LANGUAGE_UNSPECIFIED", + "PYTHON" + ], + "enumDescriptions": [ + "Unspecified language. This value should not be used.", + "Python >= 3.10, with numpy and simpy available." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1FileData": { + "description": "URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage.", + "id": "GoogleCloudAiplatformV1FileData", + "properties": { + "displayName": { + "description": "Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.", + "type": "string" + }, + "fileUri": { + "description": "Required. The URI of the file in Google Cloud Storage.", + "type": "string" + }, + "mimeType": { + "description": "Required. The IANA standard MIME type of the source data.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1FunctionCall": { + "description": "A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values.", + "id": "GoogleCloudAiplatformV1FunctionCall", + "properties": { + "args": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details.", + "type": "object" + }, + "name": { + "description": "Optional. The name of the function to call. Matches FunctionDeclaration.name.", + "type": "string" + }, + "partialArgs": { + "description": "Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.", + "items": { + "$ref": "GoogleCloudAiplatformV1PartialArg" + }, + "type": "array" + }, + "willContinue": { + "description": "Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1FunctionResponse": { + "description": "The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction.", + "id": "GoogleCloudAiplatformV1FunctionResponse", + "properties": { + "name": { + "description": "Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name.", + "type": "string" + }, + "parts": { + "description": "Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.", + "items": { + "$ref": "GoogleCloudAiplatformV1FunctionResponsePart" + }, + "type": "array" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Required. The function response in JSON object format. Use \"output\" key to specify function output and \"error\" key to specify error details (if any). If \"output\" and \"error\" keys are not specified, then whole \"response\" is treated as function output.", + "type": "object" + }, + "scheduling": { + "description": "Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE.", + "enum": [ + "SCHEDULING_UNSPECIFIED", + "SILENT", + "WHEN_IDLE", + "INTERRUPT" + ], + "enumDescriptions": [ + "This value is unused.", + "Only add the result to the conversation context, do not interrupt or trigger generation.", + "Add the result to the conversation context, and prompt to generate output without interrupting ongoing generation.", + "Add the result to the conversation context, interrupt ongoing generation and prompt to generate output." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1FunctionResponseBlob": { + "description": "Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field.", + "id": "GoogleCloudAiplatformV1FunctionResponseBlob", + "properties": { + "data": { + "description": "Required. Raw bytes.", + "format": "byte", + "type": "string" + }, + "displayName": { + "description": "Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.", + "type": "string" + }, + "mimeType": { + "description": "Required. The IANA standard MIME type of the source data.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1FunctionResponseFileData": { + "description": "URI based data for function response.", + "id": "GoogleCloudAiplatformV1FunctionResponseFileData", + "properties": { + "displayName": { + "description": "Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.", + "type": "string" + }, + "fileUri": { + "description": "Required. URI.", + "type": "string" + }, + "mimeType": { + "description": "Required. The IANA standard MIME type of the source data.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1FunctionResponsePart": { + "description": "A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.", + "id": "GoogleCloudAiplatformV1FunctionResponsePart", + "properties": { + "fileData": { + "$ref": "GoogleCloudAiplatformV1FunctionResponseFileData", + "description": "URI based data." + }, + "inlineData": { + "$ref": "GoogleCloudAiplatformV1FunctionResponseBlob", + "description": "Inline media bytes." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1Part": { + "description": "A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.", + "id": "GoogleCloudAiplatformV1Part", + "properties": { + "codeExecutionResult": { + "$ref": "GoogleCloudAiplatformV1CodeExecutionResult", + "description": "Optional. The result of executing the ExecutableCode." + }, + "executableCode": { + "$ref": "GoogleCloudAiplatformV1ExecutableCode", + "description": "Optional. Code generated by the model that is intended to be executed." + }, + "fileData": { + "$ref": "GoogleCloudAiplatformV1FileData", + "description": "Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage." + }, + "functionCall": { + "$ref": "GoogleCloudAiplatformV1FunctionCall", + "description": "Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function." + }, + "functionResponse": { + "$ref": "GoogleCloudAiplatformV1FunctionResponse", + "description": "Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted." + }, + "inlineData": { + "$ref": "GoogleCloudAiplatformV1Blob", + "description": "Optional. The inline data content of the part. This can be used to include images, audio, or video in a request." + }, + "mediaResolution": { + "$ref": "GoogleCloudAiplatformV1PartMediaResolution", + "description": "per part media resolution. Media resolution for the input media." + }, + "text": { + "description": "Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent.", + "type": "string" + }, + "thought": { + "description": "Optional. Indicates whether the `part` represents the model's thought process or reasoning.", + "type": "boolean" + }, + "thoughtSignature": { + "description": "Optional. An opaque signature for the thought so it can be reused in subsequent requests.", + "format": "byte", + "type": "string" + }, + "videoMetadata": { + "$ref": "GoogleCloudAiplatformV1VideoMetadata", + "description": "Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1PartMediaResolution": { + "description": "per part media resolution. Media resolution for the input media.", + "id": "GoogleCloudAiplatformV1PartMediaResolution", + "properties": { + "level": { + "description": "The tokenization quality used for given media.", + "enum": [ + "MEDIA_RESOLUTION_UNSPECIFIED", + "MEDIA_RESOLUTION_LOW", + "MEDIA_RESOLUTION_MEDIUM", + "MEDIA_RESOLUTION_HIGH", + "MEDIA_RESOLUTION_ULTRA_HIGH" + ], + "enumDescriptions": [ + "Media resolution has not been set.", + "Media resolution set to low.", + "Media resolution set to medium.", + "Media resolution set to high.", + "Media resolution set to ultra high. This is for image only." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1PartialArg": { + "description": "Partial argument value of the function call.", + "id": "GoogleCloudAiplatformV1PartialArg", + "properties": { + "boolValue": { + "description": "Optional. Represents a boolean value.", + "type": "boolean" + }, + "jsonPath": { + "description": "Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. \"$.foo.bar[0].data\".", + "type": "string" + }, + "nullValue": { + "description": "Optional. Represents a null value.", + "enum": [ + "NULL_VALUE" + ], + "enumDescriptions": [ + "Null value." + ], + "type": "string" + }, + "numberValue": { + "description": "Optional. Represents a double value.", + "format": "double", + "type": "number" + }, + "stringValue": { + "description": "Optional. Represents a string value.", + "type": "string" + }, + "willContinue": { + "description": "Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1VideoMetadata": { + "description": "Provides metadata for a video, including the start and end offsets for clipping and the frame rate.", + "id": "GoogleCloudAiplatformV1VideoMetadata", + "properties": { + "endOffset": { + "description": "Optional. The end offset of the video.", + "format": "google-duration", + "type": "string" + }, + "fps": { + "description": "Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].", + "format": "double", + "type": "number" + }, + "startOffset": { + "description": "Optional. The start offset of the video.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudCesV1mainAgentTransfer": { "description": "Represents an event indicating the transfer of a conversation to a different agent.", "id": "GoogleCloudCesV1mainAgentTransfer", @@ -9004,7 +9374,7 @@ }, "partialTrajectories": { "deprecated": true, - "description": "Output only. Deprecated: Use partial_trajectory_steps instead. The intermediate trajectory updates (partial trajectory).", + "description": "Output only. Deprecated: Use partial_trajectory_steps instead. Output only. The intermediate trajectory updates (partial trajectory).", "items": { "type": "string" }, @@ -9032,7 +9402,8 @@ "id": "GoogleCloudContactcenterinsightsV1DiagnoseConversationsRequest", "properties": { "dryRun": { - "description": "Optional. If true, the request will be validated and a simulation of the analysis will be performed without actually executing the task.", + "deprecated": true, + "description": "Optional. Deprecated: If true, the request will be validated and a simulation of the analysis will be performed without actually executing the task. This field is unused. Use validate_only instead.", "type": "boolean" }, "filter": { @@ -9040,7 +9411,8 @@ "type": "string" }, "fullReport": { - "description": "Optional. If true, the agent will generate a full diagnostic report for all sub-agents.", + "deprecated": true, + "description": "Optional. Deprecated: If true, the agent will generate a full diagnostic report for all sub-agents. Subagent reporting configuration is unused. The final diagnostic details are already persisted inside the Diagnostic resource instead.", "type": "boolean" }, "instructions": { @@ -9068,7 +9440,8 @@ }, "outputConfig": { "$ref": "GoogleCloudContactcenterinsightsV1OutputConfig", - "description": "Optional. The configuration for the output of the task." + "deprecated": true, + "description": "Optional. Deprecated: The configuration for the output of the task. The export destination is unused. Detailed markdown and conversation slices are already persisted inside the Diagnostic resource instead." }, "parent": { "description": "Required. The parent resource where the analysis will be performed.", @@ -9094,18 +9467,20 @@ "id": "GoogleCloudContactcenterinsightsV1DiagnoseConversationsResponse", "properties": { "answer": { - "description": "Output only. The final, high-level answer or diagnostic summary returned by the Sherlock worker.", + "deprecated": true, + "description": "Output only. Deprecated: Output only. The final, high-level answer or diagnostic summary returned by the Sherlock worker is deprecated. The persistent analysis summary is stored inside the Diagnostic resource instead.", "readOnly": true, "type": "string" }, "exportUri": { - "description": "Output only. If an external destination was requested, the URI of the exported data.", + "deprecated": true, + "description": "Output only. Deprecated: Output only. If an external destination was requested, the URI of the exported data is deprecated. The persistent diagnostic details are stored inside the Diagnostic resource instead.", "readOnly": true, "type": "string" }, "fullTrajectories": { "deprecated": true, - "description": "Output only. Deprecated: Use full_trajectory_steps instead. The complete sequence of thoughts and actions (full trajectory).", + "description": "Output only. Deprecated: Use full_trajectory_steps instead. Output only. The complete sequence of thoughts and actions (full trajectory).", "items": { "type": "string" }, @@ -9113,7 +9488,8 @@ "type": "array" }, "fullTrajectorySteps": { - "description": "Output only. The complete sequence of thoughts and actions taken by the agent.", + "deprecated": true, + "description": "Output only. Deprecated: Output only. The complete sequence of thoughts and actions taken by the agent is deprecated under LRO response completions. Use the persistent details inside the Diagnostic resource instead.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1SherlockStep" }, @@ -9159,8 +9535,17 @@ "description": "A diagnostic report containing aggregate metrics and intent breakdowns.", "id": "GoogleCloudContactcenterinsightsV1DiagnosticReport", "properties": { + "conversationSlices": { + "additionalProperties": { + "$ref": "GoogleCloudContactcenterinsightsV1DiagnosticReportConversationSlice" + }, + "description": "Output only. A map of conversation slices used in the report.", + "readOnly": true, + "type": "object" + }, "intentStats": { - "description": "Output only. A breakdown of metrics grouped by intent.", + "deprecated": true, + "description": "Output only. Deprecated: Intent breakdowns are no longer used.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1DiagnosticReportIntentStats" }, @@ -9183,6 +9568,25 @@ "description": "Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics.", "readOnly": true, "type": "object" + }, + "report": { + "description": "Output only. The final report in markdown format.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1DiagnosticReportConversationSlice": { + "description": "Output only. A map of conversation slices used in the report.", + "id": "GoogleCloudContactcenterinsightsV1DiagnosticReportConversationSlice", + "properties": { + "conversationIds": { + "description": "The list of conversation IDs that match this slice.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -11479,6 +11883,14 @@ "readOnly": true, "type": "string" }, + "links": { + "description": "Output only. A list of links to conversations or bot instructions.", + "items": { + "$ref": "GoogleCloudContactcenterinsightsV1LossPatternLink" + }, + "readOnly": true, + "type": "array" + }, "percentage": { "description": "Output only. The percentage of conversations that match this loss pattern.", "format": "double", @@ -11493,6 +11905,83 @@ }, "type": "object" }, + "GoogleCloudContactcenterinsightsV1LossPatternLink": { + "description": "A link to a conversation or bot instruction.", + "id": "GoogleCloudContactcenterinsightsV1LossPatternLink", + "properties": { + "botInstructionLink": { + "$ref": "GoogleCloudContactcenterinsightsV1LossPatternLinkBotInstructionLink", + "description": "A link to a bot instruction." + }, + "conversationLink": { + "$ref": "GoogleCloudContactcenterinsightsV1LossPatternLinkConversationLink", + "description": "A link to a conversation." + }, + "endByteIndex": { + "description": "The end byte index of the highlighted text (exclusive).", + "format": "int32", + "type": "integer" + }, + "highlightedText": { + "description": "The text that is highlighted. (populated for debugging purposes)", + "type": "string" + }, + "locationType": { + "description": "The location type.", + "enum": [ + "LOCATION_TYPE_UNSPECIFIED", + "DESCRIPTION", + "SUGGESTED_FIXES", + "EXAMPLES" + ], + "enumDescriptions": [ + "Unspecified location type.", + "The link applies to the description field.", + "The link applies to the suggested_fixes field.", + "The link applies to the examples field." + ], + "type": "string" + }, + "startByteIndex": { + "description": "The start byte index of the highlighted text (inclusive).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1LossPatternLinkBotInstructionLink": { + "description": "A link to a bot instruction.", + "id": "GoogleCloudContactcenterinsightsV1LossPatternLinkBotInstructionLink", + "properties": { + "endLine": { + "description": "The exclusive end line number of the instructions.", + "format": "int32", + "type": "integer" + }, + "startLine": { + "description": "The inclusive start line number of the instructions.", + "format": "int32", + "type": "integer" + }, + "subagent": { + "description": "The name of the subagent.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1LossPatternLinkConversationLink": { + "description": "A link to a conversation.", + "id": "GoogleCloudContactcenterinsightsV1LossPatternLinkConversationLink", + "properties": { + "conversationId": { + "description": "The conversation ID.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1MetricDefinition": { "description": "A definition for a metric to be calculated during analysis.", "id": "GoogleCloudContactcenterinsightsV1MetricDefinition", @@ -13044,6 +13533,13 @@ "description": "The redirect action to be taken when the chart is clicked.", "id": "GoogleCloudContactcenterinsightsV1RedirectAction", "properties": { + "queryParams": { + "additionalProperties": { + "type": "string" + }, + "description": "The query params to be added to the redirect path.", + "type": "object" + }, "relativePath": { "description": "The relative path to redirect to.", "type": "string" @@ -13418,8 +13914,36 @@ "description": "A step in the agent's reasoning process (Trajectory Step).", "id": "GoogleCloudContactcenterinsightsV1SherlockStep", "properties": { + "agentId": { + "description": "Output only. The ID of the agent that produced/received this content.", + "readOnly": true, + "type": "string" + }, + "content": { + "$ref": "GoogleCloudAiplatformV1Content", + "description": "Output only. The content of the turn (either Model or User role).", + "readOnly": true + }, + "stateDeltas": { + "description": "Output only. List of state changes caused by this specific turn.", + "items": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "readOnly": true, + "type": "array" + }, + "stepId": { + "description": "Output only. Unique ID for this specific turn.", + "readOnly": true, + "type": "string" + }, "textInput": { - "description": "Output only. Natural language input stimulus.", + "deprecated": true, + "description": "Output only. Deprecated: Use content instead.", "items": { "type": "string" }, @@ -13427,12 +13951,14 @@ "type": "array" }, "thought": { - "description": "Output only. The reasoning or internal monologue of the agent.", + "deprecated": true, + "description": "Output only. Deprecated: Use content instead.", "readOnly": true, "type": "string" }, "toolCalls": { - "description": "Output only. The tool call issued by the agent.", + "deprecated": true, + "description": "Output only. Deprecated: Use content instead.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1ToolCall" }, @@ -13444,7 +13970,8 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Output only. The output response from the tool execution.", + "deprecated": true, + "description": "Output only. Deprecated: Use content instead.", "readOnly": true, "type": "object" } @@ -15512,7 +16039,7 @@ }, "partialTrajectories": { "deprecated": true, - "description": "Output only. Deprecated: Use partial_trajectory_steps instead. The intermediate trajectory updates (partial trajectory).", + "description": "Output only. Deprecated: Use partial_trajectory_steps instead. Output only. The intermediate trajectory updates (partial trajectory).", "items": { "type": "string" }, @@ -15540,7 +16067,8 @@ "id": "GoogleCloudContactcenterinsightsV1alpha1DiagnoseConversationsRequest", "properties": { "dryRun": { - "description": "Optional. If true, the request will be validated and a simulation of the analysis will be performed without actually executing the task.", + "deprecated": true, + "description": "Optional. Deprecated: If true, the request will be validated and a simulation of the analysis will be performed without actually executing the task. This field is unused. Use validate_only instead.", "type": "boolean" }, "filter": { @@ -15548,7 +16076,8 @@ "type": "string" }, "fullReport": { - "description": "Optional. If true, the agent will generate a full diagnostic report for all sub-agents.", + "deprecated": true, + "description": "Optional. Deprecated: If true, the agent will generate a full diagnostic report for all sub-agents. Subagent reporting configuration is unused. The final diagnostic details are already persisted inside the Diagnostic resource instead.", "type": "boolean" }, "instructions": { @@ -15576,7 +16105,8 @@ }, "outputConfig": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1OutputConfig", - "description": "Optional. The configuration for the output of the task." + "deprecated": true, + "description": "Optional. Deprecated: The configuration for the output of the task. The export destination is unused. Detailed markdown and conversation slices are already persisted inside the Diagnostic resource instead." }, "parent": { "description": "Required. The parent resource where the analysis will be performed.", @@ -15602,18 +16132,20 @@ "id": "GoogleCloudContactcenterinsightsV1alpha1DiagnoseConversationsResponse", "properties": { "answer": { - "description": "Output only. The final, high-level answer or diagnostic summary returned by the Sherlock worker.", + "deprecated": true, + "description": "Output only. Deprecated: Output only. The final, high-level answer or diagnostic summary returned by the Sherlock worker is deprecated. The persistent analysis summary is stored inside the Diagnostic resource instead.", "readOnly": true, "type": "string" }, "exportUri": { - "description": "Output only. If an external destination was requested, the URI of the exported data.", + "deprecated": true, + "description": "Output only. Deprecated: Output only. If an external destination was requested, the URI of the exported data is deprecated. The persistent diagnostic details are stored inside the Diagnostic resource instead.", "readOnly": true, "type": "string" }, "fullTrajectories": { "deprecated": true, - "description": "Output only. Deprecated: Use full_trajectory_steps instead. The complete sequence of thoughts and actions (full trajectory).", + "description": "Output only. Deprecated: Use full_trajectory_steps instead. Output only. The complete sequence of thoughts and actions (full trajectory).", "items": { "type": "string" }, @@ -15621,7 +16153,8 @@ "type": "array" }, "fullTrajectorySteps": { - "description": "Output only. The complete sequence of thoughts and actions taken by the agent.", + "deprecated": true, + "description": "Output only. Deprecated: Output only. The complete sequence of thoughts and actions taken by the agent is deprecated under LRO response completions. Use the persistent details inside the Diagnostic resource instead.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1SherlockStep" }, @@ -15635,8 +16168,17 @@ "description": "A diagnostic report containing aggregate metrics and intent breakdowns.", "id": "GoogleCloudContactcenterinsightsV1alpha1DiagnosticReport", "properties": { + "conversationSlices": { + "additionalProperties": { + "$ref": "GoogleCloudContactcenterinsightsV1alpha1DiagnosticReportConversationSlice" + }, + "description": "Output only. A map of conversation slices used in the report.", + "readOnly": true, + "type": "object" + }, "intentStats": { - "description": "Output only. A breakdown of metrics grouped by intent.", + "deprecated": true, + "description": "Output only. Deprecated: Intent breakdowns are no longer used.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DiagnosticReportIntentStats" }, @@ -15659,6 +16201,25 @@ "description": "Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics.", "readOnly": true, "type": "object" + }, + "report": { + "description": "Output only. The final report in markdown format.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1alpha1DiagnosticReportConversationSlice": { + "description": "Output only. A map of conversation slices used in the report.", + "id": "GoogleCloudContactcenterinsightsV1alpha1DiagnosticReportConversationSlice", + "properties": { + "conversationIds": { + "description": "The list of conversation IDs that match this slice.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -17336,6 +17897,14 @@ "readOnly": true, "type": "string" }, + "links": { + "description": "Output only. A list of links to conversations or bot instructions.", + "items": { + "$ref": "GoogleCloudContactcenterinsightsV1alpha1LossPatternLink" + }, + "readOnly": true, + "type": "array" + }, "percentage": { "description": "Output only. The percentage of conversations that match this loss pattern.", "format": "double", @@ -17350,6 +17919,83 @@ }, "type": "object" }, + "GoogleCloudContactcenterinsightsV1alpha1LossPatternLink": { + "description": "A link to a conversation or bot instruction.", + "id": "GoogleCloudContactcenterinsightsV1alpha1LossPatternLink", + "properties": { + "botInstructionLink": { + "$ref": "GoogleCloudContactcenterinsightsV1alpha1LossPatternLinkBotInstructionLink", + "description": "A link to a bot instruction." + }, + "conversationLink": { + "$ref": "GoogleCloudContactcenterinsightsV1alpha1LossPatternLinkConversationLink", + "description": "A link to a conversation." + }, + "endByteIndex": { + "description": "The end byte index of the highlighted text (exclusive).", + "format": "int32", + "type": "integer" + }, + "highlightedText": { + "description": "The text that is highlighted. (populated for debugging purposes)", + "type": "string" + }, + "locationType": { + "description": "The location type.", + "enum": [ + "LOCATION_TYPE_UNSPECIFIED", + "DESCRIPTION", + "SUGGESTED_FIXES", + "EXAMPLES" + ], + "enumDescriptions": [ + "Unspecified location type.", + "The link applies to the description field.", + "The link applies to the suggested_fixes field.", + "The link applies to the examples field." + ], + "type": "string" + }, + "startByteIndex": { + "description": "The start byte index of the highlighted text (inclusive).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1alpha1LossPatternLinkBotInstructionLink": { + "description": "A link to a bot instruction.", + "id": "GoogleCloudContactcenterinsightsV1alpha1LossPatternLinkBotInstructionLink", + "properties": { + "endLine": { + "description": "The exclusive end line number of the instructions.", + "format": "int32", + "type": "integer" + }, + "startLine": { + "description": "The inclusive start line number of the instructions.", + "format": "int32", + "type": "integer" + }, + "subagent": { + "description": "The name of the subagent.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1alpha1LossPatternLinkConversationLink": { + "description": "A link to a conversation.", + "id": "GoogleCloudContactcenterinsightsV1alpha1LossPatternLinkConversationLink", + "properties": { + "conversationId": { + "description": "The conversation ID.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1alpha1MetricValue": { "deprecated": true, "description": "Deprecated: MetricValue is no longer used for diagnostics.", @@ -18463,8 +19109,36 @@ "description": "A step in the agent's reasoning process (Trajectory Step).", "id": "GoogleCloudContactcenterinsightsV1alpha1SherlockStep", "properties": { + "agentId": { + "description": "Output only. The ID of the agent that produced/received this content.", + "readOnly": true, + "type": "string" + }, + "content": { + "$ref": "GoogleCloudAiplatformV1Content", + "description": "Output only. The content of the turn (either Model or User role).", + "readOnly": true + }, + "stateDeltas": { + "description": "Output only. List of state changes caused by this specific turn.", + "items": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "readOnly": true, + "type": "array" + }, + "stepId": { + "description": "Output only. Unique ID for this specific turn.", + "readOnly": true, + "type": "string" + }, "textInput": { - "description": "Output only. Natural language input stimulus.", + "deprecated": true, + "description": "Output only. Deprecated: Use content instead.", "items": { "type": "string" }, @@ -18472,12 +19146,14 @@ "type": "array" }, "thought": { - "description": "Output only. The reasoning or internal monologue of the agent.", + "deprecated": true, + "description": "Output only. Deprecated: Use content instead.", "readOnly": true, "type": "string" }, "toolCalls": { - "description": "Output only. The tool call issued by the agent.", + "deprecated": true, + "description": "Output only. Deprecated: Use content instead.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1ToolCall" }, @@ -18489,7 +19165,8 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Output only. The output response from the tool execution.", + "deprecated": true, + "description": "Output only. Deprecated: Use content instead.", "readOnly": true, "type": "object" } @@ -20565,7 +21242,7 @@ }, "partialTrajectories": { "deprecated": true, - "description": "Output only. Deprecated: Use partial_trajectory_steps instead. The intermediate trajectory updates (partial trajectory).", + "description": "Output only. Deprecated: Use partial_trajectory_steps instead. Output only. The intermediate trajectory updates (partial trajectory).", "items": { "type": "string" }, @@ -20593,7 +21270,8 @@ "id": "GoogleCloudContactcenterinsightsV1mainDiagnoseConversationsRequest", "properties": { "dryRun": { - "description": "Optional. If true, the request will be validated and a simulation of the analysis will be performed without actually executing the task.", + "deprecated": true, + "description": "Optional. Deprecated: If true, the request will be validated and a simulation of the analysis will be performed without actually executing the task. This field is unused. Use validate_only instead.", "type": "boolean" }, "filter": { @@ -20601,7 +21279,8 @@ "type": "string" }, "fullReport": { - "description": "Optional. If true, the agent will generate a full diagnostic report for all sub-agents.", + "deprecated": true, + "description": "Optional. Deprecated: If true, the agent will generate a full diagnostic report for all sub-agents. Subagent reporting configuration is unused. The final diagnostic details are already persisted inside the Diagnostic resource instead.", "type": "boolean" }, "instructions": { @@ -20629,7 +21308,8 @@ }, "outputConfig": { "$ref": "GoogleCloudContactcenterinsightsV1mainOutputConfig", - "description": "Optional. The configuration for the output of the task." + "deprecated": true, + "description": "Optional. Deprecated: The configuration for the output of the task. The export destination is unused. Detailed markdown and conversation slices are already persisted inside the Diagnostic resource instead." }, "parent": { "description": "Required. The parent resource where the analysis will be performed.", @@ -20655,18 +21335,20 @@ "id": "GoogleCloudContactcenterinsightsV1mainDiagnoseConversationsResponse", "properties": { "answer": { - "description": "Output only. The final, high-level answer or diagnostic summary returned by the Sherlock worker.", + "deprecated": true, + "description": "Output only. Deprecated: Output only. The final, high-level answer or diagnostic summary returned by the Sherlock worker is deprecated. The persistent analysis summary is stored inside the Diagnostic resource instead.", "readOnly": true, "type": "string" }, "exportUri": { - "description": "Output only. If an external destination was requested, the URI of the exported data.", + "deprecated": true, + "description": "Output only. Deprecated: Output only. If an external destination was requested, the URI of the exported data is deprecated. The persistent diagnostic details are stored inside the Diagnostic resource instead.", "readOnly": true, "type": "string" }, "fullTrajectories": { "deprecated": true, - "description": "Output only. Deprecated: Use full_trajectory_steps instead. The complete sequence of thoughts and actions (full trajectory).", + "description": "Output only. Deprecated: Use full_trajectory_steps instead. Output only. The complete sequence of thoughts and actions (full trajectory).", "items": { "type": "string" }, @@ -20674,7 +21356,8 @@ "type": "array" }, "fullTrajectorySteps": { - "description": "Output only. The complete sequence of thoughts and actions taken by the agent.", + "deprecated": true, + "description": "Output only. Deprecated: Output only. The complete sequence of thoughts and actions taken by the agent is deprecated under LRO response completions. Use the persistent details inside the Diagnostic resource instead.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainSherlockStep" }, @@ -20688,8 +21371,17 @@ "description": "A diagnostic report containing aggregate metrics and intent breakdowns.", "id": "GoogleCloudContactcenterinsightsV1mainDiagnosticReport", "properties": { + "conversationSlices": { + "additionalProperties": { + "$ref": "GoogleCloudContactcenterinsightsV1mainDiagnosticReportConversationSlice" + }, + "description": "Output only. A map of conversation slices used in the report.", + "readOnly": true, + "type": "object" + }, "intentStats": { - "description": "Output only. A breakdown of metrics grouped by intent.", + "deprecated": true, + "description": "Output only. Deprecated: Intent breakdowns are no longer used.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainDiagnosticReportIntentStats" }, @@ -20712,6 +21404,25 @@ "description": "Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics.", "readOnly": true, "type": "object" + }, + "report": { + "description": "Output only. The final report in markdown format.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1mainDiagnosticReportConversationSlice": { + "description": "Output only. A map of conversation slices used in the report.", + "id": "GoogleCloudContactcenterinsightsV1mainDiagnosticReportConversationSlice", + "properties": { + "conversationIds": { + "description": "The list of conversation IDs that match this slice.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -22389,6 +23100,14 @@ "readOnly": true, "type": "string" }, + "links": { + "description": "Output only. A list of links to conversations or bot instructions.", + "items": { + "$ref": "GoogleCloudContactcenterinsightsV1mainLossPatternLink" + }, + "readOnly": true, + "type": "array" + }, "percentage": { "description": "Output only. The percentage of conversations that match this loss pattern.", "format": "double", @@ -22403,6 +23122,83 @@ }, "type": "object" }, + "GoogleCloudContactcenterinsightsV1mainLossPatternLink": { + "description": "A link to a conversation or bot instruction.", + "id": "GoogleCloudContactcenterinsightsV1mainLossPatternLink", + "properties": { + "botInstructionLink": { + "$ref": "GoogleCloudContactcenterinsightsV1mainLossPatternLinkBotInstructionLink", + "description": "A link to a bot instruction." + }, + "conversationLink": { + "$ref": "GoogleCloudContactcenterinsightsV1mainLossPatternLinkConversationLink", + "description": "A link to a conversation." + }, + "endByteIndex": { + "description": "The end byte index of the highlighted text (exclusive).", + "format": "int32", + "type": "integer" + }, + "highlightedText": { + "description": "The text that is highlighted. (populated for debugging purposes)", + "type": "string" + }, + "locationType": { + "description": "The location type.", + "enum": [ + "LOCATION_TYPE_UNSPECIFIED", + "DESCRIPTION", + "SUGGESTED_FIXES", + "EXAMPLES" + ], + "enumDescriptions": [ + "Unspecified location type.", + "The link applies to the description field.", + "The link applies to the suggested_fixes field.", + "The link applies to the examples field." + ], + "type": "string" + }, + "startByteIndex": { + "description": "The start byte index of the highlighted text (inclusive).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1mainLossPatternLinkBotInstructionLink": { + "description": "A link to a bot instruction.", + "id": "GoogleCloudContactcenterinsightsV1mainLossPatternLinkBotInstructionLink", + "properties": { + "endLine": { + "description": "The exclusive end line number of the instructions.", + "format": "int32", + "type": "integer" + }, + "startLine": { + "description": "The inclusive start line number of the instructions.", + "format": "int32", + "type": "integer" + }, + "subagent": { + "description": "The name of the subagent.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1mainLossPatternLinkConversationLink": { + "description": "A link to a conversation.", + "id": "GoogleCloudContactcenterinsightsV1mainLossPatternLinkConversationLink", + "properties": { + "conversationId": { + "description": "The conversation ID.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1mainMetricValue": { "deprecated": true, "description": "Deprecated: MetricValue is no longer used for diagnostics.", @@ -23516,8 +24312,36 @@ "description": "A step in the agent's reasoning process (Trajectory Step).", "id": "GoogleCloudContactcenterinsightsV1mainSherlockStep", "properties": { + "agentId": { + "description": "Output only. The ID of the agent that produced/received this content.", + "readOnly": true, + "type": "string" + }, + "content": { + "$ref": "GoogleCloudAiplatformV1Content", + "description": "Output only. The content of the turn (either Model or User role).", + "readOnly": true + }, + "stateDeltas": { + "description": "Output only. List of state changes caused by this specific turn.", + "items": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "readOnly": true, + "type": "array" + }, + "stepId": { + "description": "Output only. Unique ID for this specific turn.", + "readOnly": true, + "type": "string" + }, "textInput": { - "description": "Output only. Natural language input stimulus.", + "deprecated": true, + "description": "Output only. Deprecated: Use content instead.", "items": { "type": "string" }, @@ -23525,12 +24349,14 @@ "type": "array" }, "thought": { - "description": "Output only. The reasoning or internal monologue of the agent.", + "deprecated": true, + "description": "Output only. Deprecated: Use content instead.", "readOnly": true, "type": "string" }, "toolCalls": { - "description": "Output only. The tool call issued by the agent.", + "deprecated": true, + "description": "Output only. Deprecated: Use content instead.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainToolCall" }, @@ -23542,7 +24368,8 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Output only. The output response from the tool execution.", + "deprecated": true, + "description": "Output only. Deprecated: Use content instead.", "readOnly": true, "type": "object" } diff --git a/discovery/datalineage-v1.json b/discovery/datalineage-v1.json index 743aafea35b..f27924911e0 100644 --- a/discovery/datalineage-v1.json +++ b/discovery/datalineage-v1.json @@ -1275,7 +1275,7 @@ } } }, - "revision": "20260506", + "revision": "20260511", "rootUrl": "https://datalineage.googleapis.com/", "schemas": { "GoogleCloudDatacatalogLineageConfigmanagementV1Config": { @@ -1375,7 +1375,7 @@ "type": "integer" }, "pageToken": { - "description": "The page token received from a previous `BatchSearchLinkProcesses` call. Use it to get the next page. When requesting subsequent pages of a response, remember that all parameters must match the values you provided in the original request.", + "description": "Optional. The page token received from a previous `BatchSearchLinkProcesses` call. Use it to get the next page. When requesting subsequent pages of a response, remember that all parameters must match the values you provided in the original request.", "type": "string" } }, diff --git a/discovery/datamigration-v1.json b/discovery/datamigration-v1.json index 9f6a59bbc2e..5ef9a8fa0d5 100644 --- a/discovery/datamigration-v1.json +++ b/discovery/datamigration-v1.json @@ -408,7 +408,7 @@ ] }, "list": { - "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", + "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "datamigration.projects.locations.list", @@ -417,7 +417,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2587,7 +2587,7 @@ } } }, - "revision": "20260406", + "revision": "20260511", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AlloyDbConnectionProfile": { @@ -4175,13 +4175,15 @@ "ISSUE_TYPE_UNSPECIFIED", "ISSUE_TYPE_DDL", "ISSUE_TYPE_APPLY", - "ISSUE_TYPE_CONVERT" + "ISSUE_TYPE_CONVERT", + "ISSUE_TYPE_PULL_SCHEMA" ], "enumDescriptions": [ "Unspecified issue type.", "Issue originated from the DDL", "Issue originated during the apply process", - "Issue originated during the convert process" + "Issue originated during the convert process", + "Issue originated during the pull schema process" ], "type": "string" } @@ -6430,7 +6432,7 @@ "id": "QuotaFailureViolation", "properties": { "apiService": { - "description": "The API Service from which the `QuotaFailure.Violation` orginates. In some cases, Quota issues originate from an API Service other than the one that was called. In other words, a dependency of the called API Service could be the cause of the `QuotaFailure`, and this field would have the dependency API service name. For example, if the called API is Kubernetes Engine API (container.googleapis.com), and a quota violation occurs in the Kubernetes Engine API itself, this field would be \"container.googleapis.com\". On the other hand, if the quota violation occurs when the Kubernetes Engine API creates VMs in the Compute Engine API (compute.googleapis.com), this field would be \"compute.googleapis.com\".", + "description": "The API Service from which the `QuotaFailure.Violation` originates. In some cases, Quota issues originate from an API Service other than the one that was called. In other words, a dependency of the called API Service could be the cause of the `QuotaFailure`, and this field would have the dependency API service name. For example, if the called API is Kubernetes Engine API (container.googleapis.com), and a quota violation occurs in the Kubernetes Engine API itself, this field would be \"container.googleapis.com\". On the other hand, if the quota violation occurs when the Kubernetes Engine API creates VMs in the Compute Engine API (compute.googleapis.com), this field would be \"compute.googleapis.com\".", "type": "string" }, "description": { diff --git a/discovery/datamigration-v1beta1.json b/discovery/datamigration-v1beta1.json index f8bb535d592..c01551f5d82 100644 --- a/discovery/datamigration-v1beta1.json +++ b/discovery/datamigration-v1beta1.json @@ -372,7 +372,7 @@ ] }, "list": { - "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", + "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1beta1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "datamigration.projects.locations.list", @@ -381,7 +381,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1297,7 +1297,7 @@ } } }, - "revision": "20260406", + "revision": "20260511", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AuditConfig": { @@ -2350,7 +2350,7 @@ "id": "QuotaFailureViolation", "properties": { "apiService": { - "description": "The API Service from which the `QuotaFailure.Violation` orginates. In some cases, Quota issues originate from an API Service other than the one that was called. In other words, a dependency of the called API Service could be the cause of the `QuotaFailure`, and this field would have the dependency API service name. For example, if the called API is Kubernetes Engine API (container.googleapis.com), and a quota violation occurs in the Kubernetes Engine API itself, this field would be \"container.googleapis.com\". On the other hand, if the quota violation occurs when the Kubernetes Engine API creates VMs in the Compute Engine API (compute.googleapis.com), this field would be \"compute.googleapis.com\".", + "description": "The API Service from which the `QuotaFailure.Violation` originates. In some cases, Quota issues originate from an API Service other than the one that was called. In other words, a dependency of the called API Service could be the cause of the `QuotaFailure`, and this field would have the dependency API service name. For example, if the called API is Kubernetes Engine API (container.googleapis.com), and a quota violation occurs in the Kubernetes Engine API itself, this field would be \"container.googleapis.com\". On the other hand, if the quota violation occurs when the Kubernetes Engine API creates VMs in the Compute Engine API (compute.googleapis.com), this field would be \"compute.googleapis.com\".", "type": "string" }, "description": { diff --git a/discovery/dataplex-v1.json b/discovery/dataplex-v1.json index cc01f70e68b..d823d01f57c 100644 --- a/discovery/dataplex-v1.json +++ b/discovery/dataplex-v1.json @@ -2071,6 +2071,35 @@ "https://www.googleapis.com/auth/dataplex.read-write" ] }, + "requestAccess": { + "description": "Requests access to a data product. This will trigger an access approval workflow, and the requester will need to wait for the approval to be granted before they will be able to access the data product assets.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataProducts/{dataProductsId}:requestAccess", + "httpMethod": "POST", + "id": "dataplex.projects.locations.dataProducts.requestAccess", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the data product. Format: projects/{project_number}/locations/{location_id}/dataProducts/{data_product_id}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataProducts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}:requestAccess", + "request": { + "$ref": "GoogleCloudDataplexV1RequestDataProductAccessRequest" + }, + "response": { + "$ref": "GoogleCloudDataplexV1RequestDataProductAccessResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dataplex.read-write" + ] + }, "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}/dataProducts/{dataProductsId}:setIamPolicy", @@ -2341,7 +2370,7 @@ ], "parameters": { "dataScanId": { - "description": "Required. DataScan identifier. Must contain only lowercase letters, numbers and hyphens. Must start with a letter. Must end with a number or a letter. Must be between 1-63 characters. Must be unique within the customer project / location.", + "description": "Optional. DataScan identifier. If not provided, a unique ID will be generated with the prefix \"data-scan-\". Must contain only lowercase letters, numbers and hyphens. Must start with a letter. Must end with a number or a letter. Must be between 1-63 characters. Must be unique within the customer project / location.", "location": "query", "type": "string" }, @@ -7490,7 +7519,7 @@ } } }, - "revision": "20260428", + "revision": "20260514", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { "Empty": { @@ -8420,6 +8449,284 @@ "properties": {}, "type": "object" }, + "GoogleCloudDataplexV1ChangeRequest": { + "description": "Represents a proposed change to a metadata resource.", + "id": "GoogleCloudDataplexV1ChangeRequest", + "properties": { + "approver": { + "description": "Output only. The email address of the user who approved/rejected the ChangeRequest.", + "readOnly": true, + "type": "string" + }, + "author": { + "description": "Output only. The email address of the user who created the ChangeRequest.", + "readOnly": true, + "type": "string" + }, + "changeType": { + "description": "Output only. The type of change represented by the change_payload. This field is derived from the populated field in the change_payload oneof.", + "enum": [ + "CHANGE_TYPE_UNSPECIFIED", + "CREATE_ENTRY", + "UPDATE_ENTRY", + "DELETE_ENTRY", + "CREATE_ENTRY_LINK", + "DELETE_ENTRY_LINK", + "CREATE_GLOSSARY", + "UPDATE_GLOSSARY", + "DELETE_GLOSSARY", + "CREATE_GLOSSARY_CATEGORY", + "UPDATE_GLOSSARY_CATEGORY", + "DELETE_GLOSSARY_CATEGORY", + "CREATE_GLOSSARY_TERM", + "UPDATE_GLOSSARY_TERM", + "DELETE_GLOSSARY_TERM" + ], + "enumDescriptions": [ + "State unspecified.", + "Request to create an Entry.", + "Request to update an Entry.", + "Request to delete an Entry.", + "Request to create an EntryLink.", + "Request to delete an EntryLink.", + "Request to create a Glossary.", + "Request to update a Glossary.", + "Request to delete a Glossary.", + "Request to create a GlossaryCategory.", + "Request to update a GlossaryCategory.", + "Request to delete a GlossaryCategory.", + "Request to create a GlossaryTerm.", + "Request to update a GlossaryTerm.", + "Request to delete a GlossaryTerm." + ], + "readOnly": true, + "type": "string" + }, + "createEntry": { + "$ref": "GoogleCloudDataplexV1CreateEntryRequest", + "description": "Payload for creating an Entry." + }, + "createEntryLink": { + "$ref": "GoogleCloudDataplexV1CreateEntryLinkRequest", + "description": "Payload for creating an EntryLink." + }, + "createGlossary": { + "$ref": "GoogleCloudDataplexV1CreateGlossaryRequest", + "description": "Payload for creating a Glossary." + }, + "createGlossaryCategory": { + "$ref": "GoogleCloudDataplexV1CreateGlossaryCategoryRequest", + "description": "Payload for creating a GlossaryCategory." + }, + "createGlossaryTerm": { + "$ref": "GoogleCloudDataplexV1CreateGlossaryTermRequest", + "description": "Payload for creating a GlossaryTerm." + }, + "createTime": { + "description": "Output only. The time when the ChangeRequest was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "deleteEntry": { + "$ref": "GoogleCloudDataplexV1DeleteEntryRequest", + "description": "Payload for deleting an Entry." + }, + "deleteEntryLink": { + "$ref": "GoogleCloudDataplexV1DeleteEntryLinkRequest", + "description": "Payload for deleting an EntryLink." + }, + "deleteGlossary": { + "$ref": "GoogleCloudDataplexV1DeleteGlossaryRequest", + "description": "Payload for deleting a Glossary." + }, + "deleteGlossaryCategory": { + "$ref": "GoogleCloudDataplexV1DeleteGlossaryCategoryRequest", + "description": "Payload for deleting a GlossaryCategory." + }, + "deleteGlossaryTerm": { + "$ref": "GoogleCloudDataplexV1DeleteGlossaryTermRequest", + "description": "Payload for deleting a GlossaryTerm." + }, + "etag": { + "description": "Optional. This checksum is computed by the service. It can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", + "type": "string" + }, + "justification": { + "description": "Optional. Justification of the ChangeRequest. This should explain why the change is needed or why it should be approved.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. User-defined labels for the ChangeRequest.", + "type": "object" + }, + "name": { + "description": "Identifier. The relative resource name of the ChangeRequest, of the form: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id}", + "type": "string" + }, + "rejectionComment": { + "description": "Output only. The reason provided for rejecting the ChangeRequest.", + "readOnly": true, + "type": "string" + }, + "resource": { + "description": "Output only. The full resource name of the target resource to be modified. Example: //dataplex.googleapis.com/projects/my-project/locations/us-central1/entryGroups/my-group/entries/my-entry", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The current state of the ChangeRequest.", + "enum": [ + "STATE_UNSPECIFIED", + "NEW", + "APPROVED", + "REJECTED", + "EXPIRED", + "REVOKED" + ], + "enumDescriptions": [ + "State unspecified.", + "The change is proposed and new.", + "The change has been approved.", + "The change has been rejected.", + "The change request has expired.", + "The approved change has been revoked." + ], + "readOnly": true, + "type": "string" + }, + "uid": { + "description": "Output only. System generated globally unique ID for the ChangeRequest.", + "readOnly": true, + "type": "string" + }, + "updateEntry": { + "$ref": "GoogleCloudDataplexV1UpdateEntryRequest", + "description": "Payload for updating an Entry." + }, + "updateGlossary": { + "$ref": "GoogleCloudDataplexV1UpdateGlossaryRequest", + "description": "Payload for updating a Glossary." + }, + "updateGlossaryCategory": { + "$ref": "GoogleCloudDataplexV1UpdateGlossaryCategoryRequest", + "description": "Payload for updating a GlossaryCategory." + }, + "updateGlossaryTerm": { + "$ref": "GoogleCloudDataplexV1UpdateGlossaryTermRequest", + "description": "Payload for updating a GlossaryTerm." + }, + "updateTime": { + "description": "Output only. The time when the ChangeRequest was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1CreateEntryLinkRequest": { + "description": "Request message for CreateEntryLink.", + "id": "GoogleCloudDataplexV1CreateEntryLinkRequest", + "properties": { + "entryLink": { + "$ref": "GoogleCloudDataplexV1EntryLink", + "description": "Required. Entry Link resource." + }, + "entryLinkId": { + "description": "Required. Entry Link identifier * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the EntryGroup.", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the parent Entry Group: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1CreateEntryRequest": { + "description": "Create Entry request.", + "id": "GoogleCloudDataplexV1CreateEntryRequest", + "properties": { + "entry": { + "$ref": "GoogleCloudDataplexV1Entry", + "description": "Required. Entry resource." + }, + "entryId": { + "description": "Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud.The maximum size of the field is 4000 characters.", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1CreateGlossaryCategoryRequest": { + "description": "Creates a new GlossaryCategory under the specified Glossary.", + "id": "GoogleCloudDataplexV1CreateGlossaryCategoryRequest", + "properties": { + "category": { + "$ref": "GoogleCloudDataplexV1GlossaryCategory", + "description": "Required. The GlossaryCategory to create." + }, + "categoryId": { + "description": "Required. GlossaryCategory identifier.", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource where this GlossaryCategory will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where locationId refers to a Google Cloud region.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1CreateGlossaryRequest": { + "description": "Create Glossary Request", + "id": "GoogleCloudDataplexV1CreateGlossaryRequest", + "properties": { + "glossary": { + "$ref": "GoogleCloudDataplexV1Glossary", + "description": "Required. The Glossary to create." + }, + "glossaryId": { + "description": "Required. Glossary ID: Glossary identifier.", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource where this Glossary will be created. Format: projects/{project_id_or_number}/locations/{location_id} where location_id refers to a Google Cloud region.", + "type": "string" + }, + "validateOnly": { + "description": "Optional. Validates the request without actually creating the Glossary. Default: false.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1CreateGlossaryTermRequest": { + "description": "Creates a new GlossaryTerm under the specified Glossary.", + "id": "GoogleCloudDataplexV1CreateGlossaryTermRequest", + "properties": { + "parent": { + "description": "Required. The parent resource where the GlossaryTerm will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where location_id refers to a Google Cloud region.", + "type": "string" + }, + "term": { + "$ref": "GoogleCloudDataplexV1GlossaryTerm", + "description": "Required. The GlossaryTerm to create." + }, + "termId": { + "description": "Required. GlossaryTerm identifier.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDataplexV1DataAccessSpec": { "description": "DataAccessSpec holds the access control configuration to be enforced on data stored within resources (eg: rows, columns in BigQuery Tables). When associated with data, the data is only accessible to principals explicitly granted access through the DataAccessSpec. Principals with access to the containing resource are not implicitly granted access.", "id": "GoogleCloudDataplexV1DataAccessSpec", @@ -9112,6 +9419,10 @@ "description": "A data product is a curated collection of data assets, packaged to address specific use cases. It's a way to manage and share data in a more organized, product-like manner.", "id": "GoogleCloudDataplexV1DataProduct", "properties": { + "accessApprovalConfig": { + "$ref": "GoogleCloudDataplexV1DataProductAccessApprovalConfig", + "description": "Optional. Configuration for access approval for the data product." + }, "accessGroups": { "additionalProperties": { "$ref": "GoogleCloudDataplexV1DataProductAccessGroup" @@ -9180,6 +9491,20 @@ }, "type": "object" }, + "GoogleCloudDataplexV1DataProductAccessApprovalConfig": { + "description": "Configuration for access approval for the data product.", + "id": "GoogleCloudDataplexV1DataProductAccessApprovalConfig", + "properties": { + "approverEmails": { + "description": "Optional. Specifies the email addresses of users who are potential approvers and are notified when an access request is made for the data product. The maximum number of emails allowed is 10.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDataplexV1DataProductAccessGroup": { "description": "Custom user defined access groups at the data product level. These are used for granting different levels of access (IAM roles) on the individual data product's data assets.", "id": "GoogleCloudDataplexV1DataProductAccessGroup", @@ -9210,6 +9535,10 @@ "googleGroup": { "description": "Optional. Email of the Google Group, as per https://cloud.google.com/iam/docs/principals-overview#google-group.", "type": "string" + }, + "serviceAccount": { + "description": "Optional. Specifies the email of the producer service account, as per https://cloud.google.com/iam/docs/principals-overview#service-account.", + "type": "string" } }, "type": "object" @@ -11193,6 +11522,65 @@ }, "type": "object" }, + "GoogleCloudDataplexV1DeleteEntryLinkRequest": { + "description": "Request message for DeleteEntryLink.", + "id": "GoogleCloudDataplexV1DeleteEntryLinkRequest", + "properties": { + "name": { + "description": "Required. The resource name of the Entry Link: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1DeleteEntryRequest": { + "description": "Delete Entry request.", + "id": "GoogleCloudDataplexV1DeleteEntryRequest", + "properties": { + "name": { + "description": "Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1DeleteGlossaryCategoryRequest": { + "description": "Delete GlossaryCategory Request", + "id": "GoogleCloudDataplexV1DeleteGlossaryCategoryRequest", + "properties": { + "name": { + "description": "Required. The name of the GlossaryCategory to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1DeleteGlossaryRequest": { + "description": "Delete Glossary Request", + "id": "GoogleCloudDataplexV1DeleteGlossaryRequest", + "properties": { + "etag": { + "description": "Optional. The etag of the Glossary. If this is provided, it must match the server's etag. If the etag is provided and does not match the server-computed etag, the request must fail with a ABORTED error code.", + "type": "string" + }, + "name": { + "description": "Required. The name of the Glossary to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1DeleteGlossaryTermRequest": { + "description": "Delete GlossaryTerm Request", + "id": "GoogleCloudDataplexV1DeleteGlossaryTermRequest", + "properties": { + "name": { + "description": "Required. The name of the GlossaryTerm to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDataplexV1DiscoveryEvent": { "description": "The payload associated with Discovery data processing.", "id": "GoogleCloudDataplexV1DiscoveryEvent", @@ -13219,6 +13607,10 @@ "description": "Lookup Context using permissions in the source system.", "id": "GoogleCloudDataplexV1LookupContextRequest", "properties": { + "context": { + "description": "Optional. The text representing contextual information for which metadata context is being requested.", + "type": "string" + }, "options": { "additionalProperties": { "type": "string" @@ -13846,6 +14238,32 @@ }, "type": "object" }, + "GoogleCloudDataplexV1RequestDataProductAccessRequest": { + "description": "Message for requesting access to a Data Product.", + "id": "GoogleCloudDataplexV1RequestDataProductAccessRequest", + "properties": { + "changeRequest": { + "$ref": "GoogleCloudDataplexV1ChangeRequest", + "description": "Required. The change request for the data product access request." + }, + "validateOnly": { + "description": "Optional. Validates the request without actually creating the access change request. Defaults to false.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1RequestDataProductAccessResponse": { + "description": "Response message for requesting access to a Data Product.", + "id": "GoogleCloudDataplexV1RequestDataProductAccessResponse", + "properties": { + "changeRequestName": { + "description": "The resource name of the created ChangeRequest. Format: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id}", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDataplexV1ResourceAccessSpec": { "description": "ResourceAccessSpec holds the access control configuration to be enforced on the resources, for example, Cloud Storage bucket, BigQuery dataset, BigQuery table.", "id": "GoogleCloudDataplexV1ResourceAccessSpec", @@ -14804,6 +15222,89 @@ }, "type": "object" }, + "GoogleCloudDataplexV1UpdateEntryRequest": { + "description": "Update Entry request.", + "id": "GoogleCloudDataplexV1UpdateEntryRequest", + "properties": { + "allowMissing": { + "description": "Optional. If set to true and the entry doesn't exist, the service will create it.", + "type": "boolean" + }, + "aspectKeys": { + "description": "Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. @* - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request.", + "items": { + "type": "string" + }, + "type": "array" + }, + "deleteMissingAspects": { + "description": "Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request.", + "type": "boolean" + }, + "entry": { + "$ref": "GoogleCloudDataplexV1Entry", + "description": "Required. Entry resource." + }, + "updateMask": { + "description": "Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value \"aspects\".If the update_mask is empty, the service will update all modifiable fields present in the request.", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1UpdateGlossaryCategoryRequest": { + "description": "Update GlossaryCategory Request", + "id": "GoogleCloudDataplexV1UpdateGlossaryCategoryRequest", + "properties": { + "category": { + "$ref": "GoogleCloudDataplexV1GlossaryCategory", + "description": "Required. The GlossaryCategory to update. The GlossaryCategory's name field is used to identify the GlossaryCategory to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}" + }, + "updateMask": { + "description": "Required. The list of fields to update.", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1UpdateGlossaryRequest": { + "description": "Update Glossary Request", + "id": "GoogleCloudDataplexV1UpdateGlossaryRequest", + "properties": { + "glossary": { + "$ref": "GoogleCloudDataplexV1Glossary", + "description": "Required. The Glossary to update. The Glossary's name field is used to identify the Glossary to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}" + }, + "updateMask": { + "description": "Required. The list of fields to update.", + "format": "google-fieldmask", + "type": "string" + }, + "validateOnly": { + "description": "Optional. Validates the request without actually updating the Glossary. Default: false.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1UpdateGlossaryTermRequest": { + "description": "Update GlossaryTerm Request", + "id": "GoogleCloudDataplexV1UpdateGlossaryTermRequest", + "properties": { + "term": { + "$ref": "GoogleCloudDataplexV1GlossaryTerm", + "description": "Required. The GlossaryTerm to update. The GlossaryTerm's name field is used to identify the GlossaryTerm to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}" + }, + "updateMask": { + "description": "Required. The list of fields to update.", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDataplexV1Zone": { "description": "A zone represents a logical group of related assets within a lake. A zone can be used to map to organizational structure or represent stages of data readiness from raw to curated. It provides managing behavior that is shared or inherited by all contained assets.", "id": "GoogleCloudDataplexV1Zone", diff --git a/discovery/datastream-v1.json b/discovery/datastream-v1.json index 28b7ddfebe7..d24c412b9f4 100644 --- a/discovery/datastream-v1.json +++ b/discovery/datastream-v1.json @@ -1503,7 +1503,7 @@ } } }, - "revision": "20260426", + "revision": "20260503", "rootUrl": "https://datastream.googleapis.com/", "schemas": { "AppendOnly": { @@ -4259,6 +4259,18 @@ }, "type": "object" }, + "SpannerChangeStreamPosition": { + "description": "Represents a position in a Spanner change stream from which to start replicating.", + "id": "SpannerChangeStreamPosition", + "properties": { + "startTime": { + "description": "Required. The timestamp to start change stream queries from. The timestamp must be a positive value.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "SpannerColumn": { "description": "Spanner column.", "id": "SpannerColumn", @@ -4436,6 +4448,10 @@ "$ref": "OracleScnPosition", "description": "Oracle SCN to start replicating from." }, + "spannerChangeStreamPosition": { + "$ref": "SpannerChangeStreamPosition", + "description": "Optional. Spanner change stream position to start replicating from." + }, "sqlServerLsnPosition": { "$ref": "SqlServerLsnPosition", "description": "SqlServer LSN to start replicating from." diff --git a/discovery/developerknowledge-v1.json b/discovery/developerknowledge-v1.json index 468be505655..18f17851993 100644 --- a/discovery/developerknowledge-v1.json +++ b/discovery/developerknowledge-v1.json @@ -115,7 +115,7 @@ "parameterOrder": [], "parameters": { "names": { - "description": "Required. Specifies the names of the documents to retrieve. A maximum of 20 documents can be retrieved in a batch. The documents are returned in the same order as the `names` in the request. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`", + "description": "Required. Specifies the names of the documents to retrieve. A maximum of 20 documents can be retrieved in a batch. The documents are returned in the same order as the `names` in the request. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` If you are changing the batch size, consider the value of `maxConcurrentGCSFetches` constant in the service implementation: http://cs///depot/google3/devrel/boq/developerknowledge/service/developerknowledge.go", "location": "query", "repeated": true, "type": "string" @@ -228,7 +228,7 @@ } } }, - "revision": "20260413", + "revision": "20260510", "rootUrl": "https://developerknowledge.googleapis.com/", "schemas": { "BatchGetDocumentsResponse": { diff --git a/discovery/developerknowledge-v1alpha.json b/discovery/developerknowledge-v1alpha.json index 24012eef37b..a8c41e1df0c 100644 --- a/discovery/developerknowledge-v1alpha.json +++ b/discovery/developerknowledge-v1alpha.json @@ -115,7 +115,7 @@ "parameterOrder": [], "parameters": { "names": { - "description": "Required. Specifies the names of the documents to retrieve. A maximum of 20 documents can be retrieved in a batch. The documents are returned in the same order as the `names` in the request. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`", + "description": "Required. Specifies the names of the documents to retrieve. A maximum of 20 documents can be retrieved in a batch. The documents are returned in the same order as the `names` in the request. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` If you are changing the batch size, consider the value of `maxConcurrentGCSFetches` constant in the service implementation: http://cs///depot/google3/devrel/boq/developerknowledge/service/developerknowledge.go", "location": "query", "repeated": true, "type": "string" @@ -250,7 +250,7 @@ } } }, - "revision": "20260413", + "revision": "20260510", "rootUrl": "https://developerknowledge.googleapis.com/", "schemas": { "Answer": { @@ -258,7 +258,7 @@ "id": "Answer", "properties": { "answerText": { - "description": "The text of the answer.", + "description": "Contains the text of the answer.", "type": "string" } }, diff --git a/discovery/dfareporting-v4.json b/discovery/dfareporting-v4.json index 7cf9cb6996c..c6b97fff341 100644 --- a/discovery/dfareporting-v4.json +++ b/discovery/dfareporting-v4.json @@ -10465,7 +10465,7 @@ } } }, - "revision": "20260326", + "revision": "20260511", "rootUrl": "https://dfareporting.googleapis.com/", "schemas": { "Account": { @@ -12993,7 +12993,8 @@ "CREATIVE_AUTHORING_SOURCE_TYPEFACE_AI", "CREATIVE_AUTHORING_SOURCE_REMBRAND", "CREATIVE_AUTHORING_SOURCE_TRACKTO_STUDIO", - "CREATIVE_AUTHORING_SOURCE_BORNLOGIC" + "CREATIVE_AUTHORING_SOURCE_BORNLOGIC", + "CREATIVE_AUTHORING_SOURCE_BEGEN_AI" ], "enumDescriptions": [ "DCM-UI or external API used to author the creative.", @@ -13005,7 +13006,8 @@ "Creative authoring source is Typeface.ai.", "Creative authoring source is Rembrand.", "Creative authoring source is Trackto.", - "Creative authoring source is Bornlogic." + "Creative authoring source is Bornlogic.", + "Creative authoring source is BEGEN_AI." ], "type": "string" }, diff --git a/discovery/dfareporting-v5.json b/discovery/dfareporting-v5.json index 9e5ad52cecc..1f9dcde39d8 100644 --- a/discovery/dfareporting-v5.json +++ b/discovery/dfareporting-v5.json @@ -10091,7 +10091,7 @@ } } }, - "revision": "20260326", + "revision": "20260511", "rootUrl": "https://dfareporting.googleapis.com/", "schemas": { "Account": { @@ -12585,7 +12585,8 @@ "CREATIVE_AUTHORING_SOURCE_TYPEFACE_AI", "CREATIVE_AUTHORING_SOURCE_REMBRAND", "CREATIVE_AUTHORING_SOURCE_TRACKTO_STUDIO", - "CREATIVE_AUTHORING_SOURCE_BORNLOGIC" + "CREATIVE_AUTHORING_SOURCE_BORNLOGIC", + "CREATIVE_AUTHORING_SOURCE_BEGEN_AI" ], "enumDescriptions": [ "DCM-UI or external API used to author the creative.", @@ -12597,7 +12598,8 @@ "Creative authoring source is Typeface.ai.", "Creative authoring source is Rembrand.", "Creative authoring source is Trackto.", - "Creative authoring source is Bornlogic." + "Creative authoring source is Bornlogic.", + "Creative authoring source is BEGEN_AI." ], "type": "string" }, diff --git a/discovery/discoveryengine-v1.json b/discovery/discoveryengine-v1.json index 0210697a729..c40b38432a8 100644 --- a/discovery/discoveryengine-v1.json +++ b/discovery/discoveryengine-v1.json @@ -4039,7 +4039,7 @@ ] }, "setIamPolicy": { - "description": "Sets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.user` and `roles/discoveryengine.agentspaceUser`. Attempting to grant any other role will result in a warning in logging.", + "description": "Sets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.admin`, `roles/discoveryengine.agentspaceAdmin`, `roles/discoveryengine.user`, `roles/discoveryengine.agentspaceUser`, `roles/discoveryengine.viewer`, `roles/discoveryengine.agentspaceViewer`. Attempting to grant any other role will result in a warning in logging.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:setIamPolicy", "httpMethod": "POST", "id": "discoveryengine.projects.locations.collections.engines.setIamPolicy", @@ -8997,6 +8997,49 @@ "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, + "list": { + "description": "Lists all the LicenseConfigs associated with the project.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/licenseConfigs", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.licenseConfigs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The filter to apply to the list results. The supported fields are: * `subscription_tier` * `state` Examples: * `subscription_tier=SUBSCRIPTION_TIER_SEARCH,state=ACTIVE` - Lists all active search license configs. * `state=ACTIVE` - Lists all active license configs. The filter string should be a comma-separated list of field=value pairs.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Not supported.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Not supported.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/licenseConfigs", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1ListLicenseConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite", + "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" + ] + }, "patch": { "description": "Updates the LicenseConfig", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/licenseConfigs/{licenseConfigsId}", @@ -9594,7 +9637,7 @@ } } }, - "revision": "20260503", + "revision": "20260512", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "A2aV1APIKeySecurityScheme": { @@ -12698,14 +12741,16 @@ "IN_PROGRESS", "FAILED", "SUCCEEDED", - "SKIPPED" + "SKIPPED", + "CANCELLED" ], "enumDescriptions": [ "Unknown.", "Assist operation is currently in progress.", "Assist operation has failed.", "Assist operation has succeeded.", - "Assist operation has been skipped." + "Assist operation has been skipped.", + "Assist operation has been cancelled (e.g. client closed the stream). May contain a partial response." ], "type": "string" } @@ -15037,6 +15082,10 @@ }, "type": "array" }, + "connectorSourceId": { + "description": "Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source.", + "type": "string" + }, "connectorType": { "description": "Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.", "enum": [ @@ -16514,7 +16563,7 @@ ], "type": "string" }, - "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills`", + "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups`", "type": "object" }, "industryVertical": { @@ -17992,6 +18041,24 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1ListLicenseConfigsResponse": { + "description": "Response message for LicenseConfigService.ListLicenseConfigs method.", + "id": "GoogleCloudDiscoveryengineV1ListLicenseConfigsResponse", + "properties": { + "licenseConfigs": { + "description": "All the customer's LicenseConfigs.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1LicenseConfig" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Not supported.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse": { "description": "Response message for UserLicenseService.ListLicenseConfigsUsageStats method.", "id": "GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse", @@ -20753,6 +20820,11 @@ "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", "type": "string" }, + "pendingAsyncAssistOperationId": { + "description": "Output only. Full resource name of an in-progress AsyncAssist operation for this session, e.g. `projects/*/locations/*/collections/*/engines/*/sessions/*/operations/*`. Set when the operation starts and cleared when it finishes.", + "readOnly": true, + "type": "string" + }, "startTime": { "description": "Output only. The time the session started.", "format": "google-datetime", @@ -22340,7 +22412,7 @@ ], "type": "string" }, - "description": "Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills`", + "description": "Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups`", "readOnly": true, "type": "object" }, @@ -23408,14 +23480,16 @@ "IN_PROGRESS", "FAILED", "SUCCEEDED", - "SKIPPED" + "SKIPPED", + "CANCELLED" ], "enumDescriptions": [ "Unknown.", "Assist operation is currently in progress.", "Assist operation has failed.", "Assist operation has succeeded.", - "Assist operation has been skipped." + "Assist operation has been skipped.", + "Assist operation has been cancelled (e.g. client closed the stream). May contain a partial response." ], "type": "string" } @@ -24808,6 +24882,10 @@ }, "type": "array" }, + "connectorSourceId": { + "description": "Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source.", + "type": "string" + }, "connectorType": { "description": "Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.", "enum": [ @@ -26161,7 +26239,7 @@ ], "type": "string" }, - "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills`", + "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups`", "type": "object" }, "industryVertical": { @@ -28114,6 +28192,12 @@ "description": "Defines a user inputed query.", "id": "GoogleCloudDiscoveryengineV1alphaQuery", "properties": { + "createTime": { + "description": "Output only. The time at which the server accepted this query.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "parts": { "description": "Query content parts.", "items": { @@ -29633,6 +29717,11 @@ "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", "type": "string" }, + "pendingAsyncAssistOperationId": { + "description": "Output only. Full resource name of an in-progress AsyncAssist operation for this session, e.g. `projects/*/locations/*/collections/*/engines/*/sessions/*/operations/*`. Set when the operation starts and cleared when it finishes.", + "readOnly": true, + "type": "string" + }, "startTime": { "description": "Output only. The time the session started.", "format": "google-datetime", @@ -31601,7 +31690,7 @@ ], "type": "string" }, - "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills`", + "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups`", "type": "object" }, "industryVertical": { diff --git a/discovery/discoveryengine-v1alpha.json b/discovery/discoveryengine-v1alpha.json index 28851ce1dba..c1005469fd2 100644 --- a/discovery/discoveryengine-v1alpha.json +++ b/discovery/discoveryengine-v1alpha.json @@ -5454,7 +5454,7 @@ ] }, "setIamPolicy": { - "description": "Sets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.user` and `roles/discoveryengine.agentspaceUser`. Attempting to grant any other role will result in a warning in logging.", + "description": "Sets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.admin`, `roles/discoveryengine.agentspaceAdmin`, `roles/discoveryengine.user`, `roles/discoveryengine.agentspaceUser`, `roles/discoveryengine.viewer`, `roles/discoveryengine.agentspaceViewer`. Attempting to grant any other role will result in a warning in logging.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:setIamPolicy", "httpMethod": "POST", "id": "discoveryengine.projects.locations.collections.engines.setIamPolicy", @@ -11242,6 +11242,49 @@ "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, + "list": { + "description": "Lists all the LicenseConfigs associated with the project.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/licenseConfigs", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.licenseConfigs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The filter to apply to the list results. The supported fields are: * `subscription_tier` * `state` Examples: * `subscription_tier=SUBSCRIPTION_TIER_SEARCH,state=ACTIVE` - Lists all active search license configs. * `state=ACTIVE` - Lists all active license configs. The filter string should be a comma-separated list of field=value pairs.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Not supported.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Not supported.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/licenseConfigs", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaListLicenseConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite", + "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" + ] + }, "patch": { "description": "Updates the LicenseConfig", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/licenseConfigs/{licenseConfigsId}", @@ -12633,7 +12676,7 @@ } } }, - "revision": "20260503", + "revision": "20260512", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -14167,6 +14210,10 @@ }, "type": "array" }, + "connectorSourceId": { + "description": "Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source.", + "type": "string" + }, "connectorType": { "description": "Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.", "enum": [ @@ -15402,7 +15449,7 @@ ], "type": "string" }, - "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills`", + "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups`", "type": "object" }, "industryVertical": { @@ -19642,14 +19689,16 @@ "IN_PROGRESS", "FAILED", "SUCCEEDED", - "SKIPPED" + "SKIPPED", + "CANCELLED" ], "enumDescriptions": [ "Unknown.", "Assist operation is currently in progress.", "Assist operation has failed.", "Assist operation has succeeded.", - "Assist operation has been skipped." + "Assist operation has been skipped.", + "Assist operation has been cancelled (e.g. client closed the stream). May contain a partial response." ], "type": "string" } @@ -22720,6 +22769,10 @@ }, "type": "array" }, + "connectorSourceId": { + "description": "Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source.", + "type": "string" + }, "connectorType": { "description": "Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.", "enum": [ @@ -24337,7 +24390,7 @@ ], "type": "string" }, - "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills`", + "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups`", "type": "object" }, "industryVertical": { @@ -26979,6 +27032,24 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaListLicenseConfigsResponse": { + "description": "Response message for LicenseConfigService.ListLicenseConfigs method.", + "id": "GoogleCloudDiscoveryengineV1alphaListLicenseConfigsResponse", + "properties": { + "licenseConfigs": { + "description": "All the customer's LicenseConfigs.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaLicenseConfig" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Not supported.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaListLicenseConfigsUsageStatsResponse": { "description": "Response message for UserLicenseService.ListLicenseConfigsUsageStats method.", "id": "GoogleCloudDiscoveryengineV1alphaListLicenseConfigsUsageStatsResponse", @@ -27987,6 +28058,12 @@ "description": "Defines a user inputed query.", "id": "GoogleCloudDiscoveryengineV1alphaQuery", "properties": { + "createTime": { + "description": "Output only. The time at which the server accepted this query.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "parts": { "description": "Query content parts.", "items": { @@ -31177,6 +31254,11 @@ "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", "type": "string" }, + "pendingAsyncAssistOperationId": { + "description": "Output only. Full resource name of an in-progress AsyncAssist operation for this session, e.g. `projects/*/locations/*/collections/*/engines/*/sessions/*/operations/*`. Set when the operation starts and cleared when it finishes.", + "readOnly": true, + "type": "string" + }, "startTime": { "description": "Output only. The time the session started.", "format": "google-datetime", @@ -33114,7 +33196,7 @@ ], "type": "string" }, - "description": "Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills`", + "description": "Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups`", "readOnly": true, "type": "object" }, @@ -34662,7 +34744,7 @@ ], "type": "string" }, - "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills`", + "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups`", "type": "object" }, "industryVertical": { diff --git a/discovery/discoveryengine-v1beta.json b/discovery/discoveryengine-v1beta.json index 7e485eb2b88..197bdf801a4 100644 --- a/discovery/discoveryengine-v1beta.json +++ b/discovery/discoveryengine-v1beta.json @@ -3884,7 +3884,7 @@ ] }, "setIamPolicy": { - "description": "Sets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.user` and `roles/discoveryengine.agentspaceUser`. Attempting to grant any other role will result in a warning in logging.", + "description": "Sets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.admin`, `roles/discoveryengine.agentspaceAdmin`, `roles/discoveryengine.user`, `roles/discoveryengine.agentspaceUser`, `roles/discoveryengine.viewer`, `roles/discoveryengine.agentspaceViewer`. Attempting to grant any other role will result in a warning in logging.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:setIamPolicy", "httpMethod": "POST", "id": "discoveryengine.projects.locations.collections.engines.setIamPolicy", @@ -8502,6 +8502,49 @@ "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, + "list": { + "description": "Lists all the LicenseConfigs associated with the project.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/licenseConfigs", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.licenseConfigs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The filter to apply to the list results. The supported fields are: * `subscription_tier` * `state` Examples: * `subscription_tier=SUBSCRIPTION_TIER_SEARCH,state=ACTIVE` - Lists all active search license configs. * `state=ACTIVE` - Lists all active license configs. The filter string should be a comma-separated list of field=value pairs.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Not supported.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Not supported.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/licenseConfigs", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaListLicenseConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite", + "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" + ] + }, "patch": { "description": "Updates the LicenseConfig", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/licenseConfigs/{licenseConfigsId}", @@ -9466,7 +9509,7 @@ } } }, - "revision": "20260503", + "revision": "20260512", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -11000,6 +11043,10 @@ }, "type": "array" }, + "connectorSourceId": { + "description": "Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source.", + "type": "string" + }, "connectorType": { "description": "Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.", "enum": [ @@ -12235,7 +12282,7 @@ ], "type": "string" }, - "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills`", + "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups`", "type": "object" }, "industryVertical": { @@ -15173,14 +15220,16 @@ "IN_PROGRESS", "FAILED", "SUCCEEDED", - "SKIPPED" + "SKIPPED", + "CANCELLED" ], "enumDescriptions": [ "Unknown.", "Assist operation is currently in progress.", "Assist operation has failed.", "Assist operation has succeeded.", - "Assist operation has been skipped." + "Assist operation has been skipped.", + "Assist operation has been cancelled (e.g. client closed the stream). May contain a partial response." ], "type": "string" } @@ -16573,6 +16622,10 @@ }, "type": "array" }, + "connectorSourceId": { + "description": "Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source.", + "type": "string" + }, "connectorType": { "description": "Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.", "enum": [ @@ -17926,7 +17979,7 @@ ], "type": "string" }, - "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills`", + "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups`", "type": "object" }, "industryVertical": { @@ -19879,6 +19932,12 @@ "description": "Defines a user inputed query.", "id": "GoogleCloudDiscoveryengineV1alphaQuery", "properties": { + "createTime": { + "description": "Output only. The time at which the server accepted this query.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "parts": { "description": "Query content parts.", "items": { @@ -21398,6 +21457,11 @@ "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", "type": "string" }, + "pendingAsyncAssistOperationId": { + "description": "Output only. Full resource name of an in-progress AsyncAssist operation for this session, e.g. `projects/*/locations/*/collections/*/engines/*/sessions/*/operations/*`. Set when the operation starts and cleared when it finishes.", + "readOnly": true, + "type": "string" + }, "startTime": { "description": "Output only. The time the session started.", "format": "google-datetime", @@ -23755,14 +23819,16 @@ "IN_PROGRESS", "FAILED", "SUCCEEDED", - "SKIPPED" + "SKIPPED", + "CANCELLED" ], "enumDescriptions": [ "Unknown.", "Assist operation is currently in progress.", "Assist operation has failed.", "Assist operation has succeeded.", - "Assist operation has been skipped." + "Assist operation has been skipped.", + "Assist operation has been cancelled (e.g. client closed the stream). May contain a partial response." ], "type": "string" } @@ -26947,7 +27013,7 @@ ], "type": "string" }, - "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills`", + "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups`", "type": "object" }, "industryVertical": { @@ -28665,6 +28731,24 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaListLicenseConfigsResponse": { + "description": "Response message for LicenseConfigService.ListLicenseConfigs method.", + "id": "GoogleCloudDiscoveryengineV1betaListLicenseConfigsResponse", + "properties": { + "licenseConfigs": { + "description": "All the customer's LicenseConfigs.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaLicenseConfig" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Not supported.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaListLicenseConfigsUsageStatsResponse": { "description": "Response message for UserLicenseService.ListLicenseConfigsUsageStats method.", "id": "GoogleCloudDiscoveryengineV1betaListLicenseConfigsUsageStatsResponse", @@ -32118,6 +32202,11 @@ "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", "type": "string" }, + "pendingAsyncAssistOperationId": { + "description": "Output only. Full resource name of an in-progress AsyncAssist operation for this session, e.g. `projects/*/locations/*/collections/*/engines/*/sessions/*/operations/*`. Set when the operation starts and cleared when it finishes.", + "readOnly": true, + "type": "string" + }, "startTime": { "description": "Output only. The time the session started.", "format": "google-datetime", diff --git a/discovery/dlp-v2.json b/discovery/dlp-v2.json index c069a6ce0fe..6c0f420f2e6 100644 --- a/discovery/dlp-v2.json +++ b/discovery/dlp-v2.json @@ -5128,7 +5128,7 @@ } } }, - "revision": "20260425", + "revision": "20260509", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -9988,6 +9988,10 @@ "description": "The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more.", "id": "GooglePrivacyDlpV2InspectTemplate", "properties": { + "allowLimitedAvailabilityInfoTypes": { + "description": "Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.", + "type": "boolean" + }, "createTime": { "description": "Output only. The creation timestamp of an inspectTemplate.", "format": "google-datetime", @@ -12968,10 +12972,10 @@ ], "enumDescriptions": [ "Unused.", - "This will be set when a finding could not be transformed (i.e. outside user set bucket range).", - "This will be set when a BigQuery transformation was successful but could not be stored back in BigQuery because the transformed row exceeds BigQuery's max row size.", - "This will be set when there is a finding in the custom metadata of a file, but at the write time of the transformed file, this key / value pair is unretrievable.", - "This will be set when the transformation and storing of it is successful." + "This is set when a finding cannot be transformed (i.e. outside user set bucket range).", + "This is set when a transformation is successful but cannot be stored in BigQuery because the transformed row exceeds BigQuery's max row size.", + "This is set when there is a finding in the custom metadata of a file, but at the write time of the transformed file, this key / value pair is unretrievable.", + "This is set when the transformation and its storage are successful." ], "type": "string" } diff --git a/discovery/documentai-v1.json b/discovery/documentai-v1.json index 59023e68890..1e528af1c0b 100644 --- a/discovery/documentai-v1.json +++ b/discovery/documentai-v1.json @@ -231,7 +231,7 @@ ] }, "list": { - "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", + "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "documentai.projects.locations.list", @@ -240,7 +240,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1436,7 +1436,7 @@ } } }, - "revision": "20260325", + "revision": "20260503", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "CloudAiDocumentaiLabHifiaToolsValidationValidatorInput": { @@ -3727,6 +3727,13 @@ "description": "Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality.", "id": "GoogleCloudDocumentaiV1Document", "properties": { + "blobAssets": { + "description": "Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id.", + "items": { + "$ref": "GoogleCloudDocumentaiV1DocumentBlobAsset" + }, + "type": "array" + }, "chunkedDocument": { "$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocument", "description": "Document chunked based on chunking config." @@ -3825,6 +3832,37 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1DocumentAnnotations": { + "description": "Represents the annotation of a block or a chunk.", + "id": "GoogleCloudDocumentaiV1DocumentAnnotations", + "properties": { + "description": { + "description": "The description of the content with this annotation.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1DocumentBlobAsset": { + "description": "Represents a blob asset. It's used to store the content of the inline blob in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID.", + "id": "GoogleCloudDocumentaiV1DocumentBlobAsset", + "properties": { + "assetId": { + "description": "Optional. The id of the blob asset.", + "type": "string" + }, + "content": { + "description": "Optional. The content of the blob asset, for example, image bytes.", + "format": "byte", + "type": "string" + }, + "mimeType": { + "description": "The mime type of the blob asset. An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1DocumentChunkedDocument": { "description": "Represents the chunks that the document is divided into.", "id": "GoogleCloudDocumentaiV1DocumentChunkedDocument", @@ -3843,6 +3881,13 @@ "description": "Represents a chunk.", "id": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk", "properties": { + "chunkFields": { + "description": "Chunk fields inside this chunk.", + "items": { + "$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkField" + }, + "type": "array" + }, "chunkId": { "description": "ID of the chunk.", "type": "string" @@ -3879,6 +3924,21 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkField": { + "description": "The chunk field in the chunk. A chunk field could be one of the various types (for example, image, table) supported.", + "id": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkField", + "properties": { + "imageChunkField": { + "$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkImageChunkField", + "description": "The image chunk field in the chunk." + }, + "tableChunkField": { + "$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkTableChunkField", + "description": "The table chunk field in the chunk." + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter": { "description": "Represents the page footer associated with the chunk.", "id": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter", @@ -3926,6 +3986,40 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkImageChunkField": { + "description": "The image chunk field in the chunk.", + "id": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkImageChunkField", + "properties": { + "annotations": { + "$ref": "GoogleCloudDocumentaiV1DocumentAnnotations", + "description": "Annotation of the image chunk field." + }, + "blobAssetId": { + "description": "Optional. Asset id of the inline image. If set, find the image content in the blob_assets field.", + "type": "string" + }, + "dataUri": { + "description": "Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:,", + "type": "string" + }, + "gcsUri": { + "description": "Optional. Google Cloud Storage uri of the image.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkTableChunkField": { + "description": "The table chunk field in the chunk.", + "id": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkTableChunkField", + "properties": { + "annotations": { + "$ref": "GoogleCloudDocumentaiV1DocumentAnnotations", + "description": "Annotation of the table chunk field." + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1DocumentDocumentLayout": { "description": "Represents the parsed layout of a document as a collection of blocks that the document is divided into.", "id": "GoogleCloudDocumentaiV1DocumentDocumentLayout", @@ -3952,6 +4046,10 @@ "$ref": "GoogleCloudDocumentaiV1BoundingPoly", "description": "Identifies the bounding box for the block." }, + "imageBlock": { + "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutImageBlock", + "description": "Block consisting of image content." + }, "listBlock": { "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock", "description": "Block consisting of list content/structure." @@ -3971,6 +4069,37 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutImageBlock": { + "description": "Represents an image type block.", + "id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutImageBlock", + "properties": { + "annotations": { + "$ref": "GoogleCloudDocumentaiV1DocumentAnnotations", + "description": "Annotation of the image block." + }, + "blobAssetId": { + "description": "Optional. Asset id of the inline image. If set, find the image content in the blob_assets field.", + "type": "string" + }, + "dataUri": { + "description": "Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:,", + "type": "string" + }, + "gcsUri": { + "description": "Optional. Google Cloud Storage uri of the image.", + "type": "string" + }, + "imageText": { + "description": "Text extracted from the image using OCR or alt text describing the image.", + "type": "string" + }, + "mimeType": { + "description": "Mime type of the image. An IANA published [media type (MIME type)] (https://www.iana.org/assignments/media-types/media-types.xhtml).", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock": { "description": "Represents a list type block.", "id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock", @@ -4024,6 +4153,10 @@ "description": "Represents a table type block.", "id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock", "properties": { + "annotations": { + "$ref": "GoogleCloudDocumentaiV1DocumentAnnotations", + "description": "Annotation of the table block." + }, "bodyRows": { "description": "Body rows containing main table content.", "items": { @@ -4087,6 +4220,10 @@ "description": "Represents a text type block.", "id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock", "properties": { + "annotations": { + "$ref": "GoogleCloudDocumentaiV1DocumentAnnotations", + "description": "Annotation of the text block." + }, "blocks": { "description": "A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.", "items": { diff --git a/discovery/documentai-v1beta3.json b/discovery/documentai-v1beta3.json index 6774e51347f..ca228aa50d3 100644 --- a/discovery/documentai-v1beta3.json +++ b/discovery/documentai-v1beta3.json @@ -202,7 +202,7 @@ ] }, "list": { - "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", + "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1beta3/projects/{projectsId}/locations", "httpMethod": "GET", "id": "documentai.projects.locations.list", @@ -211,7 +211,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1678,7 +1678,7 @@ } } }, - "revision": "20260325", + "revision": "20260503", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "CloudAiDocumentaiLabHifiaToolsValidationValidatorInput": { diff --git a/discovery/eventarc-v1.json b/discovery/eventarc-v1.json index 19fe5e41c63..3af5d6db92b 100644 --- a/discovery/eventarc-v1.json +++ b/discovery/eventarc-v1.json @@ -1297,12 +1297,12 @@ ], "parameters": { "allowMissing": { - "description": "Optional. If set to true, and the MessageBus is not found, the request will succeed but no action will be taken on the server.", + "description": "Optional. If set to true, and the GoogleApiSource is not found, the request will succeed but no action will be taken on the server.", "location": "query", "type": "boolean" }, "etag": { - "description": "Optional. If provided, the MessageBus will only be deleted if the etag matches the current etag on the resource.", + "description": "Optional. If provided, the GoogleApiSource will only be deleted if the etag matches the current etag on the resource.", "location": "query", "type": "string" }, @@ -2627,7 +2627,7 @@ } } }, - "revision": "20260424", + "revision": "20260506", "rootUrl": "https://eventarc.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/discovery/firebaseappdistribution-v1.json b/discovery/firebaseappdistribution-v1.json index edfeb5565b7..968255a50ee 100644 --- a/discovery/firebaseappdistribution-v1.json +++ b/discovery/firebaseappdistribution-v1.json @@ -946,7 +946,7 @@ } } }, - "revision": "20260430", + "revision": "20260511", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "GdataBlobstore2Info": { @@ -1366,6 +1366,11 @@ "format": "byte", "type": "string" }, + "sha512Hash": { + "description": "Scotty-provided SHA512 hash for an upload.", + "format": "byte", + "type": "string" + }, "timestamp": { "description": "Time at which the media data was last updated, in milliseconds since UNIX epoch", "format": "uint64", diff --git a/discovery/firebaseapphosting-v1.json b/discovery/firebaseapphosting-v1.json index aa4ebf9b133..a7e5665b251 100644 --- a/discovery/firebaseapphosting-v1.json +++ b/discovery/firebaseapphosting-v1.json @@ -1106,7 +1106,7 @@ } } }, - "revision": "20260423", + "revision": "20260506", "rootUrl": "https://firebaseapphosting.googleapis.com/", "schemas": { "ArchiveSource": { @@ -2559,7 +2559,7 @@ "type": "array" }, "requiredPaths": { - "description": "Optional. A list of file paths patterns that trigger a build and rollout if at least one of the changed files in the commit are present in this list. This field is optional; the rollout policy will default to triggering on all paths if not populated. Limited to 100 paths. Example: “required_paths: { pattern: \"foo/bar/*” type: GLOB }", + "description": "Optional. A list of file paths patterns that trigger a build and rollout if at least one of the changed files in the commit are present in this list. This field is optional; the rollout policy will default to triggering on all paths if both ignored_paths and required_paths are not populated. Limited to 100 paths. Example: “required_paths: { pattern: \"foo/bar/*” type: GLOB }", "items": { "$ref": "Path" }, diff --git a/discovery/firebaseapphosting-v1beta.json b/discovery/firebaseapphosting-v1beta.json index 95418de4b41..33c1c6cc404 100644 --- a/discovery/firebaseapphosting-v1beta.json +++ b/discovery/firebaseapphosting-v1beta.json @@ -1138,7 +1138,7 @@ } } }, - "revision": "20260427", + "revision": "20260506", "rootUrl": "https://firebaseapphosting.googleapis.com/", "schemas": { "ArchiveSource": { @@ -2634,7 +2634,7 @@ "type": "array" }, "requiredPaths": { - "description": "Optional. A list of file paths patterns that trigger a build and rollout if at least one of the changed files in the commit are present in this list. This field is optional; the rollout policy will default to triggering on all paths if not populated. Limited to 100 paths. Example: “required_paths: { pattern: \"foo/bar/*” type: GLOB }", + "description": "Optional. A list of file paths patterns that trigger a build and rollout if at least one of the changed files in the commit are present in this list. This field is optional; the rollout policy will default to triggering on all paths if both ignored_paths and required_paths are not populated. Limited to 100 paths. Example: “required_paths: { pattern: \"foo/bar/*” type: GLOB }", "items": { "$ref": "Path" }, diff --git a/discovery/firebaseml-v2beta.json b/discovery/firebaseml-v2beta.json index b0e856a8b76..bc80d110fe2 100644 --- a/discovery/firebaseml-v2beta.json +++ b/discovery/firebaseml-v2beta.json @@ -206,7 +206,7 @@ } } }, - "revision": "20260408", + "revision": "20260513", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -925,6 +925,20 @@ "description": "Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.", "id": "GoogleCloudAiplatformV1beta1FunctionDeclaration", "properties": { + "behavior": { + "description": "Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method.", + "enum": [ + "UNSPECIFIED", + "BLOCKING", + "NON_BLOCKING" + ], + "enumDescriptions": [ + "This value is unspecified.", + "If set, the system will wait to receive the function response before continuing the conversation.", + "If set, the system will not wait to receive the function response. Instead, it will attempt to handle function responses as they become available while maintaining the conversation between the user and the model." + ], + "type": "string" + }, "description": { "description": "Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.", "type": "string" @@ -2859,15 +2873,23 @@ "description": "Tool to support computer use.", "id": "GoogleCloudAiplatformV1beta1ToolComputerUse", "properties": { + "enablePromptInjectionDetection": { + "description": "Optional. Enables the prompt injection detection check on computer-use request.", + "type": "boolean" + }, "environment": { "description": "Required. The environment being operated.", "enum": [ "ENVIRONMENT_UNSPECIFIED", - "ENVIRONMENT_BROWSER" + "ENVIRONMENT_BROWSER", + "ENVIRONMENT_MOBILE", + "ENVIRONMENT_DESKTOP" ], "enumDescriptions": [ "Defaults to browser.", - "Operates in a web browser." + "Operates in a web browser.", + "Operates in a mobile environment.", + "Operates in a desktop environment." ], "type": "string" }, diff --git a/discovery/firestore-v1.json b/discovery/firestore-v1.json index 24c91ed5082..cfdd743662d 100644 --- a/discovery/firestore-v1.json +++ b/discovery/firestore-v1.json @@ -2435,7 +2435,7 @@ } } }, - "revision": "20260427", + "revision": "20260507", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -4185,7 +4185,7 @@ }, "searchIndexOptions": { "$ref": "GoogleFirestoreAdminV1SearchIndexOptions", - "description": "Optional. Options for search indexes that are at the index definition level. This field is only currently supported for indexes with MONGODB_COMPATIBLE_API ApiScope." + "description": "Optional. Options for search indexes that are at the index definition level." }, "shardCount": { "description": "Optional. The number of shards for the index.", @@ -4632,7 +4632,7 @@ "id": "GoogleFirestoreAdminV1SearchGeoSpec", "properties": { "geoJsonIndexingDisabled": { - "description": "Optional. Disables geoJSON indexing for the field. By default, geoJSON points are indexed.", + "description": "Optional. Disables geoJSON indexing for the field. By default, geoJSON points are indexed. Firestore GeoPoints are indexed regardless of this value.", "type": "boolean" } }, @@ -4647,7 +4647,7 @@ "type": "string" }, "textLanguageOverrideFieldPath": { - "description": "Optional. The field in the document that specifies which language to use for that specific document. For indexes with MONGODB_COMPATIBLE_API ApiScope: if unspecified, the language is taken from the \"language\" field if it exists or from `text_language` if it does not.", + "description": "Optional. The field in the document that specifies which language to use for that specific document. If unspecified, the language is taken from the \"language\" field if it exists or from `text_language` if it does not.", "type": "string" } }, @@ -4665,7 +4665,7 @@ ], "enumDescriptions": [ "The index type is unspecified. Not a valid option.", - "Field values are tokenized. This is the only way currently supported for MONGODB_COMPATIBLE_API." + "Field values are tokenized." ], "type": "string" }, @@ -4677,7 +4677,7 @@ ], "enumDescriptions": [ "The match type is unspecified. Not a valid option.", - "Match on any indexed field. This is the only way currently supported for MONGODB_COMPATIBLE_API." + "Match on any indexed field." ], "type": "string" } diff --git a/discovery/gkehub-v1.json b/discovery/gkehub-v1.json index e5791be917f..0aa2969438c 100644 --- a/discovery/gkehub-v1.json +++ b/discovery/gkehub-v1.json @@ -55,6 +55,36 @@ "description": "Regional Endpoint", "endpointUrl": "https://gkehub.us-east7.rep.googleapis.com/", "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west4.rep.googleapis.com/", + "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west8.rep.googleapis.com/", + "location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -2164,7 +2194,7 @@ } } }, - "revision": "20260426", + "revision": "20260511", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { diff --git a/discovery/gkehub-v1alpha.json b/discovery/gkehub-v1alpha.json index 897775827df..6439b4cb04e 100644 --- a/discovery/gkehub-v1alpha.json +++ b/discovery/gkehub-v1alpha.json @@ -55,6 +55,36 @@ "description": "Regional Endpoint", "endpointUrl": "https://gkehub.us-east7.rep.googleapis.com/", "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west4.rep.googleapis.com/", + "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west8.rep.googleapis.com/", + "location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -2568,7 +2598,7 @@ } } }, - "revision": "20260429", + "revision": "20260511", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -6445,6 +6475,62 @@ }, "type": "object" }, + "OperationalState": { + "description": "Operational state of the Rollout Sequence.", + "id": "OperationalState", + "properties": { + "reasons": { + "description": "Output only. Reasons for the Rollout Sequence state.", + "items": { + "enum": [ + "REASON_UNSPECIFIED", + "FLEET_FEATURE_DELETED_ERROR", + "FLEET_DELETED_ERROR", + "EMPTY_STAGE_WARNING", + "MIXED_RELEASE_CHANNELS_WARNING", + "INTERNAL_ERROR" + ], + "enumDescriptions": [ + "Default unspecified value.", + "A fleet feature is deleted.", + "A fleet is deleted.", + "A stage is empty.", + "Mixed release channels in the sequence.", + "Internal error, for example when host project is soft-deleted." + ], + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "state": { + "description": "Output only. State of the Rollout Sequence.", + "enum": [ + "STATE_CODE_UNSPECIFIED", + "ACTIVE", + "WARNING", + "ERROR", + "INITIALIZING" + ], + "enumDescriptions": [ + "The default value. This value is used if the state is omitted.", + "The Rollout Sequence is active.", + "The Rollout Sequence has warnings. It is still functioning but performance may be degraded.", + "The Rollout Sequence has errors and is not functioning.", + "The Rollout Sequence is being initialized." + ], + "readOnly": true, + "type": "string" + }, + "stateChangeTime": { + "description": "Output only. The timestamp at which the operational state was last changed. Used to track how long it has been in the current state.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "Origin": { "description": "Origin defines where this MembershipFeatureSpec originated from.", "id": "Origin", @@ -7271,6 +7357,11 @@ "description": "Identifier. Name of the rollout sequence in the format of: projects/{PROJECT_ID}/locations/global/rolloutSequences/{NAME}", "type": "string" }, + "operationalState": { + "$ref": "OperationalState", + "description": "Output only. Operational state of the Rollout Sequence.", + "readOnly": true + }, "stages": { "description": "Required. Ordered list of stages that constitutes this Rollout.", "items": { @@ -7278,11 +7369,6 @@ }, "type": "array" }, - "state": { - "$ref": "RolloutSequenceState", - "description": "Output only. State of the Rollout Sequence as a whole.", - "readOnly": true - }, "uid": { "description": "Output only. Google-generated UUID for this resource. This is unique across all Rollout Sequence resources. If a Rollout Sequence resource is deleted and another resource with the same name is created, it gets a different uid.", "readOnly": true, @@ -7297,62 +7383,6 @@ }, "type": "object" }, - "RolloutSequenceState": { - "description": "State and reasons of the Rollout Sequence.", - "id": "RolloutSequenceState", - "properties": { - "lastStateChangeTime": { - "description": "Output only. The timestamp at which the LifecycleState was last changed. Used to track how long it has been in the current state.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "lifecycleState": { - "description": "Output only. Lifecycle state of the Rollout Sequence.", - "enum": [ - "LIFECYCLE_STATE_UNSPECIFIED", - "LIFECYCLE_STATE_ACTIVE", - "LIFECYCLE_STATE_WARNING", - "LIFECYCLE_STATE_ERROR", - "LIFECYCLE_STATE_INITIALIZING" - ], - "enumDescriptions": [ - "The default value. This value is used if the state is omitted.", - "The Rollout Sequence is active.", - "The Rollout Sequence has warnings.", - "The Rollout Sequence has errors.", - "The Rollout Sequence is being initialized." - ], - "readOnly": true, - "type": "string" - }, - "stateReasons": { - "description": "Output only. StateReason represents the reason for the Rollout Sequence state.", - "items": { - "enum": [ - "STATE_REASON_UNSPECIFIED", - "FLEET_FEATURE_DELETED_ERROR", - "FLEET_DELETED_ERROR", - "EMPTY_STAGE_WARNING", - "MIXED_RELEASE_CHANNELS_WARNING", - "INTERNAL_ERROR" - ], - "enumDescriptions": [ - "Default unspecified value.", - "A fleet feature is deleted.", - "A fleet is deleted.", - "A stage is empty.", - "Mixed release channels in the sequence.", - "Internal error, for example when host project is soft-deleted." - ], - "type": "string" - }, - "readOnly": true, - "type": "array" - } - }, - "type": "object" - }, "RolloutStage": { "description": "Stage represents a single stage in the Rollout.", "id": "RolloutStage", diff --git a/discovery/gkehub-v1beta.json b/discovery/gkehub-v1beta.json index d5f67b0bab7..8a9af474572 100644 --- a/discovery/gkehub-v1beta.json +++ b/discovery/gkehub-v1beta.json @@ -55,6 +55,36 @@ "description": "Regional Endpoint", "endpointUrl": "https://gkehub.us-east7.rep.googleapis.com/", "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west4.rep.googleapis.com/", + "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west8.rep.googleapis.com/", + "location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -2424,7 +2454,7 @@ } } }, - "revision": "20260429", + "revision": "20260511", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -6054,6 +6084,62 @@ }, "type": "object" }, + "OperationalState": { + "description": "Operational state of the Rollout Sequence.", + "id": "OperationalState", + "properties": { + "reasons": { + "description": "Output only. Reasons for the Rollout Sequence state.", + "items": { + "enum": [ + "REASON_UNSPECIFIED", + "FLEET_FEATURE_DELETED_ERROR", + "FLEET_DELETED_ERROR", + "EMPTY_STAGE_WARNING", + "MIXED_RELEASE_CHANNELS_WARNING", + "INTERNAL_ERROR" + ], + "enumDescriptions": [ + "Default unspecified value.", + "A fleet feature is deleted.", + "A fleet is deleted.", + "A stage is empty.", + "Mixed release channels in the sequence.", + "Internal error, for example when host project is soft-deleted." + ], + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "state": { + "description": "Output only. State of the Rollout Sequence.", + "enum": [ + "STATE_CODE_UNSPECIFIED", + "ACTIVE", + "WARNING", + "ERROR", + "INITIALIZING" + ], + "enumDescriptions": [ + "The default value. This value is used if the state is omitted.", + "The Rollout Sequence is active.", + "The Rollout Sequence has warnings. It is still functioning but performance may be degraded.", + "The Rollout Sequence has errors and is not functioning.", + "The Rollout Sequence is being initialized." + ], + "readOnly": true, + "type": "string" + }, + "stateChangeTime": { + "description": "Output only. The timestamp at which the operational state was last changed. Used to track how long it has been in the current state.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "Origin": { "description": "Origin defines where this MembershipFeatureSpec originated from.", "id": "Origin", @@ -6880,6 +6966,11 @@ "description": "Identifier. Name of the rollout sequence in the format of: projects/{PROJECT_ID}/locations/global/rolloutSequences/{NAME}", "type": "string" }, + "operationalState": { + "$ref": "OperationalState", + "description": "Output only. Operational state of the Rollout Sequence.", + "readOnly": true + }, "stages": { "description": "Required. Ordered list of stages that constitutes this Rollout.", "items": { @@ -6887,11 +6978,6 @@ }, "type": "array" }, - "state": { - "$ref": "RolloutSequenceState", - "description": "Output only. State of the Rollout Sequence as a whole.", - "readOnly": true - }, "uid": { "description": "Output only. Google-generated UUID for this resource. This is unique across all Rollout Sequence resources. If a Rollout Sequence resource is deleted and another resource with the same name is created, it gets a different uid.", "readOnly": true, @@ -6906,62 +6992,6 @@ }, "type": "object" }, - "RolloutSequenceState": { - "description": "State and reasons of the Rollout Sequence.", - "id": "RolloutSequenceState", - "properties": { - "lastStateChangeTime": { - "description": "Output only. The timestamp at which the LifecycleState was last changed. Used to track how long it has been in the current state.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "lifecycleState": { - "description": "Output only. Lifecycle state of the Rollout Sequence.", - "enum": [ - "LIFECYCLE_STATE_UNSPECIFIED", - "LIFECYCLE_STATE_ACTIVE", - "LIFECYCLE_STATE_WARNING", - "LIFECYCLE_STATE_ERROR", - "LIFECYCLE_STATE_INITIALIZING" - ], - "enumDescriptions": [ - "The default value. This value is used if the state is omitted.", - "The Rollout Sequence is active.", - "The Rollout Sequence has warnings.", - "The Rollout Sequence has errors.", - "The Rollout Sequence is being initialized." - ], - "readOnly": true, - "type": "string" - }, - "stateReasons": { - "description": "Output only. StateReason represents the reason for the Rollout Sequence state.", - "items": { - "enum": [ - "STATE_REASON_UNSPECIFIED", - "FLEET_FEATURE_DELETED_ERROR", - "FLEET_DELETED_ERROR", - "EMPTY_STAGE_WARNING", - "MIXED_RELEASE_CHANNELS_WARNING", - "INTERNAL_ERROR" - ], - "enumDescriptions": [ - "Default unspecified value.", - "A fleet feature is deleted.", - "A fleet is deleted.", - "A stage is empty.", - "Mixed release channels in the sequence.", - "Internal error, for example when host project is soft-deleted." - ], - "type": "string" - }, - "readOnly": true, - "type": "array" - } - }, - "type": "object" - }, "RolloutStage": { "description": "Stage represents a single stage in the Rollout.", "id": "RolloutStage", diff --git a/discovery/gkehub-v1beta1.json b/discovery/gkehub-v1beta1.json index 63b04f95478..0e61a66810f 100644 --- a/discovery/gkehub-v1beta1.json +++ b/discovery/gkehub-v1beta1.json @@ -55,6 +55,36 @@ "description": "Regional Endpoint", "endpointUrl": "https://gkehub.us-east7.rep.googleapis.com/", "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west4.rep.googleapis.com/", + "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west8.rep.googleapis.com/", + "location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -765,7 +795,7 @@ } } }, - "revision": "20260426", + "revision": "20260511", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "ApplianceCluster": { diff --git a/discovery/gkehub-v2.json b/discovery/gkehub-v2.json index b0da5f3b47e..6276e48adc0 100644 --- a/discovery/gkehub-v2.json +++ b/discovery/gkehub-v2.json @@ -55,6 +55,36 @@ "description": "Regional Endpoint", "endpointUrl": "https://gkehub.us-east7.rep.googleapis.com/", "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west4.rep.googleapis.com/", + "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west8.rep.googleapis.com/", + "location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -524,7 +554,7 @@ } } }, - "revision": "20260426", + "revision": "20260511", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { diff --git a/discovery/gkehub-v2alpha.json b/discovery/gkehub-v2alpha.json index 0be04f9396b..a981ee3e1ba 100644 --- a/discovery/gkehub-v2alpha.json +++ b/discovery/gkehub-v2alpha.json @@ -55,6 +55,36 @@ "description": "Regional Endpoint", "endpointUrl": "https://gkehub.us-east7.rep.googleapis.com/", "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west4.rep.googleapis.com/", + "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west8.rep.googleapis.com/", + "location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -524,7 +554,7 @@ } } }, - "revision": "20260426", + "revision": "20260511", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { diff --git a/discovery/gkehub-v2beta.json b/discovery/gkehub-v2beta.json index 9d379f03718..7340cd29680 100644 --- a/discovery/gkehub-v2beta.json +++ b/discovery/gkehub-v2beta.json @@ -55,6 +55,36 @@ "description": "Regional Endpoint", "endpointUrl": "https://gkehub.us-east7.rep.googleapis.com/", "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west4.rep.googleapis.com/", + "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://gkehub.us-west8.rep.googleapis.com/", + "location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -524,7 +554,7 @@ } } }, - "revision": "20260426", + "revision": "20260511", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { diff --git a/discovery/gmail-v1.json b/discovery/gmail-v1.json index 564e6e0b227..28abf6171f9 100644 --- a/discovery/gmail-v1.json +++ b/discovery/gmail-v1.json @@ -828,7 +828,7 @@ ] }, "batchModify": { - "description": "Modifies the labels on the specified messages.", + "description": "Modifies the labels and the Classification Label values on the specified messages. For administrators modifying messages for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.modify.restricted` scope.", "flatPath": "gmail/v1/users/{userId}/messages/batchModify", "httpMethod": "POST", "id": "gmail.users.messages.batchModify", @@ -1148,7 +1148,7 @@ ] }, "modify": { - "description": "Modifies the labels on the specified message.", + "description": "Modifies the labels and the Classification Label values on the specified message. For administrators modifying message for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.modify.restricted` scope.", "flatPath": "gmail/v1/users/{userId}/messages/{id}/modify", "httpMethod": "POST", "id": "gmail.users.messages.modify", @@ -3077,7 +3077,7 @@ } } }, - "revision": "20260427", + "revision": "20260511", "rootUrl": "https://gmail.googleapis.com/", "schemas": { "AutoForwarding": { @@ -3129,6 +3129,13 @@ "BatchModifyMessagesRequest": { "id": "BatchModifyMessagesRequest", "properties": { + "addClassificationLabels": { + "description": "A list of Classification Label values to add. If a Classification Label with the same label ID is already applied to the message, fields with existing field IDs will be updated and fields with new field IDs will be added. There's a limit of 20 Classification Label values per request. If the message is already classified and the final total number of Classification Label values exceeds the maximum allowed number of Classification Label values per message, the modification fails.", + "items": { + "$ref": "ClassificationLabelValue" + }, + "type": "array" + }, "addLabelIds": { "description": "A list of label IDs to add to messages.", "items": { @@ -3143,6 +3150,13 @@ }, "type": "array" }, + "removeClassificationLabelIds": { + "description": "A list of Classification Label values to remove from messages.", + "items": { + "type": "string" + }, + "type": "array" + }, "removeLabelIds": { "description": "A list of label IDs to remove from messages.", "items": { @@ -3959,7 +3973,7 @@ "id": "Message", "properties": { "classificationLabelValues": { - "description": "Classification Label values on the message. Available Classification Label schemas can be queried using the Google Drive Labels API. Each classification label ID must be unique. If duplicate IDs are provided, only one will be retained, and the selection is arbitrary. Only used for Google Workspace accounts.", + "description": "Classification Label values on the message. Available Classification Label schemas can be queried using the Google Drive Labels API. Each classification label ID must be unique. If duplicate IDs are provided, only one will be retained, and the selection is arbitrary. Only used for Google Workspace accounts. There's a limit of 20 Classification Label values per request. If the Classification Label values exceeds the maximum allowed number, the request fails.", "items": { "$ref": "ClassificationLabelValue" }, @@ -4094,6 +4108,13 @@ "ModifyMessageRequest": { "id": "ModifyMessageRequest", "properties": { + "addClassificationLabels": { + "description": "A list of classification label values to add. If a Classification Label with the same label ID is already applied to the message, fields with existing field IDs will be updated and fields with new field IDs will be added. There's a limit of 20 Classification Label values per request. If the message is already classified and the final total number of Classification Label values exceeds the maximum allowed number of Classification Label values per message, the modification fails.", + "items": { + "$ref": "ClassificationLabelValue" + }, + "type": "array" + }, "addLabelIds": { "description": "A list of IDs of labels to add to this message. You can add up to 100 labels with each update.", "items": { @@ -4101,6 +4122,13 @@ }, "type": "array" }, + "removeClassificationLabelIds": { + "description": "A list of Classification Label values to remove from this message.", + "items": { + "type": "string" + }, + "type": "array" + }, "removeLabelIds": { "description": "A list IDs of labels to remove from this message. You can remove up to 100 labels with each update.", "items": { diff --git a/discovery/gmailpostmastertools-v2.json b/discovery/gmailpostmastertools-v2.json index 1843bcf8441..ebb7c6fd3a5 100644 --- a/discovery/gmailpostmastertools-v2.json +++ b/discovery/gmailpostmastertools-v2.json @@ -254,7 +254,7 @@ } } }, - "revision": "20260209", + "revision": "20260512", "rootUrl": "https://gmailpostmastertools.googleapis.com/", "schemas": { "BaseMetric": { @@ -276,8 +276,8 @@ ], "enumDescriptions": [ "Unspecified standard metric. This value should not be used directly.", - "Predefined metric for Feedback Loop (FBL) id.", - "Predefined metric for Feedback Loop (FBL) spam rate. Filter must be of type feedback_loop_id = \"\" where is one valid feedback loop ids.", + "Predefined metric for Feedback Loop (FBL) id. The `filter` field supports selecting the aggregation key type. Supported format: `aggregation_key_type` = \"\". Supported values: * `FROM_HEADER`: (Default) The metric includes messages with From: header domain matching the requested domain. * `ALL_DKIM`: The metric includes messages with one of the signed DKIM domains matching the requested domain.", + "Predefined metric for Feedback Loop (FBL) spam rate. The `filter` field requires a `feedback_loop_id` and optionally accepts an `aggregation_key_type`. Supported formats are: * `feedback_loop_id` = \"\" * `feedback_loop_id` = \"\" AND `aggregation_key_type` = \"\" If `aggregation_key_type` is omitted, it defaults to `FROM_HEADER`. Supported values: * `FROM_HEADER`: (Default) The metric includes messages with From: header domain matching the requested domain. * `ALL_DKIM`: The metric includes messages with one of the signed DKIM domains matching the requested domain.", "Predefined metric for spam rate.", "The success rate of authentication mechanisms (DKIM, SPF, DMARC). Filter must be of type auth_type = \"\" where is one of: [spf, dkim, dmarc]", "The rate of messages that were TLS encrypted in transit Filter must be of type traffic_direction = \"\" where is one of: [inbound, outbound]", diff --git a/discovery/health-v4.json b/discovery/health-v4.json index 063324d9397..02957b7f5fe 100644 --- a/discovery/health-v4.json +++ b/discovery/health-v4.json @@ -4,6 +4,24 @@ "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." + }, + "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly": { + "description": "See your Google Health activity and fitness data" + }, + "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly": { + "description": "See your Google Health health metrics and measurement data" + }, + "https://www.googleapis.com/auth/googlehealth.location.readonly": { + "description": "See exercise GPS location data in Google Health" + }, + "https://www.googleapis.com/auth/googlehealth.profile.readonly": { + "description": "See your Google Health profile data" + }, + "https://www.googleapis.com/auth/googlehealth.settings.readonly": { + "description": "See your Google Health settings" + }, + "https://www.googleapis.com/auth/googlehealth.sleep.readonly": { + "description": "See your Google Health sleep data" } } } @@ -268,7 +286,14 @@ "path": "v4/{+name}", "response": { "$ref": "Identity" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", + "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", + "https://www.googleapis.com/auth/googlehealth.profile.readonly", + "https://www.googleapis.com/auth/googlehealth.settings.readonly", + "https://www.googleapis.com/auth/googlehealth.sleep.readonly" + ] }, "getProfile": { "description": "Returns user Profile details.", @@ -290,7 +315,10 @@ "path": "v4/{+name}", "response": { "$ref": "Profile" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/googlehealth.profile.readonly" + ] }, "getSettings": { "description": "Returns user settings details.", @@ -312,7 +340,10 @@ "path": "v4/{+name}", "response": { "$ref": "Settings" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/googlehealth.settings.readonly" + ] }, "updateProfile": { "description": "Updates the user's profile details.", @@ -455,10 +486,16 @@ }, "response": { "$ref": "DailyRollUpDataPointsResponse" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", + "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", + "https://www.googleapis.com/auth/googlehealth.location.readonly", + "https://www.googleapis.com/auth/googlehealth.sleep.readonly" + ] }, "exportExerciseTcx": { - "description": "Exports exercise data in TCX format. Note: While the Authorization section below states that any one of the listed scopes is accepted, this specific method requires the user to provide both one of the `activity_and_fitness` scopes (`normal` or `readonly`) AND one of the `location` scopes (`normal` or `readonly`) in their access token to succeed.", + "description": "Exports exercise data in TCX format. **IMPORTANT:** HTTP clients must append `?alt=media` to the request URL to download the raw TCX file. Example: `https://health.googleapis.com/v4/users/me/dataTypes/exercise/dataPoints/EXERCISE_ID:exportExerciseTcx?alt=media` Without `alt=media`, the server returns a JSON response (`ExportExerciseTcxResponse`) which is intended primarily for gRPC clients. **Note:** While the Authorization section below states that any one of the listed scopes is accepted, this specific method requires the user to provide both one of the `activity_and_fitness` scopes (`normal` or `readonly`) AND one of the `location` scopes (`normal` or `readonly`) in their access token to succeed.", "flatPath": "v4/users/{usersId}/dataTypes/{dataTypesId}/dataPoints/{dataPointsId}:exportExerciseTcx", "httpMethod": "GET", "id": "health.users.dataTypes.dataPoints.exportExerciseTcx", @@ -483,6 +520,10 @@ "response": { "$ref": "ExportExerciseTcxResponse" }, + "scopes": [ + "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", + "https://www.googleapis.com/auth/googlehealth.location.readonly" + ], "supportsMediaDownload": true, "useMediaDownloadService": true }, @@ -506,7 +547,13 @@ "path": "v4/{+name}", "response": { "$ref": "DataPoint" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", + "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", + "https://www.googleapis.com/auth/googlehealth.location.readonly", + "https://www.googleapis.com/auth/googlehealth.sleep.readonly" + ] }, "list": { "description": "Query user health and fitness data points.", @@ -518,7 +565,7 @@ ], "parameters": { "filter": { - "description": "Optional. Filter expression following https://google.aip.dev/160. A time range (either physical or civil) can be specified. The supported filter fields are: - Interval start time: - Pattern: `{interval_data_type}.interval.start_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `steps.interval.start_time >= \"2023-11-24T00:00:00Z\" AND steps.interval.start_time < \"2023-11-25T00:00:00Z\"` - `distance.interval.start_time >= \"2024-08-14T12:34:56Z\"` - Interval civil start time: - Pattern: `{interval_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `steps.interval.civil_start_time >= \"2023-11-24\" AND steps.interval.civil_start_time < \"2023-11-25\"` - `distance.interval.civil_start_time >= \"2024-08-14T12:34:56\"` - Sample observation physical time: - Pattern: `{sample_data_type}.sample_time.physical_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `weight.sample_time.physical_time >= \"2023-11-24T00:00:00Z\" AND weight.sample_time.physical_time < \"2023-11-25T00:00:00Z\"` - `weight.sample_time.physical_time >= \"2024-08-14T12:34:56Z\"` - Sample observation civil time: - Pattern: `{sample_data_type}.sample_time.civil_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `weight.sample_time.civil_time >= \"2023-11-24\" AND weight.sample_time.civil_time < \"2023-11-25\"` - `weight.sample_time.civil_time >= \"2024-08-14T12:34:56\"` - Daily summary date: - Pattern: `{daily_summary_data_type}.date` - Supported comparison operators: `>=`, `<` - Date literal expected in ISO 8601 `YYYY-MM-DD` format - Supported logical operators: `AND` - Example: - `daily_heart_rate_variability.date < \"2024-08-15\"` - Session civil start time (**Excluding Sleep**): - Pattern: `{session_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `exercise.interval.civil_start_time >= \"2023-11-24\" AND exercise.interval.civil_start_time < \"2023-11-25\"` - `exercise.interval.civil_start_time >= \"2024-08-14T12:34:56\"` - Session end time (**Sleep specific**): - Pattern: `sleep.interval.end_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.end_time >= \"2023-11-24T00:00:00Z\" AND sleep.interval.end_time < \"2023-11-25T00:00:00Z\"` - Session civil end time (**Sleep specific**): - Pattern: `sleep.interval.civil_end_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.civil_end_time >= \"2023-11-24\" AND sleep.interval.civil_end_time < \"2023-11-25\"` Data points in the response will be ordered by the interval start time in descending order.", + "description": "Optional. Filter expression following https://google.aip.dev/160. A time range (either physical or civil) can be specified. The supported filter fields are: - Interval start time: - Pattern: `{interval_data_type}.interval.start_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `steps.interval.start_time >= \"2023-11-24T00:00:00Z\" AND steps.interval.start_time < \"2023-11-25T00:00:00Z\"` - `distance.interval.start_time >= \"2024-08-14T12:34:56Z\"` - Interval civil start time: - Pattern: `{interval_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `steps.interval.civil_start_time >= \"2023-11-24\" AND steps.interval.civil_start_time < \"2023-11-25\"` - `distance.interval.civil_start_time >= \"2024-08-14T12:34:56\"` - Sample observation physical time: - Pattern: `{sample_data_type}.sample_time.physical_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `weight.sample_time.physical_time >= \"2023-11-24T00:00:00Z\" AND weight.sample_time.physical_time < \"2023-11-25T00:00:00Z\"` - `weight.sample_time.physical_time >= \"2024-08-14T12:34:56Z\"` - Sample observation civil time: - Pattern: `{sample_data_type}.sample_time.civil_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `weight.sample_time.civil_time >= \"2023-11-24\" AND weight.sample_time.civil_time < \"2023-11-25\"` - `weight.sample_time.civil_time >= \"2024-08-14T12:34:56\"` - Daily summary date: - Pattern: `{daily_summary_data_type}.date` - Supported comparison operators: `>=`, `<` - Date literal expected in ISO 8601 `YYYY-MM-DD` format - Supported logical operators: `AND` - Example: - `daily_heart_rate_variability.date < \"2024-08-15\"` - Session start time (**ECG specific**): - Pattern: `electrocardiogram.interval.start_time` - Supported comparison operators: `>=` - Timestamp literal expected in RFC-3339 format - Example: - `electrocardiogram.interval.start_time >= \"2024-08-14T12:34:56Z\"` - Note: Only filtering by start time is supported for ECG. Filtering by end time (e.g., `electrocardiogram.interval.end_time`) is not supported. - Session civil start time (**Excluding Sleep**): - Pattern: `{session_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `exercise.interval.civil_start_time >= \"2023-11-24\" AND exercise.interval.civil_start_time < \"2023-11-25\"` - `exercise.interval.civil_start_time >= \"2024-08-14T12:34:56\"` - Session end time (**Sleep specific**): - Pattern: `sleep.interval.end_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.end_time >= \"2023-11-24T00:00:00Z\" AND sleep.interval.end_time < \"2023-11-25T00:00:00Z\"` - Session civil end time (**Sleep specific**): - Pattern: `sleep.interval.civil_end_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.civil_end_time >= \"2023-11-24\" AND sleep.interval.civil_end_time < \"2023-11-25\"` Data points in the response will be ordered by the interval start time in descending order.", "location": "query", "type": "string" }, @@ -544,7 +591,13 @@ "path": "v4/{+parent}/dataPoints", "response": { "$ref": "ListDataPointsResponse" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", + "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", + "https://www.googleapis.com/auth/googlehealth.location.readonly", + "https://www.googleapis.com/auth/googlehealth.sleep.readonly" + ] }, "patch": { "description": "Updates a single identifiable data point. If a data point with the specified `name` is not found, the request will fail.", @@ -612,7 +665,13 @@ "path": "v4/{+parent}/dataPoints:reconcile", "response": { "$ref": "ReconcileDataPointsResponse" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", + "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", + "https://www.googleapis.com/auth/googlehealth.location.readonly", + "https://www.googleapis.com/auth/googlehealth.sleep.readonly" + ] }, "rollUp": { "description": "Roll up data points over physical time intervals for supported data types.", @@ -637,7 +696,13 @@ }, "response": { "$ref": "RollUpDataPointsResponse" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", + "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", + "https://www.googleapis.com/auth/googlehealth.location.readonly", + "https://www.googleapis.com/auth/googlehealth.sleep.readonly" + ] } } } @@ -646,7 +711,7 @@ } } }, - "revision": "20260503", + "revision": "20260515", "rootUrl": "https://health.googleapis.com/", "schemas": { "ActiveMinutes": { @@ -1249,7 +1314,7 @@ "type": "object" }, "DailyRollupDataPoint": { - "description": "Value of a daily rollup for a single civil time interval (aggregation window)", + "description": "Value of a daily rollup for a single civil time interval (aggregation window) of reconciled data points from all data sources, excluding those data points that are identified as recorded by wearables in intervals when they were not actually worn.", "id": "DailyRollupDataPoint", "properties": { "activeMinutes": { @@ -1929,7 +1994,7 @@ "id": "ExportExerciseTcxResponse", "properties": { "tcxData": { - "description": "Contains the exported TCX data.", + "description": "Contains the exported TCX data. This field is intended for gRPC clients, as media download integration is not supported for gRPC. HTTP clients should instead use the `alt=media` query parameter to download the raw binary TCX file.", "type": "string" } }, @@ -2075,7 +2140,7 @@ "id": "HeartRateVariability", "properties": { "rootMeanSquareOfSuccessiveDifferencesMilliseconds": { - "description": "Optional. The root mean square of successive differences between normal heartbeats. This is a measure of heart rate variability used by Fitbit.", + "description": "Optional. The root mean square of successive differences between normal heartbeats. This is a measure of heart rate variability used by Google Health.", "format": "double", "type": "number" }, @@ -2847,7 +2912,7 @@ "type": "object" }, "RollupDataPoint": { - "description": "Value of a rollup for a single physical time interval (aggregation window)", + "description": "Value of a rollup for a single physical time interval (aggregation window) of reconciled data points from all data sources, excluding those data points that are identified as recorded by wearables in intervals when they were not actually worn.", "id": "RollupDataPoint", "properties": { "activeMinutes": { @@ -3624,7 +3689,7 @@ "id": "SubscriberConfig", "properties": { "dataTypes": { - "description": "Required. Supported data types are: \"altitude\", \"distance\", \"floors\", \"sleep\", \"steps\", \"weight\". Values should be in kebab-case.", + "description": "Required. See [Google Health API data types](https://developers.google.com/health/data-types) for the list of supported data types. Values should be in kebab-case.", "items": { "type": "string" }, @@ -3905,7 +3970,7 @@ "type": "number" }, "userProvidedUnit": { - "description": "Optional. Value representing the user provided unit.", + "description": "Optional. Value representing the user provided unit, used only for user-facing input and display purposes. In the API format, all volume quantities are converted to milliliters.", "enum": [ "VOLUME_UNIT_UNSPECIFIED", "CUP_IMPERIAL", diff --git a/discovery/healthcare-v1.json b/discovery/healthcare-v1.json index 7dd2a5a62b9..1ee952500bd 100644 --- a/discovery/healthcare-v1.json +++ b/discovery/healthcare-v1.json @@ -148,7 +148,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -5171,7 +5171,7 @@ } } }, - "revision": "20260421", + "revision": "20260512", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -5629,6 +5629,10 @@ "description": "Optional. If provided, only resources updated before or atthis time are deleted. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone.", "type": "string" }, + "validateOnly": { + "description": "Optional. If set to true, the request will only perform a dry run. By default (once the behavior change is fully rolled out), this will default to true. During the transition period, the default depends on the Mendel flag status for the project.", + "type": "boolean" + }, "versionConfig": { "description": "Optional. Specifies which version of the resources to delete.", "enum": [ diff --git a/discovery/healthcare-v1beta1.json b/discovery/healthcare-v1beta1.json index 5f43f479089..311815dffe2 100644 --- a/discovery/healthcare-v1beta1.json +++ b/discovery/healthcare-v1beta1.json @@ -148,7 +148,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -5718,7 +5718,7 @@ } } }, - "revision": "20260421", + "revision": "20260512", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -6236,6 +6236,10 @@ "description": "Optional. If provided, only resources updated before or atthis time are deleted. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone.", "type": "string" }, + "validateOnly": { + "description": "Optional. If set to true, the request will only perform a dry run. By default (once the behavior change is fully rolled out), this will default to true. During the transition period, the default depends on the Mendel flag status for the project.", + "type": "boolean" + }, "versionConfig": { "description": "Optional. Specifies which version of the resources to delete.", "enum": [ diff --git a/discovery/homegraph-v1.json b/discovery/homegraph-v1.json index aee9d62d941..4325204b06e 100644 --- a/discovery/homegraph-v1.json +++ b/discovery/homegraph-v1.json @@ -216,7 +216,7 @@ } } }, - "revision": "20260414", + "revision": "20260508", "rootUrl": "https://homegraph.googleapis.com/", "schemas": { "AgentDeviceId": { @@ -355,6 +355,21 @@ }, "type": "object" }, + "DeviceMetadata": { + "description": "Metadata for traits of a single device.", + "id": "DeviceMetadata", + "properties": { + "traitCommitTimestamps": { + "additionalProperties": { + "format": "google-datetime", + "type": "string" + }, + "description": "Map from the Trait ID (e.g., \"action.devices.traits.OnOff\") to its last Spanner commit timestamp.", + "type": "object" + } + }, + "type": "object" + }, "DeviceNames": { "description": "Identifiers used to describe the device.", "id": "DeviceNames", @@ -472,6 +487,10 @@ "description": "Required. Third-party user ID.", "type": "string" }, + "includeDeviceMetadata": { + "description": "Optional. If true, the response will include device metadata in the device_metadata field.", + "type": "boolean" + }, "inputs": { "description": "Required. Inputs containing third-party device IDs for which to get the device states.", "items": { @@ -530,6 +549,13 @@ "description": "Payload containing device states information.", "id": "QueryResponsePayload", "properties": { + "deviceMetadata": { + "additionalProperties": { + "$ref": "DeviceMetadata" + }, + "description": "Map from the Trait ID (e.g., \"action.devices.traits.OnOff\") to its last Spanner commit timestamp. If a trait has no recorded timestamp, it will be omitted from this map.", + "type": "object" + }, "devices": { "additionalProperties": { "additionalProperties": { diff --git a/discovery/hypercomputecluster-v1.json b/discovery/hypercomputecluster-v1.json index b5909639e67..7e9e5dc17c6 100644 --- a/discovery/hypercomputecluster-v1.json +++ b/discovery/hypercomputecluster-v1.json @@ -498,7 +498,7 @@ } } }, - "revision": "20260429", + "revision": "20260506", "rootUrl": "https://hypercomputecluster.googleapis.com/", "schemas": { "BootDisk": { @@ -1793,7 +1793,7 @@ "type": "object" }, "StorageResource": { - "description": "A resource representing a form of persistent storage that is accessible to compute resources in the cluster.", + "description": "A resource representing a form of persistent storage that can be mounted onto compute resources in the cluster.", "id": "StorageResource", "properties": { "bucket": { diff --git a/discovery/index.json b/discovery/index.json index 61eb315fbc6..a40b8612f57 100644 --- a/discovery/index.json +++ b/discovery/index.json @@ -1740,6 +1740,21 @@ "title": "Cloud Location Finder API", "version": "v1" }, + { + "description": "", + "discoveryRestUrl": "https://cloudnumberregistry.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://docs.cloud.google.com/number-registry/reference/rest", + "icons": { + "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", + "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" + }, + "id": "cloudnumberregistry:v1alpha", + "kind": "discovery#directoryItem", + "name": "cloudnumberregistry", + "preferred": true, + "title": "Cloud Number Registry API", + "version": "v1alpha" + }, { "description": "Manages continuous profiling information.", "discoveryRestUrl": "https://cloudprofiler.googleapis.com/$discovery/rest?version=v2", diff --git a/discovery/managedidentities-v1.json b/discovery/managedidentities-v1.json index e5f8607d13b..3afb7a4f00e 100644 --- a/discovery/managedidentities-v1.json +++ b/discovery/managedidentities-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1526,7 +1526,7 @@ } } }, - "revision": "20260414", + "revision": "20260424", "rootUrl": "https://managedidentities.googleapis.com/", "schemas": { "AttachTrustRequest": { diff --git a/discovery/merchantapi-accounts_v1.json b/discovery/merchantapi-accounts_v1.json index 64660014c56..d64d51c0f25 100644 --- a/discovery/merchantapi-accounts_v1.json +++ b/discovery/merchantapi-accounts_v1.json @@ -607,7 +607,7 @@ ] }, "registerGcp": { - "description": "Registers the GCP used for the API call to the shopping account passed in the request. Will create a user with an \"API developer\" and add the \"developer_email\" as a contact with \"API notifications\" email preference on.", + "description": "Registers the GCP used for the API call to the shopping account passed in the request. Will create a user with an \"API developer\" and add the \"developer_email\" as a contact with \"API notifications\" email preference on. Restrictions: * The caller account must be authenticated and must not impersonate another account at registration time. Registering for subaccounts is not supported if the caller account is authenticated with the parent or the managing advanced account. * The caller account must have a [verified website](https://support.google.com/merchants/answer/11586344) in Merchant Center. * [Test accounts](https://developers.google.com/merchant/api/guides/accounts/test-accounts) are not eligible for registration.", "flatPath": "accounts/v1/accounts/{accountsId}/developerRegistration:registerGcp", "httpMethod": "POST", "id": "merchantapi.accounts.developerRegistration.registerGcp", @@ -616,7 +616,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account}/developerRegistration` The {account} used must be the same account where user calling this API method is directly added to.", + "description": "Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account}/developerRegistration` The {account} used must be the same account where user calling this API method is directly added to. Note: The account used must be a production account (can't be a [test account](https://developers.google.com/merchant/api/guides/accounts/test-accounts) ) and must have a [verified website](https://support.google.com/merchants/answer/11586344) in Merchant Center.", "location": "path", "pattern": "^accounts/[^/]+/developerRegistration$", "required": true, @@ -2438,7 +2438,7 @@ } } }, - "revision": "20260415", + "revision": "20260512", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "About": { diff --git a/discovery/merchantapi-accounts_v1beta.json b/discovery/merchantapi-accounts_v1beta.json index 03c30efd532..fb68ca2e6fd 100644 --- a/discovery/merchantapi-accounts_v1beta.json +++ b/discovery/merchantapi-accounts_v1beta.json @@ -607,7 +607,7 @@ ] }, "registerGcp": { - "description": "Registers the GCP used for the API call to the shopping account passed in the request. Will create a user with an \"API developer\" and add the \"developer_email\" as a contact with \"API notifications\" email preference on.", + "description": "Registers the GCP used for the API call to the shopping account passed in the request. Will create a user with an \"API developer\" and add the \"developer_email\" as a contact with \"API notifications\" email preference on. Restrictions: * The caller account must be authenticated and must not impersonate another account at registration time. Registering for subaccounts is not supported if the caller account is authenticated with the parent or the managing advanced account. * The caller account must have a [verified website](https://support.google.com/merchants/answer/11586344) in Merchant Center. * [Test accounts](https://developers.google.com/merchant/api/guides/accounts/test-accounts) are not eligible for registration.", "flatPath": "accounts/v1beta/accounts/{accountsId}/developerRegistration:registerGcp", "httpMethod": "POST", "id": "merchantapi.accounts.developerRegistration.registerGcp", @@ -616,7 +616,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account}/developerRegistration` The {account} used must be the same account where user calling this API method is directly added to.", + "description": "Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account}/developerRegistration` The {account} used must be the same account where user calling this API method is directly added to. Note: The account used must be a production account (can't be a [test account](https://developers.google.com/merchant/api/guides/accounts/test-accounts) ) and must have a [verified website](https://support.google.com/merchants/answer/11586344) in Merchant Center.", "location": "path", "pattern": "^accounts/[^/]+/developerRegistration$", "required": true, @@ -2388,7 +2388,7 @@ } } }, - "revision": "20260415", + "revision": "20260512", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "About": { diff --git a/discovery/merchantapi-products_v1.json b/discovery/merchantapi-products_v1.json index 17adcfe76cf..adb6e1a84e7 100644 --- a/discovery/merchantapi-products_v1.json +++ b/discovery/merchantapi-products_v1.json @@ -281,7 +281,7 @@ } } }, - "revision": "20260501", + "revision": "20260512", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AutomatedDiscounts": { @@ -1111,6 +1111,21 @@ }, "type": "object" }, + "PickupCost": { + "description": "The pickup cost of the item.", + "id": "PickupCost", + "properties": { + "flatRate": { + "$ref": "Price", + "description": "Required. The flat rate pickup cost of the item." + }, + "freeThreshold": { + "$ref": "Price", + "description": "Optional. The price threshold above which pickup is free of charge." + } + }, + "type": "object" + }, "Price": { "description": "The price represented as a number and currency.", "id": "Price", @@ -1131,6 +1146,11 @@ "description": "The processed product, built from multiple product inputs after applying rules and supplemental data sources. This processed product matches what is shown in your Merchant Center account. Each product is built from exactly one primary data source product input, and multiple supplemental data source inputs. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved. All fields in the processed product and its sub-messages match the name of their corresponding attribute in the [Product data specification](https://support.google.com/merchants/answer/7052112) with some exceptions.", "id": "Product", "properties": { + "archived": { + "description": "Output only. Determines whether the product is [archived](https://support.google.com/merchants/answer/11909930). To archive or restore your product, visit Merchant Center products page. Learn also more about [offer visibility](https://support.google.com/merchants/answer/12488713).", + "readOnly": true, + "type": "boolean" + }, "automatedDiscounts": { "$ref": "AutomatedDiscounts", "description": "Output only. The automated discounts information for the product.", @@ -1872,6 +1892,10 @@ ], "type": "string" }, + "pickupCost": { + "$ref": "PickupCost", + "description": "Optional. The [pickup cost](https://support.google.com/merchants/answer/16988704) for an item when a customer buys it online and picks it up at a store." + }, "pickupMethod": { "description": "The [pickup](https://support.google.com/merchants/answer/14634021) option for the item.", "enum": [ diff --git a/discovery/merchantapi-products_v1beta.json b/discovery/merchantapi-products_v1beta.json index b45d6dd7d1c..dd367a027cb 100644 --- a/discovery/merchantapi-products_v1beta.json +++ b/discovery/merchantapi-products_v1beta.json @@ -281,7 +281,7 @@ } } }, - "revision": "20260419", + "revision": "20260512", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Attributes": { @@ -1240,6 +1240,11 @@ "description": "The processed product, built from multiple product inputs after applying rules and supplemental data sources. This processed product matches what is shown in your Merchant Center account. Each product is built from exactly one primary data source product input, and multiple supplemental data source inputs. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved. All fields in the processed product and its sub-messages match the name of their corresponding attribute in the [Product data specification](https://support.google.com/merchants/answer/7052112) with some exceptions.", "id": "Product", "properties": { + "archived": { + "description": "Output only. Determines whether the product is [archived](https://support.google.com/merchants/answer/11909930). To archive or restore your product, visit Merchant Center products page. Learn also more about [offer visibility](https://support.google.com/merchants/answer/12488713).", + "readOnly": true, + "type": "boolean" + }, "attributes": { "$ref": "Attributes", "description": "Output only. A list of product attributes.", diff --git a/discovery/migrationcenter-v1alpha1.json b/discovery/migrationcenter-v1alpha1.json index 7b44b03b0c7..aa7c3a19701 100644 --- a/discovery/migrationcenter-v1alpha1.json +++ b/discovery/migrationcenter-v1alpha1.json @@ -2722,7 +2722,7 @@ } } }, - "revision": "20260423", + "revision": "20260512", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -2968,6 +2968,11 @@ "description": "Output only. Asset information specific for AWS Application Load Balancers.", "readOnly": true }, + "awsAthenaWorkGroupDetails": { + "$ref": "AwsAthenaWorkGroupDetails", + "description": "Output only. Asset information specific for AwsAthenaWorkGroupDetails", + "readOnly": true + }, "awsAutoscalingGroupDetails": { "$ref": "AwsAutoscalingGroupDetails", "description": "Output only. Asset information specific for AwsAutoscalingGroupDetails", @@ -3028,11 +3033,31 @@ "description": "Output only. Asset information specific for AWS Load Balancers.", "readOnly": true }, + "awsEmrClusterDetails": { + "$ref": "AwsEmrClusterDetails", + "description": "Output only. Asset information specific for AwsEmrClusterDetails", + "readOnly": true + }, + "awsFirehoseDetails": { + "$ref": "AwsFirehoseDetails", + "description": "Output only. Asset information specific for AwsFirehoseDetails", + "readOnly": true + }, + "awsGlueJobDetails": { + "$ref": "AwsGlueJobDetails", + "description": "Output only. Asset information specific for AwsGlueJobDetails", + "readOnly": true + }, "awsInternetGatewayDetails": { "$ref": "AwsInternetGatewayDetails", "description": "Output only. Asset information specific for AWS Internet Gateways.", "readOnly": true }, + "awsKinesisStreamDetails": { + "$ref": "AwsKinesisStreamDetails", + "description": "Output only. Asset information specific for AwsKinesisStreamDetails", + "readOnly": true + }, "awsLambdaFunctionDetails": { "$ref": "AwsLambdaFunctionDetails", "description": "Output only. Asset information specific for AWS Lambda functions.", @@ -3187,6 +3212,10 @@ "$ref": "AwsApplicationLoadBalancerDetails", "description": "Optional. Asset information specific for AWS Application Load Balancers." }, + "awsAthenaWorkGroupDetails": { + "$ref": "AwsAthenaWorkGroupDetails", + "description": "Optional. Asset information specific for AwsAthenaWorkGroupDetails" + }, "awsAutoscalingGroupDetails": { "$ref": "AwsAutoscalingGroupDetails", "description": "Optional. Asset information specific for AwsAutoscalingGroupDetails" @@ -3235,10 +3264,26 @@ "$ref": "AwsElbLoadBalancerDetails", "description": "Asset information specific for AWS Load Balancers." }, + "awsEmrClusterDetails": { + "$ref": "AwsEmrClusterDetails", + "description": "Optional. Asset information specific for AwsEmrClusterDetails" + }, + "awsFirehoseDetails": { + "$ref": "AwsFirehoseDetails", + "description": "Optional. Asset information specific for AwsFirehoseDetails" + }, + "awsGlueJobDetails": { + "$ref": "AwsGlueJobDetails", + "description": "Optional. Asset information specific for AwsGlueJobDetails" + }, "awsInternetGatewayDetails": { "$ref": "AwsInternetGatewayDetails", "description": "Optional. Asset information specific for AWS Internet Gateways." }, + "awsKinesisStreamDetails": { + "$ref": "AwsKinesisStreamDetails", + "description": "Optional. Asset information specific for AwsKinesisStreamDetails" + }, "awsLambdaFunctionDetails": { "$ref": "AwsLambdaFunctionDetails", "description": "Asset information specific for AWS Lambda functions." @@ -3548,6 +3593,12 @@ "properties": {}, "type": "object" }, + "AwsAthenaWorkGroupDetails": { + "description": "Contains details for an AWS Athena Work Group asset.", + "id": "AwsAthenaWorkGroupDetails", + "properties": {}, + "type": "object" + }, "AwsAutoscalingGroupDetails": { "description": "Asset information specific for AWS Autoscaling Group.", "id": "AwsAutoscalingGroupDetails", @@ -3649,12 +3700,36 @@ "properties": {}, "type": "object" }, + "AwsEmrClusterDetails": { + "description": "Contains details for an AWS EMR Cluster asset.", + "id": "AwsEmrClusterDetails", + "properties": {}, + "type": "object" + }, + "AwsFirehoseDetails": { + "description": "Contains details for an AWS Firehose asset.", + "id": "AwsFirehoseDetails", + "properties": {}, + "type": "object" + }, + "AwsGlueJobDetails": { + "description": "Contains details for an AWS Glue Job asset.", + "id": "AwsGlueJobDetails", + "properties": {}, + "type": "object" + }, "AwsInternetGatewayDetails": { "description": "Asset information specific for AWS Internet Gateways.", "id": "AwsInternetGatewayDetails", "properties": {}, "type": "object" }, + "AwsKinesisStreamDetails": { + "description": "Contains details for an AWS Kinesis Stream asset.", + "id": "AwsKinesisStreamDetails", + "properties": {}, + "type": "object" + }, "AwsLambdaFunctionDetails": { "description": "Asset information specific for AWS Lambda functions.", "id": "AwsLambdaFunctionDetails", diff --git a/discovery/mybusinessaccountmanagement-v1.json b/discovery/mybusinessaccountmanagement-v1.json index 5f7a2af51fc..a743869ceda 100644 --- a/discovery/mybusinessaccountmanagement-v1.json +++ b/discovery/mybusinessaccountmanagement-v1.json @@ -530,7 +530,7 @@ } } }, - "revision": "20260419", + "revision": "20260512", "rootUrl": "https://mybusinessaccountmanagement.googleapis.com/", "schemas": { "AcceptInvitationRequest": { @@ -912,6 +912,11 @@ "locationName": { "description": "The name of the location to which the user is invited.", "type": "string" + }, + "placeId": { + "description": "Output only. The Place ID of the location to which the user is invited. Not always populated.", + "readOnly": true, + "type": "string" } }, "type": "object" diff --git a/discovery/netapp-v1.json b/discovery/netapp-v1.json index c5cc6d059bb..c4854886c8e 100644 --- a/discovery/netapp-v1.json +++ b/discovery/netapp-v1.json @@ -1406,7 +1406,7 @@ ], "parameters": { "name": { - "description": "Identifier. Name of the KmsConfig. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}`", + "description": "Identifier. Name of the `KmsConfig`. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/kmsConfigs/[^/]+$", "required": true, @@ -1814,7 +1814,7 @@ "ontap": { "methods": { "executeOntapDelete": { - "description": "`ExecuteOntapDelete` dispatches the ONTAP `DELETE` request to the `StoragePool` cluster.", + "description": "`ExecuteOntapDelete` sends the ONTAP `DELETE` request to the `StoragePool` cluster.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}/ontap/{ontapId}", "httpMethod": "DELETE", "id": "netapp.projects.locations.storagePools.ontap.executeOntapDelete", @@ -1839,7 +1839,7 @@ ] }, "executeOntapGet": { - "description": "`ExecuteOntapGet` dispatches the ONTAP `GET` request to the `StoragePool` cluster.", + "description": "`ExecuteOntapGet` sends the ONTAP `GET` request to the `StoragePool` cluster.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}/ontap/{ontapId}", "httpMethod": "GET", "id": "netapp.projects.locations.storagePools.ontap.executeOntapGet", @@ -1864,7 +1864,7 @@ ] }, "executeOntapPatch": { - "description": "`ExecuteOntapPatch` dispatches the ONTAP `PATCH` request to the `StoragePool` cluster.", + "description": "`ExecuteOntapPatch` sends the ONTAP `PATCH` request to the `StoragePool` cluster.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}/ontap/{ontapId}", "httpMethod": "PATCH", "id": "netapp.projects.locations.storagePools.ontap.executeOntapPatch", @@ -1892,7 +1892,7 @@ ] }, "executeOntapPost": { - "description": "`ExecuteOntapPost` dispatches the ONTAP `POST` request to the `StoragePool` cluster.", + "description": "`ExecuteOntapPost` sends the ONTAP `POST` request to the `StoragePool` cluster.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}/ontap/{ontapId}", "httpMethod": "POST", "id": "netapp.projects.locations.storagePools.ontap.executeOntapPost", @@ -1901,7 +1901,7 @@ ], "parameters": { "ontapPath": { - "description": "Required. The resource path of the ONTAP resource. Format: `projects/{project_number}/locations/{location_id}/storagePools/{storage_pool_id}/ontap/{ontap_resource_path}`. For example: `projects/123456789/locations/us-central1/storagePools/my-storage-pool/ontap/api/storage/volumes`.", + "description": "Required. The path of the ONTAP resource. Format: `projects/{project_number}/locations/{location_id}/storagePools/{storage_pool_id}/ontap/{ontap_resource_path}`. For example: `projects/123456789/locations/us-central1/storagePools/my-storage-pool/ontap/api/storage/volumes`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+/ontap/.*$", "required": true, @@ -2827,7 +2827,7 @@ } } }, - "revision": "20260426", + "revision": "20260513", "rootUrl": "https://netapp.googleapis.com/", "schemas": { "ActiveDirectory": { @@ -3033,7 +3033,7 @@ "type": "string" }, "sourceVolume": { - "description": "Volume full name of this backup belongs to. Either source_volume or ontap_source should be provided. Format: `projects/{projects_id}/locations/{location}/volumes/{volume_id}`", + "description": "The resource name of the volume that this backup belongs to. You must provide either `source_volume` or `ontap_source`. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}`", "type": "string" }, "state": { @@ -3616,7 +3616,7 @@ "type": "string" }, "peerIpAddresses": { - "description": "Optional. List of IPv4 ip addresses to be used for peering.", + "description": "Optional. List of IPv4 IP addresses to be used for peering.", "items": { "type": "string" }, @@ -4002,7 +4002,7 @@ "type": "object" }, "name": { - "description": "Identifier. Name of the KmsConfig. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}`", + "description": "Identifier. Name of the `KmsConfig`. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}`", "type": "string" }, "serviceAccount": { @@ -4052,7 +4052,7 @@ "type": "object" }, "LargeCapacityConfig": { - "description": "Configuration for a Large Capacity Volume. A Large Capacity Volume supports sizes ranging from 4.8 TiB to 20 PiB, it is composed of multiple internal constituents, and must be created in a large capacity pool.", + "description": "Configuration for a Large Capacity Volume. A Large Capacity Volume supports sizes ranging from 4.8 TiB to 20 PiB; it is composed of multiple internal constituents, and must be created in a large capacity pool.", "id": "LargeCapacityConfig", "properties": { "constituentCount": { @@ -4526,14 +4526,16 @@ "NFSV3", "NFSV4", "SMB", - "ISCSI" + "ISCSI", + "NVME" ], "enumDescriptions": [ "Unspecified protocol", "NFS V3 protocol", "NFS V4 protocol", "SMB protocol", - "ISCSI protocol" + "ISCSI protocol", + "NVMe protocol" ], "type": "string" } @@ -4904,7 +4906,7 @@ "id": "RestoreParameters", "properties": { "sourceBackup": { - "description": "Full name of the backup resource. Format for standard backup: projects/{project}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id} Format for BackupDR backup: projects/{project}/locations/{location}/backupVaults/{backup_vault}/dataSources/{data_source}/backups/{backup}", + "description": "Full name of the backup resource. Format for standard backup: projects/{project}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}. Format for BackupDR backup: projects/{project}/locations/{location}/backupVaults/{backup_vault}/dataSources/{data_source}/backups/{backup}", "type": "string" }, "sourceSnapshot": { @@ -5242,7 +5244,7 @@ "type": "boolean" }, "mode": { - "description": "Optional. Mode of the storage pool. This field is used to control whether the user can perform the ONTAP operations on the storage pool using the GCNV ONTAP Mode APIs. If not specified during creation, it defaults to `DEFAULT`.", + "description": "Optional. Mode of the storage pool. This field is used to control whether the user can perform ONTAP operations on the storage pool using the GCNV ONTAP Mode APIs. If not specified during creation, it defaults to `DEFAULT`.", "enum": [ "MODE_UNSPECIFIED", "DEFAULT", @@ -5692,14 +5694,16 @@ "NFSV3", "NFSV4", "SMB", - "ISCSI" + "ISCSI", + "NVME" ], "enumDescriptions": [ "Unspecified protocol", "NFS V3 protocol", "NFS V4 protocol", "SMB protocol", - "ISCSI protocol" + "ISCSI protocol", + "NVMe protocol" ], "type": "string" }, diff --git a/discovery/netapp-v1beta1.json b/discovery/netapp-v1beta1.json index d4d7a433ac1..90f07cae0fe 100644 --- a/discovery/netapp-v1beta1.json +++ b/discovery/netapp-v1beta1.json @@ -1406,7 +1406,7 @@ ], "parameters": { "name": { - "description": "Identifier. Name of the KmsConfig. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}`", + "description": "Identifier. Name of the `KmsConfig`. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/kmsConfigs/[^/]+$", "required": true, @@ -1753,6 +1753,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "restoreVolume": { + "description": "Restores a backup to an ONTAP-mode volume.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}:restoreVolume", + "httpMethod": "POST", + "id": "netapp.projects.locations.storagePools.restoreVolume", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the ONTAP mode storage pool, in the format of `projects/{project}/locations/{location}/storagePools/{storage_pool}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:restoreVolume", + "request": { + "$ref": "RestoreVolumeRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "switch": { "description": "This operation will switch the active/replica zone for a regional storagePool.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}:switch", @@ -1781,6 +1809,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "updateBackupConfig": { + "description": "Updates the backup configuration for an ONTAP-mode volume.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}:updateBackupConfig", + "httpMethod": "POST", + "id": "netapp.projects.locations.storagePools.updateBackupConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the StoragePool, in the format: projects/{projectNumber}/locations/{locationId}/storagePools/{poolId}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:updateBackupConfig", + "request": { + "$ref": "UpdateBackupConfigRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "validateDirectoryService": { "description": "ValidateDirectoryService does a connectivity check for a directory service policy attached to the storage pool.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}:validateDirectoryService", @@ -1811,10 +1867,60 @@ } }, "resources": { + "backupConfigs": { + "methods": { + "list": { + "description": "Lists backup configurations for all volumes in an ONTAP-mode Storage Pool.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}/backupConfigs", + "httpMethod": "GET", + "id": "netapp.projects.locations.storagePools.backupConfigs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The standard list filter.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Sort results. Supported values are \"volume_id\" or \"\"", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of items to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified or set to 0, a default of 50 will be used.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The next_page_token value to use if there are additional results to retrieve for this list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The ONTAP StoragePool for which to retrieve backup configuration information, in the format `projects/{project}/locations/{location}/storagePools/{storage_pool}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/backupConfigs", + "response": { + "$ref": "ListBackupConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "ontap": { "methods": { "executeOntapDelete": { - "description": "`ExecuteOntapDelete` dispatches the ONTAP `DELETE` request to the `StoragePool` cluster.", + "description": "`ExecuteOntapDelete` sends the ONTAP `DELETE` request to the `StoragePool` cluster.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}/ontap/{ontapId}", "httpMethod": "DELETE", "id": "netapp.projects.locations.storagePools.ontap.executeOntapDelete", @@ -1839,7 +1945,7 @@ ] }, "executeOntapGet": { - "description": "`ExecuteOntapGet` dispatches the ONTAP `GET` request to the `StoragePool` cluster.", + "description": "`ExecuteOntapGet` sends the ONTAP `GET` request to the `StoragePool` cluster.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}/ontap/{ontapId}", "httpMethod": "GET", "id": "netapp.projects.locations.storagePools.ontap.executeOntapGet", @@ -1864,7 +1970,7 @@ ] }, "executeOntapPatch": { - "description": "`ExecuteOntapPatch` dispatches the ONTAP `PATCH` request to the `StoragePool` cluster.", + "description": "`ExecuteOntapPatch` sends the ONTAP `PATCH` request to the `StoragePool` cluster.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}/ontap/{ontapId}", "httpMethod": "PATCH", "id": "netapp.projects.locations.storagePools.ontap.executeOntapPatch", @@ -1892,7 +1998,7 @@ ] }, "executeOntapPost": { - "description": "`ExecuteOntapPost` dispatches the ONTAP `POST` request to the `StoragePool` cluster.", + "description": "`ExecuteOntapPost` sends the ONTAP `POST` request to the `StoragePool` cluster.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}/ontap/{ontapId}", "httpMethod": "POST", "id": "netapp.projects.locations.storagePools.ontap.executeOntapPost", @@ -1901,7 +2007,7 @@ ], "parameters": { "ontapPath": { - "description": "Required. The resource path of the ONTAP resource. Format: `projects/{project_number}/locations/{location_id}/storagePools/{storage_pool_id}/ontap/{ontap_resource_path}`. For example: `projects/123456789/locations/us-central1/storagePools/my-storage-pool/ontap/api/storage/volumes`.", + "description": "Required. The path of the ONTAP resource. Format: `projects/{project_number}/locations/{location_id}/storagePools/{storage_pool_id}/ontap/{ontap_resource_path}`. For example: `projects/123456789/locations/us-central1/storagePools/my-storage-pool/ontap/api/storage/volumes`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+/ontap/.*$", "required": true, @@ -2827,7 +2933,7 @@ } } }, - "revision": "20260426", + "revision": "20260513", "rootUrl": "https://netapp.googleapis.com/", "schemas": { "ActiveDirectory": { @@ -3018,6 +3124,10 @@ "description": "Identifier. The resource name of the backup. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`.", "type": "string" }, + "ontapSource": { + "$ref": "OntapSource", + "description": "Optional. Represents source details for ONTAP backups. Either source_volume or ontap_source should be provided." + }, "satisfiesPzi": { "description": "Output only. Reserved for future use", "readOnly": true, @@ -3033,7 +3143,7 @@ "type": "string" }, "sourceVolume": { - "description": "Volume full name of this backup belongs to. Either source_volume or ontap_source should be provided. Format: `projects/{projects_id}/locations/{location}/volumes/{volume_id}`", + "description": "The resource name of the volume that this backup belongs to. You must provide either `source_volume` or `ontap_source`. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}`", "type": "string" }, "state": { @@ -3203,6 +3313,24 @@ }, "type": "object" }, + "BackupSource": { + "description": "Represents the backup source of the restore operation.", + "id": "BackupSource", + "properties": { + "backup": { + "description": "Required. The backup resource name.", + "type": "string" + }, + "fileList": { + "description": "Optional. List of files to be restored in the form of their absolute path as in source volume. If provided, only these files will be restored. If not provided, the entire backup will be restored (Full Backup Restore)", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "BackupVault": { "description": "A NetApp BackupVault.", "id": "BackupVault", @@ -3620,7 +3748,7 @@ "type": "string" }, "peerIpAddresses": { - "description": "Optional. List of IPv4 ip addresses to be used for peering.", + "description": "Optional. List of IPv4 IP addresses to be used for peering.", "items": { "type": "string" }, @@ -4006,7 +4134,7 @@ "type": "object" }, "name": { - "description": "Identifier. Name of the KmsConfig. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}`", + "description": "Identifier. Name of the `KmsConfig`. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}`", "type": "string" }, "serviceAccount": { @@ -4056,7 +4184,7 @@ "type": "object" }, "LargeCapacityConfig": { - "description": "Configuration for a Large Capacity Volume. A Large Capacity Volume supports sizes ranging from 4.8 TiB to 20 PiB, it is composed of multiple internal constituents, and must be created in a large capacity pool.", + "description": "Configuration for a Large Capacity Volume. A Large Capacity Volume supports sizes ranging from 4.8 TiB to 20 PiB; it is composed of multiple internal constituents, and must be created in a large capacity pool.", "id": "LargeCapacityConfig", "properties": { "constituentCount": { @@ -4092,6 +4220,31 @@ }, "type": "object" }, + "ListBackupConfigsResponse": { + "description": "Message for response to listing BackupConfigs in an ONTAP StoragePool.", + "id": "ListBackupConfigsResponse", + "properties": { + "nextPageToken": { + "description": "The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.", + "type": "string" + }, + "unreachable": { + "description": "Unordered list. Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + }, + "volumeBackupConfigs": { + "description": "A list of backup configurations for volumes in the pool.", + "items": { + "$ref": "VolumeBackupConfig" + }, + "type": "array" + } + }, + "type": "object" + }, "ListBackupPoliciesResponse": { "description": "ListBackupPoliciesResponse contains all the backup policies requested.", "id": "ListBackupPoliciesResponse", @@ -4530,20 +4683,56 @@ "NFSV3", "NFSV4", "SMB", - "ISCSI" + "ISCSI", + "NVME" ], "enumDescriptions": [ "Unspecified protocol", "NFS V3 protocol", "NFS V4 protocol", "SMB protocol", - "ISCSI protocol" + "ISCSI protocol", + "NVMe protocol" ], "type": "string" } }, "type": "object" }, + "OntapSource": { + "description": "Represents ONTAP source details.", + "id": "OntapSource", + "properties": { + "snapshotUuid": { + "description": "Optional. The UUID of the ONTAP source snapshot.", + "type": "string" + }, + "storagePool": { + "description": "Required. Name of the storage pool. This must be specified for creating backups for ONTAP mode volumes. Format: `projects/{projects_id}/locations/{location}/storagePools/{storage_pool_id}`", + "type": "string" + }, + "volumeUuid": { + "description": "Required. The UUID of the ONTAP source volume.", + "type": "string" + } + }, + "type": "object" + }, + "OntapVolumeTarget": { + "description": "Represents the ONTAP volume target of the restore operation.", + "id": "OntapVolumeTarget", + "properties": { + "restoreDestinationPath": { + "description": "Optional. Absolute directory path in the destination volume.", + "type": "string" + }, + "volumeUuid": { + "description": "Required. The UUID of the ONTAP volume to restore to.", + "type": "string" + } + }, + "type": "object" + }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -4908,7 +5097,7 @@ "id": "RestoreParameters", "properties": { "sourceBackup": { - "description": "Full name of the backup resource. Format for standard backup: projects/{project}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id} Format for BackupDR backup: projects/{project}/locations/{location}/backupVaults/{backup_vault}/dataSources/{data_source}/backups/{backup}", + "description": "Full name of the backup resource. Format for standard backup: projects/{project}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}. Format for BackupDR backup: projects/{project}/locations/{location}/backupVaults/{backup_vault}/dataSources/{data_source}/backups/{backup}", "type": "string" }, "sourceSnapshot": { @@ -4918,6 +5107,21 @@ }, "type": "object" }, + "RestoreVolumeRequest": { + "description": "Request message for `RestoreVolume` API.", + "id": "RestoreVolumeRequest", + "properties": { + "backupSource": { + "$ref": "BackupSource", + "description": "The backup source of the restore operation." + }, + "ontapVolumeTarget": { + "$ref": "OntapVolumeTarget", + "description": "The ONTAP volume target of the restore operation." + } + }, + "type": "object" + }, "ResumeReplicationRequest": { "description": "ResumeReplicationRequest resumes a stopped replication.", "id": "ResumeReplicationRequest", @@ -5246,7 +5450,7 @@ "type": "boolean" }, "mode": { - "description": "Optional. Mode of the storage pool. This field is used to control whether the user can perform the ONTAP operations on the storage pool using the GCNV ONTAP Mode APIs. If not specified during creation, it defaults to `DEFAULT`.", + "description": "Optional. Mode of the storage pool. This field is used to control whether the user can perform ONTAP operations on the storage pool using the GCNV ONTAP Mode APIs. If not specified during creation, it defaults to `DEFAULT`.", "enum": [ "MODE_UNSPECIFIED", "DEFAULT", @@ -5507,6 +5711,26 @@ }, "type": "object" }, + "UpdateBackupConfigRequest": { + "description": "Request message for UpdateBackupConfig", + "id": "UpdateBackupConfigRequest", + "properties": { + "backupConfig": { + "$ref": "BackupConfig", + "description": "Required. Backup configuration to apply." + }, + "updateMask": { + "description": "Required. Field mask is used to specify the fields to be overwritten in the BackupConfig for the Volume. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.", + "format": "google-fieldmask", + "type": "string" + }, + "volumeUuid": { + "description": "Required. The UUID of the ONTAP-mode volume.", + "type": "string" + } + }, + "type": "object" + }, "UserCommands": { "description": "UserCommands contains the commands to be executed by the customer.", "id": "UserCommands", @@ -5711,14 +5935,16 @@ "NFSV3", "NFSV4", "SMB", - "ISCSI" + "ISCSI", + "NVME" ], "enumDescriptions": [ "Unspecified protocol", "NFS V3 protocol", "NFS V4 protocol", "SMB protocol", - "ISCSI protocol" + "ISCSI protocol", + "NVMe protocol" ], "type": "string" }, @@ -5899,6 +6125,21 @@ }, "type": "object" }, + "VolumeBackupConfig": { + "description": "Backup configuration for a volume in a pool.", + "id": "VolumeBackupConfig", + "properties": { + "backupConfig": { + "$ref": "BackupConfig", + "description": "Backup configuration for the volume." + }, + "volumeUuid": { + "description": "Provides the Ontap UUID of the volume within the pool.", + "type": "string" + } + }, + "type": "object" + }, "WeeklySchedule": { "description": "Make a snapshot every week e.g. at Monday 04:00, Wednesday 05:20, Sunday 23:50", "id": "WeeklySchedule", diff --git a/discovery/networkconnectivity-v1.json b/discovery/networkconnectivity-v1.json index e6e02ffcc39..cd3110a23d5 100644 --- a/discovery/networkconnectivity-v1.json +++ b/discovery/networkconnectivity-v1.json @@ -3525,6 +3525,190 @@ "https://www.googleapis.com/auth/cloud-platform" ] } + }, + "resources": { + "gatewayAdvertisedRoutes": { + "methods": { + "create": { + "description": "Create a GatewayAdvertisedRoute", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/spokes/{spokesId}/gatewayAdvertisedRoutes", + "httpMethod": "POST", + "id": "networkconnectivity.projects.locations.spokes.gatewayAdvertisedRoutes.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "gatewayAdvertisedRouteId": { + "description": "Required. Unique id for the route to create.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/spokes/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/gatewayAdvertisedRoutes", + "request": { + "$ref": "GatewayAdvertisedRoute" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete a GatewayAdvertisedRoute", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/spokes/{spokesId}/gatewayAdvertisedRoutes/{gatewayAdvertisedRoutesId}", + "httpMethod": "DELETE", + "id": "networkconnectivity.projects.locations.spokes.gatewayAdvertisedRoutes.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the gateway advertised route to delete.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/spokes/[^/]+/gatewayAdvertisedRoutes/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get a GatewayAdvertisedRoute", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/spokes/{spokesId}/gatewayAdvertisedRoutes/{gatewayAdvertisedRoutesId}", + "httpMethod": "GET", + "id": "networkconnectivity.projects.locations.spokes.gatewayAdvertisedRoutes.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the gateway advertised route to get.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/spokes/[^/]+/gatewayAdvertisedRoutes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GatewayAdvertisedRoute" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List GatewayAdvertisedRoutes", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/spokes/{spokesId}/gatewayAdvertisedRoutes", + "httpMethod": "GET", + "id": "networkconnectivity.projects.locations.spokes.gatewayAdvertisedRoutes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "An expression that filters the list of results.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Sort the results by a certain order.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results per page that should be returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListGatewayAdvertisedRoutes` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGatewayAdvertisedRoutes` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/spokes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/gatewayAdvertisedRoutes", + "response": { + "$ref": "ListGatewayAdvertisedRoutesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update a GatewayAdvertisedRoute", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/spokes/{spokesId}/gatewayAdvertisedRoutes/{gatewayAdvertisedRoutesId}", + "httpMethod": "PATCH", + "id": "networkconnectivity.projects.locations.spokes.gatewayAdvertisedRoutes.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The name of the gateway advertised route. Route names must be unique and use the following form: `projects/{project_number}/locations/{region}/spokes/{spoke}/gatewayAdvertisedRoutes/{gateway_advertised_route_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/spokes/[^/]+/gatewayAdvertisedRoutes/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Optional. In the case of an update to an existing group, field mask is used to specify the fields to be overwritten. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not provide a mask, then all fields are overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GatewayAdvertisedRoute" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } } }, "transports": { @@ -3714,7 +3898,7 @@ } } }, - "revision": "20260422", + "revision": "20260514", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AcceptHubSpokeRequest": { @@ -4538,6 +4722,136 @@ }, "type": "object" }, + "Gateway": { + "description": "A gateway that can apply specialized traffic processing.", + "id": "Gateway", + "properties": { + "capacity": { + "description": "Optional. The aggregate processing capacity of this gateway.", + "enum": [ + "GATEWAY_CAPACITY_UNSPECIFIED", + "CAPACITY_1_GBPS", + "CAPACITY_10_GBPS" + ], + "enumDescriptions": [ + "The gateway capacity is unspecified.", + "The gateway has 1 Gbps of aggregate processing capacity", + "The gateway has 10 Gbps of aggregate processing capacity" + ], + "type": "string" + }, + "cloudRouters": { + "description": "Output only. The list of Cloud Routers that are connected to this gateway. Should be in the form: https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/routers/{router}", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "ipRangeReservations": { + "description": "Optional. A list of IP ranges that are reserved for this gateway's internal intfrastructure.", + "items": { + "$ref": "IpRangeReservation" + }, + "type": "array" + }, + "sacAttachment": { + "description": "Output only. The URI of the connected SACAttachment. Should be in the form: projects/{project}/locations/{location}/sacAttachments/{sac_attachment}", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GatewayAdvertisedRoute": { + "description": "A gateway advertised route is a route that a gateway spoke advertises somewhere.", + "id": "GatewayAdvertisedRoute", + "properties": { + "createTime": { + "description": "Output only. The time the gateway advertised route was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "An optional description of the gateway advertised route.", + "type": "string" + }, + "ipRange": { + "description": "Immutable. This route's advertised IP address range. Must be a valid CIDR-formatted prefix. If an IP address is provided without a subnet mask, it is interpreted as, for IPv4, a `/32` singular IP address range, and, for IPv6, `/128`.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional labels in key-value pair format. For more information about labels, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements).", + "type": "object" + }, + "name": { + "description": "Identifier. The name of the gateway advertised route. Route names must be unique and use the following form: `projects/{project_number}/locations/{region}/spokes/{spoke}/gatewayAdvertisedRoutes/{gateway_advertised_route_id}`", + "type": "string" + }, + "priority": { + "description": "Optional. The priority of this advertised route. You can choose a value from `0` to `65335`. If you don't provide a value, Google Cloud assigns a priority of `100` to the ranges.", + "format": "int32", + "type": "integer" + }, + "recipient": { + "description": "Optional. The recipient of this advertised route.", + "enum": [ + "RECIPIENT_UNSPECIFIED", + "ADVERTISE_TO_HUB" + ], + "enumDescriptions": [ + "No recipient specified. By default routes are advertised to the hub.", + "Advertises a route toward the hub. Other spokes reachable from this spoke will receive the route." + ], + "type": "string" + }, + "state": { + "description": "Output only. The current lifecycle state of this gateway advertised route.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "DELETING", + "ACCEPTING", + "REJECTING", + "UPDATING", + "INACTIVE", + "OBSOLETE", + "FAILED" + ], + "enumDescriptions": [ + "No state information available", + "The resource's create operation is in progress.", + "The resource is active", + "The resource's delete operation is in progress.", + "The resource's accept operation is in progress.", + "The resource's reject operation is in progress.", + "The resource's update operation is in progress.", + "The resource is inactive.", + "The hub associated with this spoke resource has been deleted. This state applies to spoke resources only.", + "The resource is in an undefined state due to resource creation or deletion failure. You can try to delete the resource later or contact support for help." + ], + "readOnly": true, + "type": "string" + }, + "uniqueId": { + "description": "Output only. The Google-generated UUID for the gateway advertised route. This value is unique across all gateway advertised route resources. If a gateway advertised route is deleted and another with the same name is created, the new route is assigned a different `unique_id`.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time the gateway advertised route was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleLongrunningCancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "GoogleLongrunningCancelOperationRequest", @@ -4776,12 +5090,14 @@ "enum": [ "PRESET_TOPOLOGY_UNSPECIFIED", "MESH", - "STAR" + "STAR", + "HYBRID_INSPECTION" ], "enumDescriptions": [ "Preset topology is unspecified. When policy_mode = PRESET, it defaults to MESH.", "Mesh topology is implemented. Group `default` is automatically created. All spokes in the hub are added to group `default`.", - "Star topology is implemented. Two groups, `center` and `edge`, are automatically created along with hub creation. Spokes have to join one of the groups during creation." + "Star topology is implemented. Two groups, `center` and `edge`, are automatically created along with hub creation. Spokes have to join one of the groups during creation.", + "Hybrid inspection has 4 groups ('non-prod', 'prod', 'services', and 'untrusted') that are automatically created along with hub creation." ], "type": "string" }, @@ -5010,6 +5326,17 @@ }, "type": "object" }, + "IpRangeReservation": { + "description": "A list of IP ranges that are reserved for this gateway's internal intfrastructure.", + "id": "IpRangeReservation", + "properties": { + "ipRange": { + "description": "Required. A block of IP addresses used to allocate supporting infrastructure for this gateway. This block must not overlap with subnets in any spokes or peer VPC networks that the gateway can communicate with. Example: \"10.1.2.0/24\"", + "type": "string" + } + }, + "type": "object" + }, "LinkedInterconnectAttachments": { "description": "A collection of VLAN attachment resources. These resources should be redundant attachments that all advertise the same prefixes to Google Cloud. Alternatively, in active/passive configurations, all attachments should be capable of advertising the same prefixes.", "id": "LinkedInterconnectAttachments", @@ -5316,6 +5643,31 @@ }, "type": "object" }, + "ListGatewayAdvertisedRoutesResponse": { + "description": "Response for HubService.ListGatewayAdvertisedRoutes method.", + "id": "ListGatewayAdvertisedRoutesResponse", + "properties": { + "gatewayAdvertisedRoutes": { + "description": "The requested gateway advertised routes.", + "items": { + "$ref": "GatewayAdvertisedRoute" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The token for the next page of the response. To see more results, use this value as the page_token for your next request. If this value is empty, there are no more results.", + "type": "string" + }, + "unreachable": { + "description": "Hubs that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ListGroupsResponse": { "description": "Response for HubService.ListGroups method.", "id": "ListGroupsResponse", @@ -7198,6 +7550,10 @@ }, "type": "array" }, + "gateway": { + "$ref": "Gateway", + "description": "Optional. This is a gateway that can apply specialized processing to traffic going through it." + }, "group": { "description": "Optional. The name of the group that this spoke is associated with.", "type": "string" @@ -7253,6 +7609,7 @@ "INTERCONNECT_ATTACHMENT", "ROUTER_APPLIANCE", "VPC_NETWORK", + "GATEWAY", "PRODUCER_VPC_NETWORK" ], "enumDescriptions": [ @@ -7261,6 +7618,7 @@ "Spokes associated with VLAN attachments.", "Spokes associated with router appliance instances.", "Spokes associated with VPC networks.", + "Spokes that are NCC gateways.", "Spokes that are backed by a producer VPC network." ], "readOnly": true, @@ -7438,6 +7796,7 @@ "INTERCONNECT_ATTACHMENT", "ROUTER_APPLIANCE", "VPC_NETWORK", + "GATEWAY", "PRODUCER_VPC_NETWORK" ], "enumDescriptions": [ @@ -7446,6 +7805,7 @@ "Spokes associated with VLAN attachments.", "Spokes associated with router appliance instances.", "Spokes associated with VPC networks.", + "Spokes that are NCC gateways.", "Spokes that are backed by a producer VPC network." ], "readOnly": true, diff --git a/discovery/networkmanagement-v1.json b/discovery/networkmanagement-v1.json index 6beedf19a45..4db1904870f 100644 --- a/discovery/networkmanagement-v1.json +++ b/discovery/networkmanagement-v1.json @@ -1237,7 +1237,7 @@ } } }, - "revision": "20260424", + "revision": "20260506", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -1853,6 +1853,7 @@ "FORWARDING_RULE_MISMATCH", "FORWARDING_RULE_NO_INSTANCES", "FIREWALL_BLOCKING_LOAD_BALANCER_BACKEND_HEALTH_CHECK", + "FIREWALL_BLOCKING_LOAD_BALANCER_ENVOY_PROXY_HEALTH_CHECK", "INGRESS_FIREWALL_TAGS_UNSUPPORTED_BY_DIRECT_VPC_EGRESS", "INSTANCE_NOT_RUNNING", "GKE_CLUSTER_NOT_RUNNING", @@ -1961,6 +1962,7 @@ "Forwarding rule's protocol and ports do not match the packet header.", "Forwarding rule does not have backends configured.", "Firewalls block the health check probes to the backends and cause the backends to be unavailable for traffic from the load balancer. For more details, see [Health check firewall rules](https://cloud.google.com/load-balancing/docs/health-checks#firewall_rules).", + "Firewalls block health check probes to the Envoy proxies that power this load balancer.", "Matching ingress firewall rules by network tags for packets sent via serverless VPC direct egress is unsupported. Behavior is undefined. https://cloud.google.com/run/docs/configuring/vpc-direct-vpc#limitations", "Packet is sent from or to a Compute Engine instance that is not in a running state.", "Packet sent from or to a GKE cluster that is not in running state.", diff --git a/discovery/networkmanagement-v1beta1.json b/discovery/networkmanagement-v1beta1.json index 6b35f50b0be..97ad3a11103 100644 --- a/discovery/networkmanagement-v1beta1.json +++ b/discovery/networkmanagement-v1beta1.json @@ -1237,7 +1237,7 @@ } } }, - "revision": "20260424", + "revision": "20260506", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -1853,6 +1853,7 @@ "FORWARDING_RULE_MISMATCH", "FORWARDING_RULE_NO_INSTANCES", "FIREWALL_BLOCKING_LOAD_BALANCER_BACKEND_HEALTH_CHECK", + "FIREWALL_BLOCKING_LOAD_BALANCER_ENVOY_PROXY_HEALTH_CHECK", "INGRESS_FIREWALL_TAGS_UNSUPPORTED_BY_DIRECT_VPC_EGRESS", "INSTANCE_NOT_RUNNING", "GKE_CLUSTER_NOT_RUNNING", @@ -1961,6 +1962,7 @@ "Forwarding rule's protocol and ports do not match the packet header.", "Forwarding rule does not have backends configured.", "Firewalls block the health check probes to the backends and cause the backends to be unavailable for traffic from the load balancer. For more details, see [Health check firewall rules](https://cloud.google.com/load-balancing/docs/health-checks#firewall_rules).", + "Firewalls block health check probes to the Envoy proxies that power this load balancer.", "Matching ingress firewall rules by network tags for packets sent via serverless VPC direct egress is unsupported. Behavior is undefined. https://cloud.google.com/run/docs/configuring/vpc-direct-vpc#limitations", "Packet is sent from or to a Compute Engine instance that is not in a running state.", "Packet sent from or to a GKE cluster that is not in running state.", @@ -2230,6 +2232,10 @@ "$ref": "CloudFunctionEndpoint", "description": "A [Cloud Function](https://cloud.google.com/functions). Applicable only to source endpoint." }, + "cloudRunJob": { + "description": "A [Cloud Run](https://cloud.google.com/run) [job](https://docs.cloud.google.com/run/docs/reference/rest/v2/projects.locations.jobs#Job) URI. Applicable only to source endpoint. The format is: projects/{project}/locations/{location}/jobs/{job}", + "type": "string" + }, "cloudRunRevision": { "$ref": "CloudRunRevisionEndpoint", "description": "A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint." diff --git a/discovery/networkservices-v1beta1.json b/discovery/networkservices-v1beta1.json index 906ea22a01c..125aa0340a3 100644 --- a/discovery/networkservices-v1beta1.json +++ b/discovery/networkservices-v1beta1.json @@ -3277,7 +3277,7 @@ } } }, - "revision": "20260424", + "revision": "20260513", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AgentGateway": { @@ -3458,13 +3458,6 @@ "resourceUri": { "description": "Optional. A supported Google Cloud networking proxy in the Project and Location", "type": "string" - }, - "resourceUris": { - "description": "Optional. List of supported Google Cloud networking proxies in the Project and Location. resource_uris is mutually exclusive with resource_uri.", - "items": { - "type": "string" - }, - "type": "array" } }, "type": "object" @@ -6410,11 +6403,11 @@ "type": "string" }, "kmsKeyName": { - "description": "Optional. The name of the customer managed Cloud KMS key to be used to encrypt the `WasmPlugin` image (provided by image_uri) and configuration (provided by plugin_config_data or plugin_config_uri) that are stored by the `Service Extensions` product at rest. Format: \"projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}\" By default, Google Cloud automatically encrypts all data at rest using Google-owned and Google-managed encryption keys. If you need ownership and control of the keys that protect your data at rest, you can specify a customer-managed encryption key (CMEK) to encrypt your `WasmPlugin` data. For more information, see [Using customer-managed encryption keys](https://cloud.google.com/kms/docs/cmek). ", + "description": "Optional. The name of the customer-managed [CryptoKey](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys) to be used to encrypt the `WasmPlugin` image (provided by image_uri) and configuration (provided by plugin_config_data or plugin_config_uri) that are stored by the `Service Extensions` product at rest. Format: `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}` By default, Google Cloud automatically encrypts all data at rest using Google-owned and Google-managed encryption keys. If you need ownership and control of the keys that protect your data at rest, you can specify a customer-managed encryption key (CMEK) to encrypt your `WasmPlugin` data. For more information, see [Using customer-managed encryption keys](https://cloud.google.com/service-extensions/docs/cmek).", "type": "string" }, "kmsKeyVersion": { - "description": "Output only. The name of the specific CryptoKeyVersion used to encrypt the `WasmPlugin` data, if the kms_key_name field is set. Format: \"projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}\" This is a read-only field. `WasmPlugin` data is automatically encrypted using the most recent `CryptoKeyVersion` of the `CryptoKey` provided in the `kms_key_name` field. See [Cloud KMS resources](https://cloud.google.com/kms/docs/resource-hierarchy) for more information.", + "description": "Output only. The name of the specific [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions) used to encrypt the `WasmPlugin` data, if the kms_key_name field is set. Format: `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}` This is a read-only field. `WasmPlugin` data is automatically encrypted using the most recent `CryptoKeyVersion` of the `CryptoKey` provided in the `kms_key_name` field. See [Cloud KMS resources](https://cloud.google.com/kms/docs/resource-hierarchy) for more information.", "readOnly": true, "type": "string" }, diff --git a/discovery/ondemandscanning-v1.json b/discovery/ondemandscanning-v1.json index eaff1c30200..6ff812609a5 100644 --- a/discovery/ondemandscanning-v1.json +++ b/discovery/ondemandscanning-v1.json @@ -344,7 +344,7 @@ } } }, - "revision": "20260504", + "revision": "20260511", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AISkillAnalysisOccurrence": { @@ -740,6 +740,7 @@ "id": "CVSS", "properties": { "attackComplexity": { + "description": "Attack Complexity (AC). Defined in CVSS v2, v3, v4.", "enum": [ "ATTACK_COMPLEXITY_UNSPECIFIED", "ATTACK_COMPLEXITY_LOW", @@ -747,15 +748,29 @@ "ATTACK_COMPLEXITY_MEDIUM" ], "enumDescriptions": [ - "", - "", - "", - "" + "Unspecified.", + "Low attack complexity (AC:L). Defined in CVSS v2, v3, v4.", + "High attack complexity (AC:H). Defined in CVSS v2, v3, v4.", + "Medium attack complexity (AC:M). Defined in CVSS v2." + ], + "type": "string" + }, + "attackRequirements": { + "description": "Attack Requirements (AT). Defined in CVSS v4.", + "enum": [ + "ATTACK_REQUIREMENTS_UNSPECIFIED", + "ATTACK_REQUIREMENTS_NONE", + "ATTACK_REQUIREMENTS_PRESENT" + ], + "enumDescriptions": [ + "Unspecified.", + "No attack requirements (AT:N). Defined in CVSS v4.", + "Attack requirements: Present (AT:P). Defined in CVSS v4." ], "type": "string" }, "attackVector": { - "description": "Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.", + "description": "Attack Vector (AV). Defined in CVSS v2, v3, v4.", "enum": [ "ATTACK_VECTOR_UNSPECIFIED", "ATTACK_VECTOR_NETWORK", @@ -764,15 +779,16 @@ "ATTACK_VECTOR_PHYSICAL" ], "enumDescriptions": [ - "", - "", - "", - "", - "" + "Unspecified.", + "Attack Vector: Network (AV:N). Defined in CVSS v2, v3, v4.", + "Attack Vector: Adjacent (AV:A). Defined in CVSS v2, v3, v4.", + "Attack Vector: Local (AV:L). Defined in CVSS v2, v3, v4.", + "Attack Vector: Physical (AV:P). Defined in CVSS v3, v4." ], "type": "string" }, "authentication": { + "description": "Authentication (Au). Defined in CVSS v2.", "enum": [ "AUTHENTICATION_UNSPECIFIED", "AUTHENTICATION_MULTIPLE", @@ -780,14 +796,15 @@ "AUTHENTICATION_NONE" ], "enumDescriptions": [ - "", - "", - "", - "" + "Unspecified.", + "Multiple authentication required (Au:M). Defined in CVSS v2.", + "Single authentication required (Au:S). Defined in CVSS v2.", + "No authentication required (Au:N). Defined in CVSS v2." ], "type": "string" }, "availabilityImpact": { + "description": "Availability Impact (A). Defined in CVSS v2, v3.", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", @@ -797,12 +814,12 @@ "IMPACT_COMPLETE" ], "enumDescriptions": [ - "", - "", - "", - "", - "", - "" + "Unspecified.", + "High impact (H). Defined in CVSS v3, v4.", + "Low impact (L). Defined in CVSS v3, v4.", + "No impact (N). Defined in CVSS v2, v3, v4.", + "Partial impact (P). Defined in CVSS v2.", + "Complete impact (C). Defined in CVSS v2." ], "type": "string" }, @@ -812,6 +829,7 @@ "type": "number" }, "confidentialityImpact": { + "description": "Confidentiality Impact (C). Defined in CVSS v2, v3.", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", @@ -821,12 +839,12 @@ "IMPACT_COMPLETE" ], "enumDescriptions": [ - "", - "", - "", - "", - "", - "" + "Unspecified.", + "High impact (H). Defined in CVSS v3, v4.", + "Low impact (L). Defined in CVSS v3, v4.", + "No impact (N). Defined in CVSS v2, v3, v4.", + "Partial impact (P). Defined in CVSS v2.", + "Complete impact (C). Defined in CVSS v2." ], "type": "string" }, @@ -839,6 +857,7 @@ "type": "number" }, "integrityImpact": { + "description": "Integrity Impact (I). Defined in CVSS v2, v3.", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", @@ -848,16 +867,17 @@ "IMPACT_COMPLETE" ], "enumDescriptions": [ - "", - "", - "", - "", - "", - "" + "Unspecified.", + "High impact (H). Defined in CVSS v3, v4.", + "Low impact (L). Defined in CVSS v3, v4.", + "No impact (N). Defined in CVSS v2, v3, v4.", + "Partial impact (P). Defined in CVSS v2.", + "Complete impact (C). Defined in CVSS v2." ], "type": "string" }, "privilegesRequired": { + "description": "Privileges Required (PR). Defined in CVSS v3, v4.", "enum": [ "PRIVILEGES_REQUIRED_UNSPECIFIED", "PRIVILEGES_REQUIRED_NONE", @@ -865,36 +885,162 @@ "PRIVILEGES_REQUIRED_HIGH" ], "enumDescriptions": [ - "", - "", - "", - "" + "Unspecified.", + "No privileges required (PR:N). Defined in CVSS v3, v4.", + "Low privileges required (PR:L). Defined in CVSS v3, v4.", + "High privileges required (PR:H). Defined in CVSS v3, v4." ], "type": "string" }, "scope": { + "description": "Scope (S). Defined in CVSS v3.", "enum": [ "SCOPE_UNSPECIFIED", "SCOPE_UNCHANGED", "SCOPE_CHANGED" ], "enumDescriptions": [ - "", - "", - "" + "Unspecified.", + "Scope: Unchanged (S:U). Defined in CVSS v3.", + "Scope: Changed (S:C). Defined in CVSS v3." + ], + "type": "string" + }, + "subsequentSystemAvailabilityImpact": { + "description": "Subsequent System Availability Impact (SA). Defined in CVSS v4.", + "enum": [ + "IMPACT_UNSPECIFIED", + "IMPACT_HIGH", + "IMPACT_LOW", + "IMPACT_NONE", + "IMPACT_PARTIAL", + "IMPACT_COMPLETE" + ], + "enumDescriptions": [ + "Unspecified.", + "High impact (H). Defined in CVSS v3, v4.", + "Low impact (L). Defined in CVSS v3, v4.", + "No impact (N). Defined in CVSS v2, v3, v4.", + "Partial impact (P). Defined in CVSS v2.", + "Complete impact (C). Defined in CVSS v2." + ], + "type": "string" + }, + "subsequentSystemConfidentialityImpact": { + "description": "Subsequent System Confidentiality Impact (SC). Defined in CVSS v4.", + "enum": [ + "IMPACT_UNSPECIFIED", + "IMPACT_HIGH", + "IMPACT_LOW", + "IMPACT_NONE", + "IMPACT_PARTIAL", + "IMPACT_COMPLETE" + ], + "enumDescriptions": [ + "Unspecified.", + "High impact (H). Defined in CVSS v3, v4.", + "Low impact (L). Defined in CVSS v3, v4.", + "No impact (N). Defined in CVSS v2, v3, v4.", + "Partial impact (P). Defined in CVSS v2.", + "Complete impact (C). Defined in CVSS v2." + ], + "type": "string" + }, + "subsequentSystemIntegrityImpact": { + "description": "Subsequent System Integrity Impact (SI). Defined in CVSS v4.", + "enum": [ + "IMPACT_UNSPECIFIED", + "IMPACT_HIGH", + "IMPACT_LOW", + "IMPACT_NONE", + "IMPACT_PARTIAL", + "IMPACT_COMPLETE" + ], + "enumDescriptions": [ + "Unspecified.", + "High impact (H). Defined in CVSS v3, v4.", + "Low impact (L). Defined in CVSS v3, v4.", + "No impact (N). Defined in CVSS v2, v3, v4.", + "Partial impact (P). Defined in CVSS v2.", + "Complete impact (C). Defined in CVSS v2." ], "type": "string" }, "userInteraction": { + "description": "User Interaction (UI). Defined in CVSS v3, v4.", "enum": [ "USER_INTERACTION_UNSPECIFIED", "USER_INTERACTION_NONE", - "USER_INTERACTION_REQUIRED" + "USER_INTERACTION_REQUIRED", + "USER_INTERACTION_PASSIVE", + "USER_INTERACTION_ACTIVE" ], "enumDescriptions": [ - "", - "", - "" + "Unspecified.", + "No user interaction required (UI:N). Defined in CVSS v3, v4.", + "User interaction required (UI:R). Defined in CVSS v3.", + "Passive user interaction required (UI:P). Defined in CVSS v4.", + "Active user interaction required (UI:A). Defined in CVSS v4." + ], + "type": "string" + }, + "vulnerableSystemAvailabilityImpact": { + "description": "Vulnerable System Availability Impact (VA). Defined in CVSS v4.", + "enum": [ + "IMPACT_UNSPECIFIED", + "IMPACT_HIGH", + "IMPACT_LOW", + "IMPACT_NONE", + "IMPACT_PARTIAL", + "IMPACT_COMPLETE" + ], + "enumDescriptions": [ + "Unspecified.", + "High impact (H). Defined in CVSS v3, v4.", + "Low impact (L). Defined in CVSS v3, v4.", + "No impact (N). Defined in CVSS v2, v3, v4.", + "Partial impact (P). Defined in CVSS v2.", + "Complete impact (C). Defined in CVSS v2." + ], + "type": "string" + }, + "vulnerableSystemConfidentialityImpact": { + "description": "Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4.", + "enum": [ + "IMPACT_UNSPECIFIED", + "IMPACT_HIGH", + "IMPACT_LOW", + "IMPACT_NONE", + "IMPACT_PARTIAL", + "IMPACT_COMPLETE" + ], + "enumDescriptions": [ + "Unspecified.", + "High impact (H). Defined in CVSS v3, v4.", + "Low impact (L). Defined in CVSS v3, v4.", + "No impact (N). Defined in CVSS v2, v3, v4.", + "Partial impact (P). Defined in CVSS v2.", + "Complete impact (C). Defined in CVSS v2." + ], + "type": "string" + }, + "vulnerableSystemIntegrityImpact": { + "description": "Vulnerable System Integrity Impact (VI). Defined in CVSS v4.", + "enum": [ + "IMPACT_UNSPECIFIED", + "IMPACT_HIGH", + "IMPACT_LOW", + "IMPACT_NONE", + "IMPACT_PARTIAL", + "IMPACT_COMPLETE" + ], + "enumDescriptions": [ + "Unspecified.", + "High impact (H). Defined in CVSS v3, v4.", + "Low impact (L). Defined in CVSS v3, v4.", + "No impact (N). Defined in CVSS v2, v3, v4.", + "Partial impact (P). Defined in CVSS v2.", + "Complete impact (C). Defined in CVSS v2." ], "type": "string" } @@ -3267,12 +3413,14 @@ "enum": [ "CVSS_VERSION_UNSPECIFIED", "CVSS_VERSION_2", - "CVSS_VERSION_3" + "CVSS_VERSION_3", + "CVSS_VERSION_4" ], "enumDescriptions": [ - "", - "", - "" + "Unspecified.", + "CVSS v2.", + "CVSS v3.", + "CVSS v4." ], "type": "string" }, diff --git a/discovery/ondemandscanning-v1beta1.json b/discovery/ondemandscanning-v1beta1.json index 26e2b9a673b..00b971f52fd 100644 --- a/discovery/ondemandscanning-v1beta1.json +++ b/discovery/ondemandscanning-v1beta1.json @@ -344,7 +344,7 @@ } } }, - "revision": "20260504", + "revision": "20260511", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AISkillAnalysisOccurrence": { @@ -735,6 +735,7 @@ "id": "CVSS", "properties": { "attackComplexity": { + "description": "Attack Complexity (AC). Defined in CVSS v2, v3, v4.", "enum": [ "ATTACK_COMPLEXITY_UNSPECIFIED", "ATTACK_COMPLEXITY_LOW", @@ -742,15 +743,29 @@ "ATTACK_COMPLEXITY_MEDIUM" ], "enumDescriptions": [ - "", - "", - "", - "" + "Unspecified.", + "Low attack complexity (AC:L). Defined in CVSS v2, v3, v4.", + "High attack complexity (AC:H). Defined in CVSS v2, v3, v4.", + "Medium attack complexity (AC:M). Defined in CVSS v2." + ], + "type": "string" + }, + "attackRequirements": { + "description": "Attack Requirements (AT). Defined in CVSS v4.", + "enum": [ + "ATTACK_REQUIREMENTS_UNSPECIFIED", + "ATTACK_REQUIREMENTS_NONE", + "ATTACK_REQUIREMENTS_PRESENT" + ], + "enumDescriptions": [ + "Unspecified.", + "No attack requirements (AT:N). Defined in CVSS v4.", + "Attack requirements: Present (AT:P). Defined in CVSS v4." ], "type": "string" }, "attackVector": { - "description": "Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.", + "description": "Attack Vector (AV). Defined in CVSS v2, v3, v4.", "enum": [ "ATTACK_VECTOR_UNSPECIFIED", "ATTACK_VECTOR_NETWORK", @@ -759,15 +774,16 @@ "ATTACK_VECTOR_PHYSICAL" ], "enumDescriptions": [ - "", - "", - "", - "", - "" + "Unspecified.", + "Attack Vector: Network (AV:N). Defined in CVSS v2, v3, v4.", + "Attack Vector: Adjacent (AV:A). Defined in CVSS v2, v3, v4.", + "Attack Vector: Local (AV:L). Defined in CVSS v2, v3, v4.", + "Attack Vector: Physical (AV:P). Defined in CVSS v3, v4." ], "type": "string" }, "authentication": { + "description": "Authentication (Au). Defined in CVSS v2.", "enum": [ "AUTHENTICATION_UNSPECIFIED", "AUTHENTICATION_MULTIPLE", @@ -775,14 +791,15 @@ "AUTHENTICATION_NONE" ], "enumDescriptions": [ - "", - "", - "", - "" + "Unspecified.", + "Multiple authentication required (Au:M). Defined in CVSS v2.", + "Single authentication required (Au:S). Defined in CVSS v2.", + "No authentication required (Au:N). Defined in CVSS v2." ], "type": "string" }, "availabilityImpact": { + "description": "Availability Impact (A). Defined in CVSS v2, v3.", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", @@ -792,12 +809,12 @@ "IMPACT_COMPLETE" ], "enumDescriptions": [ - "", - "", - "", - "", - "", - "" + "Unspecified.", + "High impact (H). Defined in CVSS v3, v4.", + "Low impact (L). Defined in CVSS v3, v4.", + "No impact (N). Defined in CVSS v2, v3, v4.", + "Partial impact (P). Defined in CVSS v2.", + "Complete impact (C). Defined in CVSS v2." ], "type": "string" }, @@ -807,6 +824,7 @@ "type": "number" }, "confidentialityImpact": { + "description": "Confidentiality Impact (C). Defined in CVSS v2, v3.", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", @@ -816,12 +834,12 @@ "IMPACT_COMPLETE" ], "enumDescriptions": [ - "", - "", - "", - "", - "", - "" + "Unspecified.", + "High impact (H). Defined in CVSS v3, v4.", + "Low impact (L). Defined in CVSS v3, v4.", + "No impact (N). Defined in CVSS v2, v3, v4.", + "Partial impact (P). Defined in CVSS v2.", + "Complete impact (C). Defined in CVSS v2." ], "type": "string" }, @@ -834,6 +852,7 @@ "type": "number" }, "integrityImpact": { + "description": "Integrity Impact (I). Defined in CVSS v2, v3.", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", @@ -843,16 +862,17 @@ "IMPACT_COMPLETE" ], "enumDescriptions": [ - "", - "", - "", - "", - "", - "" + "Unspecified.", + "High impact (H). Defined in CVSS v3, v4.", + "Low impact (L). Defined in CVSS v3, v4.", + "No impact (N). Defined in CVSS v2, v3, v4.", + "Partial impact (P). Defined in CVSS v2.", + "Complete impact (C). Defined in CVSS v2." ], "type": "string" }, "privilegesRequired": { + "description": "Privileges Required (PR). Defined in CVSS v3, v4.", "enum": [ "PRIVILEGES_REQUIRED_UNSPECIFIED", "PRIVILEGES_REQUIRED_NONE", @@ -860,36 +880,162 @@ "PRIVILEGES_REQUIRED_HIGH" ], "enumDescriptions": [ - "", - "", - "", - "" + "Unspecified.", + "No privileges required (PR:N). Defined in CVSS v3, v4.", + "Low privileges required (PR:L). Defined in CVSS v3, v4.", + "High privileges required (PR:H). Defined in CVSS v3, v4." ], "type": "string" }, "scope": { + "description": "Scope (S). Defined in CVSS v3.", "enum": [ "SCOPE_UNSPECIFIED", "SCOPE_UNCHANGED", "SCOPE_CHANGED" ], "enumDescriptions": [ - "", - "", - "" + "Unspecified.", + "Scope: Unchanged (S:U). Defined in CVSS v3.", + "Scope: Changed (S:C). Defined in CVSS v3." + ], + "type": "string" + }, + "subsequentSystemAvailabilityImpact": { + "description": "Subsequent System Availability Impact (SA). Defined in CVSS v4.", + "enum": [ + "IMPACT_UNSPECIFIED", + "IMPACT_HIGH", + "IMPACT_LOW", + "IMPACT_NONE", + "IMPACT_PARTIAL", + "IMPACT_COMPLETE" + ], + "enumDescriptions": [ + "Unspecified.", + "High impact (H). Defined in CVSS v3, v4.", + "Low impact (L). Defined in CVSS v3, v4.", + "No impact (N). Defined in CVSS v2, v3, v4.", + "Partial impact (P). Defined in CVSS v2.", + "Complete impact (C). Defined in CVSS v2." + ], + "type": "string" + }, + "subsequentSystemConfidentialityImpact": { + "description": "Subsequent System Confidentiality Impact (SC). Defined in CVSS v4.", + "enum": [ + "IMPACT_UNSPECIFIED", + "IMPACT_HIGH", + "IMPACT_LOW", + "IMPACT_NONE", + "IMPACT_PARTIAL", + "IMPACT_COMPLETE" + ], + "enumDescriptions": [ + "Unspecified.", + "High impact (H). Defined in CVSS v3, v4.", + "Low impact (L). Defined in CVSS v3, v4.", + "No impact (N). Defined in CVSS v2, v3, v4.", + "Partial impact (P). Defined in CVSS v2.", + "Complete impact (C). Defined in CVSS v2." + ], + "type": "string" + }, + "subsequentSystemIntegrityImpact": { + "description": "Subsequent System Integrity Impact (SI). Defined in CVSS v4.", + "enum": [ + "IMPACT_UNSPECIFIED", + "IMPACT_HIGH", + "IMPACT_LOW", + "IMPACT_NONE", + "IMPACT_PARTIAL", + "IMPACT_COMPLETE" + ], + "enumDescriptions": [ + "Unspecified.", + "High impact (H). Defined in CVSS v3, v4.", + "Low impact (L). Defined in CVSS v3, v4.", + "No impact (N). Defined in CVSS v2, v3, v4.", + "Partial impact (P). Defined in CVSS v2.", + "Complete impact (C). Defined in CVSS v2." ], "type": "string" }, "userInteraction": { + "description": "User Interaction (UI). Defined in CVSS v3, v4.", "enum": [ "USER_INTERACTION_UNSPECIFIED", "USER_INTERACTION_NONE", - "USER_INTERACTION_REQUIRED" + "USER_INTERACTION_REQUIRED", + "USER_INTERACTION_PASSIVE", + "USER_INTERACTION_ACTIVE" ], "enumDescriptions": [ - "", - "", - "" + "Unspecified.", + "No user interaction required (UI:N). Defined in CVSS v3, v4.", + "User interaction required (UI:R). Defined in CVSS v3.", + "Passive user interaction required (UI:P). Defined in CVSS v4.", + "Active user interaction required (UI:A). Defined in CVSS v4." + ], + "type": "string" + }, + "vulnerableSystemAvailabilityImpact": { + "description": "Vulnerable System Availability Impact (VA). Defined in CVSS v4.", + "enum": [ + "IMPACT_UNSPECIFIED", + "IMPACT_HIGH", + "IMPACT_LOW", + "IMPACT_NONE", + "IMPACT_PARTIAL", + "IMPACT_COMPLETE" + ], + "enumDescriptions": [ + "Unspecified.", + "High impact (H). Defined in CVSS v3, v4.", + "Low impact (L). Defined in CVSS v3, v4.", + "No impact (N). Defined in CVSS v2, v3, v4.", + "Partial impact (P). Defined in CVSS v2.", + "Complete impact (C). Defined in CVSS v2." + ], + "type": "string" + }, + "vulnerableSystemConfidentialityImpact": { + "description": "Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4.", + "enum": [ + "IMPACT_UNSPECIFIED", + "IMPACT_HIGH", + "IMPACT_LOW", + "IMPACT_NONE", + "IMPACT_PARTIAL", + "IMPACT_COMPLETE" + ], + "enumDescriptions": [ + "Unspecified.", + "High impact (H). Defined in CVSS v3, v4.", + "Low impact (L). Defined in CVSS v3, v4.", + "No impact (N). Defined in CVSS v2, v3, v4.", + "Partial impact (P). Defined in CVSS v2.", + "Complete impact (C). Defined in CVSS v2." + ], + "type": "string" + }, + "vulnerableSystemIntegrityImpact": { + "description": "Vulnerable System Integrity Impact (VI). Defined in CVSS v4.", + "enum": [ + "IMPACT_UNSPECIFIED", + "IMPACT_HIGH", + "IMPACT_LOW", + "IMPACT_NONE", + "IMPACT_PARTIAL", + "IMPACT_COMPLETE" + ], + "enumDescriptions": [ + "Unspecified.", + "High impact (H). Defined in CVSS v3, v4.", + "Low impact (L). Defined in CVSS v3, v4.", + "No impact (N). Defined in CVSS v2, v3, v4.", + "Partial impact (P). Defined in CVSS v2.", + "Complete impact (C). Defined in CVSS v2." ], "type": "string" } @@ -3262,12 +3408,14 @@ "enum": [ "CVSS_VERSION_UNSPECIFIED", "CVSS_VERSION_2", - "CVSS_VERSION_3" + "CVSS_VERSION_3", + "CVSS_VERSION_4" ], "enumDescriptions": [ - "", - "", - "" + "Unspecified.", + "CVSS v2.", + "CVSS v3.", + "CVSS v4." ], "type": "string" }, diff --git a/discovery/oracledatabase-v1.json b/discovery/oracledatabase-v1.json index 0a323a2f081..27b9e45ef0e 100644 --- a/discovery/oracledatabase-v1.json +++ b/discovery/oracledatabase-v1.json @@ -2013,38 +2013,38 @@ } } }, - "odbNetworks": { + "goldengateConnectionAssignments": { "methods": { "create": { - "description": "Creates a new ODB Network in a given project and location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks", + "description": "Creates a new GoldengateConnectionAssignment in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateConnectionAssignments", "httpMethod": "POST", - "id": "oracledatabase.projects.locations.odbNetworks.create", + "id": "oracledatabase.projects.locations.goldengateConnectionAssignments.create", "parameterOrder": [ "parent" ], "parameters": { - "odbNetworkId": { - "description": "Required. The ID of the OdbNetwork to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.", + "goldengateConnectionAssignmentId": { + "description": "Required. The ID of the GoldengateConnectionAssignment to create.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent value for the OdbNetwork in the following format: projects/{project}/locations/{location}.", + "description": "Required. The parent resource where this GoldengateConnectionAssignment will be created. Format: projects/{project}/locations/{location}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "requestId": { - "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, - "path": "v1/{+parent}/odbNetworks", + "path": "v1/{+parent}/goldengateConnectionAssignments", "request": { - "$ref": "OdbNetwork" + "$ref": "GoldengateConnectionAssignment" }, "response": { "$ref": "Operation" @@ -2054,23 +2054,23 @@ ] }, "delete": { - "description": "Deletes a single ODB Network.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}", + "description": "Deletes a single GoldengateConnectionAssignment.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateConnectionAssignments/{goldengateConnectionAssignmentsId}", "httpMethod": "DELETE", - "id": "oracledatabase.projects.locations.odbNetworks.delete", + "id": "oracledatabase.projects.locations.goldengateConnectionAssignments.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the resource in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.", + "description": "Required. The name of the GoldengateConnectionAssignment to delete. Format: projects/{project}/locations/{location}/goldengateConnectionAssignments/{goldengate_connection_assignment}", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/goldengateConnectionAssignments/[^/]+$", "required": true, "type": "string" }, "requestId": { - "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -2084,344 +2084,169 @@ ] }, "get": { - "description": "Gets details of a single ODB Network.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}", + "description": "Gets details of a single GoldengateConnectionAssignment.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateConnectionAssignments/{goldengateConnectionAssignmentsId}", "httpMethod": "GET", - "id": "oracledatabase.projects.locations.odbNetworks.get", + "id": "oracledatabase.projects.locations.goldengateConnectionAssignments.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the OdbNetwork in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.", + "description": "Required. The name of the GoldengateConnectionAssignment to retrieve. Format: projects/{project}/locations/{location}/goldengateConnectionAssignments/{goldengate_connection_assignment}", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/goldengateConnectionAssignments/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "OdbNetwork" + "$ref": "GoldengateConnectionAssignment" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists the ODB Networks in a given project and location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks", + "description": "Lists GoldengateConnectionAssignments in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateConnectionAssignments", "httpMethod": "GET", - "id": "oracledatabase.projects.locations.odbNetworks.list", + "id": "oracledatabase.projects.locations.goldengateConnectionAssignments.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { - "description": "Optional. An expression for filtering the results of the request.", + "description": "Optional. A filter expression that filters GoldengateConnectionAssignments listed in the response.", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. An expression for ordering the results of the request.", + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"DESC\" after a field name for descending.", "location": "query", "type": "string" }, "pageSize": { - "description": "Optional. The maximum number of items to return. If unspecified, at most 50 ODB Networks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "description": "Optional. The maximum number of GoldengateConnectionAssignments to return. The service may return fewer than this value. If unspecified, at most 50 GoldengateConnectionAssignments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. A token identifying a page of results the server should return.", + "description": "Optional. A page token, received from a previous `ListGoldengateConnectionAssignments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGoldengateConnectionAssignments` must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent value for the ODB Network in the following format: projects/{project}/locations/{location}.", + "description": "Required. The parent value for the GoldengateConnectionAssignments. Format: projects/{project}/locations/{location}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}/odbNetworks", + "path": "v1/{+parent}/goldengateConnectionAssignments", "response": { - "$ref": "ListOdbNetworksResponse" + "$ref": "ListGoldengateConnectionAssignmentsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - } - }, - "resources": { - "odbSubnets": { - "methods": { - "create": { - "description": "Creates a new ODB Subnet in a given ODB Network.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets", - "httpMethod": "POST", - "id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "odbSubnetId": { - "description": "Required. The ID of the OdbSubnet to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent value for the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$", - "required": true, - "type": "string" - }, - "requestId": { - "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+parent}/odbSubnets", - "request": { - "$ref": "OdbSubnet" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a single ODB Subnet.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets/{odbSubnetsId}", - "httpMethod": "DELETE", - "id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the resource in the following format: projects/{project}/locations/{region}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+/odbSubnets/[^/]+$", - "required": true, - "type": "string" - }, - "requestId": { - "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets details of a single ODB Subnet.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets/{odbSubnetsId}", - "httpMethod": "GET", - "id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+/odbSubnets/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "OdbSubnet" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists all the ODB Subnets in a given ODB Network.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets", - "httpMethod": "GET", - "id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. An expression for filtering the results of the request.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Optional. An expression for ordering the results of the request.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The maximum number of items to return. If unspecified, at most 50 ODB Networks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. A token identifying a page of results the server should return.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent value for the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/odbSubnets", - "response": { - "$ref": "ListOdbSubnetsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - }, - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", + }, + "test": { + "description": "Tests a single GoldengateConnectionAssignment.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateConnectionAssignments/{goldengateConnectionAssignmentsId}:test", "httpMethod": "POST", - "id": "oracledatabase.projects.locations.operations.cancel", + "id": "oracledatabase.projects.locations.goldengateConnectionAssignments.test", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "The name of the operation resource to be cancelled.", + "description": "Required. Name of the connection assignment for which to test connection. projects/{project}/locations/{region}/goldengateConnectionAssignments/{goldengate_connection_assignment}", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/goldengateConnectionAssignments/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+name}:cancel", + "path": "v1/{+name}:test", "request": { - "$ref": "CancelOperationRequest" + "$ref": "TestGoldengateConnectionAssignmentRequest" }, "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "oracledatabase.projects.locations.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "Empty" + "$ref": "TestGoldengateConnectionAssignmentResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, + } + } + }, + "goldengateConnectionTypes": { + "methods": { "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "description": "Gets details of a single GoldengateConnectionType.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateConnectionTypes/{goldengateConnectionTypesId}", "httpMethod": "GET", - "id": "oracledatabase.projects.locations.operations.get", + "id": "oracledatabase.projects.locations.goldengateConnectionTypes.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "The name of the operation resource.", + "description": "Required. Name of the resource in the format: projects/{project}/locations/{location}/goldengateConnectionTypes/{goldengate_connection_type}", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/goldengateConnectionTypes/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "Operation" + "$ref": "GoldengateConnectionType" }, "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}/operations", + "description": "Lists GoldengateConnectionTypes in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateConnectionTypes", "httpMethod": "GET", - "id": "oracledatabase.projects.locations.operations.list", + "id": "oracledatabase.projects.locations.goldengateConnectionTypes.list", "parameterOrder": [ - "name" + "parent" ], "parameters": { "filter": { - "description": "The standard list filter.", + "description": "Optional. An expression for filtering the results of the request. The connection_type field must be specified in the format: `connection_type=\"ORACLE\"`.", "location": "query", "type": "string" }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - }, "pageSize": { - "description": "The standard list page size.", + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The standard list page token.", + "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are 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" + "parent": { + "description": "Required. Parent value for ListGoldengateConnectionTypesRequest Format: projects/{project}/locations/{location}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" } }, - "path": "v1/{+name}/operations", + "path": "v1/{+parent}/goldengateConnectionTypes", "response": { - "$ref": "ListOperationsResponse" + "$ref": "ListGoldengateConnectionTypesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -2429,1884 +2254,5426 @@ } } }, - "pluggableDatabases": { + "goldengateConnections": { "methods": { + "create": { + "description": "Creates a new GoldengateConnection in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateConnections", + "httpMethod": "POST", + "id": "oracledatabase.projects.locations.goldengateConnections.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "goldengateConnectionId": { + "description": "Required. The ID of the GoldengateConnection to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The value for parent of the GoldengateConnection in the following format: projects/{project}/locations/{location}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/goldengateConnections", + "request": { + "$ref": "GoldengateConnection" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single GoldengateConnection.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateConnections/{goldengateConnectionsId}", + "httpMethod": "DELETE", + "id": "oracledatabase.projects.locations.goldengateConnections.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the GoldengateConnection in the following format: projects/{project}/locations/{location}/goldengateConnections/{goldengate_connection}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/goldengateConnections/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { - "description": "Gets details of a single PluggableDatabase.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pluggableDatabases/{pluggableDatabasesId}", + "description": "Gets details of a single GoldengateConnection.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateConnections/{goldengateConnectionsId}", "httpMethod": "GET", - "id": "oracledatabase.projects.locations.pluggableDatabases.get", + "id": "oracledatabase.projects.locations.goldengateConnections.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the PluggableDatabase resource in the following format: projects/{project}/locations/{region}/pluggableDatabases/{pluggable_database}", + "description": "Required. The name of the GoldengateConnection in the following format: projects/{project}/locations/{location}/goldengateConnections/{goldengate_connection}.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/pluggableDatabases/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/goldengateConnections/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "PluggableDatabase" + "$ref": "GoldengateConnection" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists all the PluggableDatabases for the given project, location and Container Database.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pluggableDatabases", + "description": "Lists all the GoldengateConnections for the given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateConnections", "httpMethod": "GET", - "id": "oracledatabase.projects.locations.pluggableDatabases.list", + "id": "oracledatabase.projects.locations.goldengateConnections.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { - "description": "Optional. An expression for filtering the results of the request. List for pluggable databases is supported only with a valid container database (full resource name) filter in this format: `database=\"projects/{project}/locations/{location}/databases/{database}\"`", + "description": "Optional. An expression for filtering the results of the request.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. An expression for ordering the results of the request.", "location": "query", "type": "string" }, "pageSize": { - "description": "Optional. The maximum number of PluggableDatabases to return. The service may return fewer than this value.", + "description": "Optional. The maximum number of items to return. If unspecified, at most 50 GoldengateConnections 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 `ListPluggableDatabases` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPluggableDatabases` must match the call that provided the page token.", + "description": "Optional. A page token, received from a previous ListGoldengateConnections call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent, which owns this collection of PluggableDatabases. Format: projects/{project}/locations/{location}", + "description": "Required. The parent value for GoldengateConnections in the following format: projects/{project}/locations/{location}.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}/pluggableDatabases", + "path": "v1/{+parent}/goldengateConnections", "response": { - "$ref": "ListPluggableDatabasesResponse" + "$ref": "ListGoldengateConnectionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } - } - } - } - } - } - }, - "revision": "20260427", - "rootUrl": "https://oracledatabase.googleapis.com/", - "schemas": { - "AllConnectionStrings": { - "description": "A list of all connection strings that can be used to connect to the Autonomous Database.", - "id": "AllConnectionStrings", - "properties": { - "high": { - "description": "Output only. The database service provides the highest level of resources to each SQL statement.", - "readOnly": true, - "type": "string" - }, - "low": { - "description": "Output only. The database service provides the least level of resources to each SQL statement.", - "readOnly": true, - "type": "string" - }, - "medium": { - "description": "Output only. The database service provides a lower level of resources to each SQL statement.", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "AutonomousDatabase": { - "description": "Details of the Autonomous Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/", - "id": "AutonomousDatabase", - "properties": { - "adminPassword": { - "description": "Optional. Immutable. The password for the default ADMIN user. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated.", - "type": "string" - }, - "adminPasswordSecretVersion": { - "description": "Optional. Immutable. The resource name of a secret version in Secret Manager which contains the database admin user's password. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated.", - "type": "string" - }, - "cidr": { - "description": "Optional. Immutable. The subnet CIDR range for the Autonomous Database.", - "type": "string" - }, - "createTime": { - "description": "Output only. The date and time that the Autonomous Database was created.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "database": { - "description": "Optional. Immutable. The name of the Autonomous Database. The database name must be unique in the project. The name must begin with a letter and can contain a maximum of 30 alphanumeric characters.", - "type": "string" - }, - "disasterRecoverySupportedLocations": { - "description": "Output only. List of supported GCP region to clone the Autonomous Database for disaster recovery. Format: `project/{project}/locations/{location}`.", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" - }, - "displayName": { - "description": "Optional. Immutable. The display name for the Autonomous Database. The name does not have to be unique within your project.", - "type": "string" - }, - "entitlementId": { - "description": "Output only. The ID of the subscription entitlement associated with the Autonomous Database.", - "readOnly": true, - "type": "string" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. The labels or tags associated with the Autonomous Database.", - "type": "object" - }, - "name": { - "description": "Identifier. The name of the Autonomous Database resource in the following format: projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database}", - "type": "string" - }, - "network": { - "description": "Optional. Immutable. The name of the VPC network used by the Autonomous Database in the following format: projects/{project}/global/networks/{network}", - "type": "string" - }, - "odbNetwork": { - "description": "Optional. Immutable. The name of the OdbNetwork associated with the Autonomous Database. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.", - "type": "string" - }, - "odbSubnet": { - "description": "Optional. Immutable. The name of the OdbSubnet associated with the Autonomous Database. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", - "type": "string" - }, - "peerAutonomousDatabases": { - "description": "Output only. The peer Autonomous Database names of the given Autonomous Database.", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" - }, - "properties": { - "$ref": "AutonomousDatabaseProperties", - "description": "Optional. The properties of the Autonomous Database." - }, - "sourceConfig": { - "$ref": "SourceConfig", - "description": "Optional. Immutable. The source Autonomous Database configuration for the standby Autonomous Database. The source Autonomous Database is configured while creating the Peer Autonomous Database and can't be updated after creation." - } - }, - "type": "object" - }, - "AutonomousDatabaseApex": { - "description": "Oracle APEX Application Development. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseApex", - "id": "AutonomousDatabaseApex", - "properties": { - "apexVersion": { - "description": "Output only. The Oracle APEX Application Development version.", - "readOnly": true, - "type": "string" - }, - "ordsVersion": { - "description": "Output only. The Oracle REST Data Services (ORDS) version.", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "AutonomousDatabaseBackup": { - "description": "Details of the Autonomous Database Backup resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseBackup/", - "id": "AutonomousDatabaseBackup", - "properties": { - "autonomousDatabase": { - "description": "Required. The name of the Autonomous Database resource for which the backup is being created. Format: projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database}", - "type": "string" - }, - "displayName": { - "description": "Optional. User friendly name for the Backup. The name does not have to be unique.", - "type": "string" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. labels or tags associated with the resource.", - "type": "object" - }, - "name": { - "description": "Identifier. The name of the Autonomous Database Backup resource with the format: projects/{project}/locations/{region}/autonomousDatabaseBackups/{autonomous_database_backup}", - "type": "string" - }, - "properties": { - "$ref": "AutonomousDatabaseBackupProperties", - "description": "Optional. Various properties of the backup." - } - }, - "type": "object" - }, - "AutonomousDatabaseBackupProperties": { - "description": "Properties of the Autonomous Database Backup resource.", - "id": "AutonomousDatabaseBackupProperties", - "properties": { - "availableTillTime": { - "description": "Output only. Timestamp until when the backup will be available.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "compartmentId": { - "description": "Output only. The OCID of the compartment.", - "readOnly": true, - "type": "string" - }, - "databaseSizeTb": { - "description": "Output only. The quantity of data in the database, in terabytes.", + }, + "goldengateDeploymentEnvironments": { + "methods": { + "get": { + "description": "Gets details of a single GoldengateDeploymentEnvironment.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateDeploymentEnvironments/{goldengateDeploymentEnvironmentsId}", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.goldengateDeploymentEnvironments.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource with the format: projects/{project}/locations/{location}/goldengateDeploymentEnvironments/{goldengate_deployment_environment}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/goldengateDeploymentEnvironments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoldengateDeploymentEnvironment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists GoldengateDeploymentEnvironments in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateDeploymentEnvironments", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.goldengateDeploymentEnvironments.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of items to return. If unspecified, at most 50 deployment environments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent, which owns this collection of GoldengateDeploymentEnvironments. Format: projects/{project}/locations/{location}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/goldengateDeploymentEnvironments", + "response": { + "$ref": "ListGoldengateDeploymentEnvironmentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "goldengateDeploymentTypes": { + "methods": { + "get": { + "description": "Gets details of a single GoldenGateDeploymentType.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateDeploymentTypes/{goldengateDeploymentTypesId}", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.goldengateDeploymentTypes.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the GoldengateDeploymentType to retrieve. Format: projects/{project}/locations/{location}/goldengateDeploymentTypes/{goldengate_deployment_type}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/goldengateDeploymentTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoldengateDeploymentType" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists GoldenGateDeploymentTypes in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateDeploymentTypes", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.goldengateDeploymentTypes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression for filtering the results of the request. Either the deployment_type and ogg_version fields must be specified in the format: `deployment_type=\"DATABASE_ORACLE\"` or `ogg_version=\"version\"`. Allowed values for deployment_type are: `DATABASE_ORACLE`, `BIGDATA`, `DATABASE_MICROSOFT_SQLSERVER`, `DATABASE_MYSQL`, `DATABASE_POSTGRESQL`, `DATABASE_DB2ZOS`, `DATABASE_DB2I`, `GGSA`, `DATA_TRANSFORMS`.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource. Format: projects/{project}/locations/{location}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/goldengateDeploymentTypes", + "response": { + "$ref": "ListGoldengateDeploymentTypesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "goldengateDeploymentVersions": { + "methods": { + "get": { + "description": "Gets details of a single GoldengateDeploymentVersion.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateDeploymentVersions/{goldengateDeploymentVersionsId}", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.goldengateDeploymentVersions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the GoldengateDeploymentVersion to retrieve. Format: projects/{project}/locations/{location}/goldengateDeploymentVersions/{goldengate_deployment_version}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/goldengateDeploymentVersions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoldengateDeploymentVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists GoldengateDeploymentVersions in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateDeploymentVersions", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.goldengateDeploymentVersions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression for filtering the results of the request. Either the deployment_id and deployment_type fields must be specified in the format: `deployment_id=\"id\"` or `deployment_type=\"DATABASE_ORACLE\"`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent value for ListGoldengateDeploymentVersionsRequest Format: projects/{project}/locations/{location}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/goldengateDeploymentVersions", + "response": { + "$ref": "ListGoldengateDeploymentVersionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "goldengateDeployments": { + "methods": { + "create": { + "description": "Creates a new GoldengateDeployment in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateDeployments", + "httpMethod": "POST", + "id": "oracledatabase.projects.locations.goldengateDeployments.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "goldengateDeploymentId": { + "description": "Required. The ID of the GoldengateDeployment to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The value for parent of the GoldengateDeployment in the following format: projects/{project}/locations/{location}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/goldengateDeployments", + "request": { + "$ref": "GoldengateDeployment" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single GoldengateDeployment.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateDeployments/{goldengateDeploymentsId}", + "httpMethod": "DELETE", + "id": "oracledatabase.projects.locations.goldengateDeployments.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the GoldengateDeployment in the following format: projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/goldengateDeployments/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single GoldengateDeployment.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateDeployments/{goldengateDeploymentsId}", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.goldengateDeployments.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the GoldengateDeployment in the following format: projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/goldengateDeployments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoldengateDeployment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all the GoldengateDeployments for the given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateDeployments", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.goldengateDeployments.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression for filtering the results of the request.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. An expression for ordering the results of the request.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of items to return. If unspecified, at most 50 GoldengateDeployments 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 ListGoldengateDeployments call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent value for GoldengateDeployments in the following format: projects/{project}/locations/{location}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/goldengateDeployments", + "response": { + "$ref": "ListGoldengateDeploymentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "start": { + "description": "Starts a single GoldengateDeployment.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateDeployments/{goldengateDeploymentsId}:start", + "httpMethod": "POST", + "id": "oracledatabase.projects.locations.goldengateDeployments.start", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Goldengate Deployment in the following format: projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/goldengateDeployments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:start", + "request": { + "$ref": "StartGoldengateDeploymentRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "stop": { + "description": "Stops a single GoldengateDeployment.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateDeployments/{goldengateDeploymentsId}:stop", + "httpMethod": "POST", + "id": "oracledatabase.projects.locations.goldengateDeployments.stop", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Goldengate Deployment in the following format: projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/goldengateDeployments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:stop", + "request": { + "$ref": "StopGoldengateDeploymentRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "odbNetworks": { + "methods": { + "create": { + "description": "Creates a new ODB Network in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks", + "httpMethod": "POST", + "id": "oracledatabase.projects.locations.odbNetworks.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "odbNetworkId": { + "description": "Required. The ID of the OdbNetwork to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent value for the OdbNetwork in the following format: projects/{project}/locations/{location}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/odbNetworks", + "request": { + "$ref": "OdbNetwork" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single ODB Network.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}", + "httpMethod": "DELETE", + "id": "oracledatabase.projects.locations.odbNetworks.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the resource in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single ODB Network.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.odbNetworks.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the OdbNetwork in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "OdbNetwork" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists the ODB Networks in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.odbNetworks.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression for filtering the results of the request.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. An expression for ordering the results of the request.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of items to return. If unspecified, at most 50 ODB Networks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent value for the ODB Network in the following format: projects/{project}/locations/{location}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/odbNetworks", + "response": { + "$ref": "ListOdbNetworksResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "odbSubnets": { + "methods": { + "create": { + "description": "Creates a new ODB Subnet in a given ODB Network.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets", + "httpMethod": "POST", + "id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "odbSubnetId": { + "description": "Required. The ID of the OdbSubnet to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent value for the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/odbSubnets", + "request": { + "$ref": "OdbSubnet" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single ODB Subnet.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets/{odbSubnetsId}", + "httpMethod": "DELETE", + "id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the resource in the following format: projects/{project}/locations/{region}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+/odbSubnets/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single ODB Subnet.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets/{odbSubnetsId}", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+/odbSubnets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "OdbSubnet" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all the ODB Subnets in a given ODB Network.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression for filtering the results of the request.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. An expression for ordering the results of the request.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of items to return. If unspecified, at most 50 ODB Networks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent value for the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/odbSubnets", + "response": { + "$ref": "ListOdbSubnetsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "oracledatabase.projects.locations.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "CancelOperationRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "oracledatabase.projects.locations.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. 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": "ListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "pluggableDatabases": { + "methods": { + "get": { + "description": "Gets details of a single PluggableDatabase.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pluggableDatabases/{pluggableDatabasesId}", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.pluggableDatabases.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the PluggableDatabase resource in the following format: projects/{project}/locations/{region}/pluggableDatabases/{pluggable_database}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/pluggableDatabases/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "PluggableDatabase" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all the PluggableDatabases for the given project, location and Container Database.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pluggableDatabases", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.pluggableDatabases.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression for filtering the results of the request. List for pluggable databases is supported only with a valid container database (full resource name) filter in this format: `database=\"projects/{project}/locations/{location}/databases/{database}\"`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of PluggableDatabases to return. The service may return fewer than this value.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListPluggableDatabases` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPluggableDatabases` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent, which owns this collection of PluggableDatabases. Format: projects/{project}/locations/{location}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/pluggableDatabases", + "response": { + "$ref": "ListPluggableDatabasesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + }, + "revision": "20260512", + "rootUrl": "https://oracledatabase.googleapis.com/", + "schemas": { + "AllConnectionStrings": { + "description": "A list of all connection strings that can be used to connect to the Autonomous Database.", + "id": "AllConnectionStrings", + "properties": { + "high": { + "description": "Output only. The database service provides the highest level of resources to each SQL statement.", + "readOnly": true, + "type": "string" + }, + "low": { + "description": "Output only. The database service provides the least level of resources to each SQL statement.", + "readOnly": true, + "type": "string" + }, + "medium": { + "description": "Output only. The database service provides a lower level of resources to each SQL statement.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AmazonS3IcebergStorage": { + "description": "The Amazon S3 Iceberg storage.", + "id": "AmazonS3IcebergStorage", + "properties": { + "accessKeyId": { + "description": "Required. The access key ID of Amazon S3.", + "type": "string" + }, + "bucket": { + "description": "Required. The bucket of Amazon S3.", + "type": "string" + }, + "endpoint": { + "description": "Optional. The endpoint of Amazon S3.", + "type": "string" + }, + "region": { + "description": "Required. The region of Amazon S3.", + "type": "string" + }, + "schemeType": { + "description": "Required. The scheme type of Amazon S3.", + "enum": [ + "SCHEME_TYPE_UNSPECIFIED", + "S3", + "S3A" + ], + "enumDescriptions": [ + "Scheme type not specified.", + "S3 scheme.", + "S3A scheme." + ], + "type": "string" + }, + "secretAccessKeySecret": { + "description": "Optional. The secret access key of Amazon S3.", + "type": "string" + } + }, + "type": "object" + }, + "AutonomousDatabase": { + "description": "Details of the Autonomous Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/", + "id": "AutonomousDatabase", + "properties": { + "adminPassword": { + "description": "Optional. Immutable. The password for the default ADMIN user. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated.", + "type": "string" + }, + "adminPasswordSecretVersion": { + "description": "Optional. Immutable. The resource name of a secret version in Secret Manager which contains the database admin user's password. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated.", + "type": "string" + }, + "cidr": { + "description": "Optional. Immutable. The subnet CIDR range for the Autonomous Database.", + "type": "string" + }, + "createTime": { + "description": "Output only. The date and time that the Autonomous Database was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "database": { + "description": "Optional. Immutable. The name of the Autonomous Database. The database name must be unique in the project. The name must begin with a letter and can contain a maximum of 30 alphanumeric characters.", + "type": "string" + }, + "disasterRecoverySupportedLocations": { + "description": "Output only. List of supported GCP region to clone the Autonomous Database for disaster recovery. Format: `project/{project}/locations/{location}`.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "displayName": { + "description": "Optional. Immutable. The display name for the Autonomous Database. The name does not have to be unique within your project.", + "type": "string" + }, + "entitlementId": { + "description": "Output only. The ID of the subscription entitlement associated with the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The labels or tags associated with the Autonomous Database.", + "type": "object" + }, + "name": { + "description": "Identifier. The name of the Autonomous Database resource in the following format: projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database}", + "type": "string" + }, + "network": { + "description": "Optional. Immutable. The name of the VPC network used by the Autonomous Database in the following format: projects/{project}/global/networks/{network}", + "type": "string" + }, + "odbNetwork": { + "description": "Optional. Immutable. The name of the OdbNetwork associated with the Autonomous Database. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.", + "type": "string" + }, + "odbSubnet": { + "description": "Optional. Immutable. The name of the OdbSubnet associated with the Autonomous Database. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", + "type": "string" + }, + "peerAutonomousDatabases": { + "description": "Output only. The peer Autonomous Database names of the given Autonomous Database.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "properties": { + "$ref": "AutonomousDatabaseProperties", + "description": "Optional. The properties of the Autonomous Database." + }, + "sourceConfig": { + "$ref": "SourceConfig", + "description": "Optional. Immutable. The source Autonomous Database configuration for the standby Autonomous Database. The source Autonomous Database is configured while creating the Peer Autonomous Database and can't be updated after creation." + } + }, + "type": "object" + }, + "AutonomousDatabaseApex": { + "description": "Oracle APEX Application Development. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseApex", + "id": "AutonomousDatabaseApex", + "properties": { + "apexVersion": { + "description": "Output only. The Oracle APEX Application Development version.", + "readOnly": true, + "type": "string" + }, + "ordsVersion": { + "description": "Output only. The Oracle REST Data Services (ORDS) version.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AutonomousDatabaseBackup": { + "description": "Details of the Autonomous Database Backup resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseBackup/", + "id": "AutonomousDatabaseBackup", + "properties": { + "autonomousDatabase": { + "description": "Required. The name of the Autonomous Database resource for which the backup is being created. Format: projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database}", + "type": "string" + }, + "displayName": { + "description": "Optional. User friendly name for the Backup. The name does not have to be unique.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. labels or tags associated with the resource.", + "type": "object" + }, + "name": { + "description": "Identifier. The name of the Autonomous Database Backup resource with the format: projects/{project}/locations/{region}/autonomousDatabaseBackups/{autonomous_database_backup}", + "type": "string" + }, + "properties": { + "$ref": "AutonomousDatabaseBackupProperties", + "description": "Optional. Various properties of the backup." + } + }, + "type": "object" + }, + "AutonomousDatabaseBackupProperties": { + "description": "Properties of the Autonomous Database Backup resource.", + "id": "AutonomousDatabaseBackupProperties", + "properties": { + "availableTillTime": { + "description": "Output only. Timestamp until when the backup will be available.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "compartmentId": { + "description": "Output only. The OCID of the compartment.", + "readOnly": true, + "type": "string" + }, + "databaseSizeTb": { + "description": "Output only. The quantity of data in the database, in terabytes.", + "format": "float", + "readOnly": true, + "type": "number" + }, + "dbVersion": { + "description": "Output only. A valid Oracle Database version for Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. The date and time the backup completed.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "isAutomaticBackup": { + "description": "Output only. Indicates if the backup is automatic or user initiated.", + "readOnly": true, + "type": "boolean" + }, + "isLongTermBackup": { + "description": "Output only. Indicates if the backup is long term backup.", + "readOnly": true, + "type": "boolean" + }, + "isRestorable": { + "description": "Output only. Indicates if the backup can be used to restore the Autonomous Database.", + "readOnly": true, + "type": "boolean" + }, + "keyStoreId": { + "description": "Optional. The OCID of the key store of Oracle Vault.", + "type": "string" + }, + "keyStoreWallet": { + "description": "Optional. The wallet name for Oracle Key Vault.", + "type": "string" + }, + "kmsKeyId": { + "description": "Optional. The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.", + "type": "string" + }, + "kmsKeyVersionId": { + "description": "Optional. The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.", + "type": "string" + }, + "lifecycleDetails": { + "description": "Output only. Additional information about the current lifecycle state.", + "readOnly": true, + "type": "string" + }, + "lifecycleState": { + "description": "Output only. The lifecycle state of the backup.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "DELETING", + "DELETED", + "FAILED", + "UPDATING" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Indicates that the resource is in creating state.", + "Indicates that the resource is in active state.", + "Indicates that the resource is in deleting state.", + "Indicates that the resource is in deleted state.", + "Indicates that the resource is in failed state.", + "Indicates that the resource is in updating state." + ], + "readOnly": true, + "type": "string" + }, + "ocid": { + "description": "Output only. OCID of the Autonomous Database backup. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle", + "readOnly": true, + "type": "string" + }, + "retentionPeriodDays": { + "description": "Optional. Retention period in days for the backup.", + "format": "int32", + "type": "integer" + }, + "sizeTb": { + "description": "Output only. The backup size in terabytes.", + "format": "float", + "readOnly": true, + "type": "number" + }, + "startTime": { + "description": "Output only. The date and time the backup started.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Output only. The type of the backup.", + "enum": [ + "TYPE_UNSPECIFIED", + "INCREMENTAL", + "FULL", + "LONG_TERM" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Incremental backups.", + "Full backups.", + "Long term backups." + ], + "readOnly": true, + "type": "string" + }, + "vaultId": { + "description": "Optional. The OCID of the vault.", + "type": "string" + } + }, + "type": "object" + }, + "AutonomousDatabaseCharacterSet": { + "description": "Details of the Autonomous Database character set resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/", + "id": "AutonomousDatabaseCharacterSet", + "properties": { + "characterSet": { + "description": "Output only. The character set name for the Autonomous Database which is the ID in the resource name.", + "readOnly": true, + "type": "string" + }, + "characterSetType": { + "description": "Output only. The character set type for the Autonomous Database.", + "enum": [ + "CHARACTER_SET_TYPE_UNSPECIFIED", + "DATABASE", + "NATIONAL" + ], + "enumDescriptions": [ + "Character set type is not specified.", + "Character set type is set to database.", + "Character set type is set to national." + ], + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The name of the Autonomous Database Character Set resource in the following format: projects/{project}/locations/{region}/autonomousDatabaseCharacterSets/{autonomous_database_character_set}", + "type": "string" + } + }, + "type": "object" + }, + "AutonomousDatabaseConnectionStrings": { + "description": "The connection string used to connect to the Autonomous Database. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionStrings", + "id": "AutonomousDatabaseConnectionStrings", + "properties": { + "allConnectionStrings": { + "$ref": "AllConnectionStrings", + "description": "Output only. Returns all connection strings that can be used to connect to the Autonomous Database.", + "readOnly": true + }, + "dedicated": { + "description": "Output only. The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.", + "readOnly": true, + "type": "string" + }, + "high": { + "description": "Output only. The database service provides the highest level of resources to each SQL statement.", + "readOnly": true, + "type": "string" + }, + "low": { + "description": "Output only. The database service provides the least level of resources to each SQL statement.", + "readOnly": true, + "type": "string" + }, + "medium": { + "description": "Output only. The database service provides a lower level of resources to each SQL statement.", + "readOnly": true, + "type": "string" + }, + "profiles": { + "description": "Output only. A list of connection string profiles to allow clients to group, filter, and select values based on the structured metadata.", + "items": { + "$ref": "DatabaseConnectionStringProfile" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "AutonomousDatabaseConnectionUrls": { + "description": "The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionUrls", + "id": "AutonomousDatabaseConnectionUrls", + "properties": { + "apexUri": { + "description": "Output only. Oracle Application Express (APEX) URL.", + "readOnly": true, + "type": "string" + }, + "databaseTransformsUri": { + "description": "Output only. The URL of the Database Transforms for the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "graphStudioUri": { + "description": "Output only. The URL of the Graph Studio for the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "machineLearningNotebookUri": { + "description": "Output only. The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "machineLearningUserManagementUri": { + "description": "Output only. The URL of Machine Learning user management the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "mongoDbUri": { + "description": "Output only. The URL of the MongoDB API for the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "ordsUri": { + "description": "Output only. The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "sqlDevWebUri": { + "description": "Output only. The URL of the Oracle SQL Developer Web for the Autonomous Database.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AutonomousDatabaseProperties": { + "description": "The properties of an Autonomous Database.", + "id": "AutonomousDatabaseProperties", + "properties": { + "actualUsedDataStorageSizeTb": { + "description": "Output only. The amount of storage currently being used for user and system data, in terabytes.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "allocatedStorageSizeTb": { + "description": "Output only. The amount of storage currently allocated for the database tables and billed for, rounded up in terabytes.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "allowlistedIps": { + "description": "Optional. Immutable. The list of allowlisted IP addresses for the Autonomous Database.", + "items": { + "type": "string" + }, + "type": "array" + }, + "apexDetails": { + "$ref": "AutonomousDatabaseApex", + "description": "Output only. The details for the Oracle APEX Application Development.", + "readOnly": true + }, + "arePrimaryAllowlistedIpsUsed": { + "description": "Output only. This field indicates the status of Data Guard and Access control for the Autonomous Database. The field's value is null if Data Guard is disabled or Access Control is disabled. The field's value is TRUE if both Data Guard and Access Control are enabled, and the Autonomous Database is using primary IP access control list (ACL) for standby. The field's value is FALSE if both Data Guard and Access Control are enabled, and the Autonomous Database is using a different IP access control list (ACL) for standby compared to primary.", + "readOnly": true, + "type": "boolean" + }, + "autonomousContainerDatabaseId": { + "description": "Output only. The Autonomous Container Database OCID.", + "readOnly": true, + "type": "string" + }, + "availableUpgradeVersions": { + "description": "Output only. The list of available Oracle Database upgrade versions for an Autonomous Database.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "backupRetentionPeriodDays": { + "description": "Optional. Immutable. The retention period for the Autonomous Database. This field is specified in days, can range from 1 day to 60 days, and has a default value of 60 days.", + "format": "int32", + "type": "integer" + }, + "characterSet": { + "description": "Optional. Immutable. The character set for the Autonomous Database. The default is AL32UTF8.", + "type": "string" + }, + "computeCount": { + "description": "Optional. Immutable. The number of compute servers for the Autonomous Database.", + "format": "float", + "type": "number" + }, + "connectionStrings": { + "$ref": "AutonomousDatabaseConnectionStrings", + "description": "Output only. The connection strings used to connect to an Autonomous Database.", + "readOnly": true + }, + "connectionUrls": { + "$ref": "AutonomousDatabaseConnectionUrls", + "description": "Output only. The Oracle Connection URLs for an Autonomous Database.", + "readOnly": true + }, + "cpuCoreCount": { + "description": "Optional. Immutable. The number of CPU cores to be made available to the database.", + "format": "int32", + "type": "integer" + }, + "customerContacts": { + "description": "Optional. Immutable. The list of customer contacts.", + "items": { + "$ref": "CustomerContact" + }, + "type": "array" + }, + "dataGuardRoleChangedTime": { + "description": "Output only. The date and time the Autonomous Data Guard role was changed for the standby Autonomous Database.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "dataSafeState": { + "description": "Output only. The current state of the Data Safe registration for the Autonomous Database.", + "enum": [ + "DATA_SAFE_STATE_UNSPECIFIED", + "REGISTERING", + "REGISTERED", + "DEREGISTERING", + "NOT_REGISTERED", + "FAILED" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Registering data safe state.", + "Registered data safe state.", + "Deregistering data safe state.", + "Not registered data safe state.", + "Failed data safe state." + ], + "readOnly": true, + "type": "string" + }, + "dataStorageSizeGb": { + "description": "Optional. Immutable. The size of the data stored in the database, in gigabytes.", + "format": "int32", + "type": "integer" + }, + "dataStorageSizeTb": { + "description": "Optional. Immutable. The size of the data stored in the database, in terabytes.", + "format": "int32", + "type": "integer" + }, + "databaseManagementState": { + "description": "Output only. The current state of database management for the Autonomous Database.", + "enum": [ + "DATABASE_MANAGEMENT_STATE_UNSPECIFIED", + "ENABLING", + "ENABLED", + "DISABLING", + "NOT_ENABLED", + "FAILED_ENABLING", + "FAILED_DISABLING" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Enabling Database Management state", + "Enabled Database Management state", + "Disabling Database Management state", + "Not Enabled Database Management state", + "Failed enabling Database Management state", + "Failed disabling Database Management state" + ], + "readOnly": true, + "type": "string" + }, + "dbEdition": { + "description": "Optional. Immutable. The edition of the Autonomous Databases.", + "enum": [ + "DATABASE_EDITION_UNSPECIFIED", + "STANDARD_EDITION", + "ENTERPRISE_EDITION" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Standard Database Edition", + "Enterprise Database Edition" + ], + "type": "string" + }, + "dbVersion": { + "description": "Optional. Immutable. The Oracle Database version for the Autonomous Database.", + "type": "string" + }, + "dbWorkload": { + "description": "Required. Immutable. The workload type of the Autonomous Database.", + "enum": [ + "DB_WORKLOAD_UNSPECIFIED", + "OLTP", + "DW", + "AJD", + "APEX" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Autonomous Transaction Processing database.", + "Autonomous Data Warehouse database.", + "Autonomous JSON Database.", + "Autonomous Database with the Oracle APEX Application Development workload type." + ], + "type": "string" + }, + "disasterRecoveryRoleChangedTime": { + "description": "Output only. The date and time the Disaster Recovery role was changed for the standby Autonomous Database.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "encryptionKey": { + "$ref": "EncryptionKey", + "description": "Optional. The encryption key used to encrypt the Autonomous Database. Updating this field will add a new entry in the `encryption_key_history_entries` field with the former version." + }, + "encryptionKeyHistoryEntries": { + "description": "Output only. The history of the encryption keys used to encrypt the Autonomous Database.", + "items": { + "$ref": "EncryptionKeyHistoryEntry" + }, + "readOnly": true, + "type": "array" + }, + "failedDataRecoveryDuration": { + "description": "Output only. This field indicates the number of seconds of data loss during a Data Guard failover.", + "format": "google-duration", + "readOnly": true, + "type": "string" + }, + "isAutoScalingEnabled": { + "description": "Optional. Immutable. This field indicates if auto scaling is enabled for the Autonomous Database CPU core count.", + "type": "boolean" + }, + "isLocalDataGuardEnabled": { + "deprecated": true, + "description": "Output only. Deprecated: Please use `local_data_guard_enabled` instead. This field indicates whether the Autonomous Database has local (in-region) Data Guard enabled.", + "readOnly": true, + "type": "boolean" + }, + "isStorageAutoScalingEnabled": { + "description": "Optional. Immutable. This field indicates if auto scaling is enabled for the Autonomous Database storage.", + "type": "boolean" + }, + "licenseType": { + "description": "Required. Immutable. The license type used for the Autonomous Database.", + "enum": [ + "LICENSE_TYPE_UNSPECIFIED", + "LICENSE_INCLUDED", + "BRING_YOUR_OWN_LICENSE" + ], + "enumDescriptions": [ + "Unspecified", + "License included part of offer", + "Bring your own license" + ], + "type": "string" + }, + "lifecycleDetails": { + "description": "Output only. The details of the current lifestyle state of the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "localAdgAutoFailoverMaxDataLossLimit": { + "deprecated": true, + "description": "Output only. Deprecated: Please use `local_adg_auto_failover_max_data_loss_limit_duration` instead. This field indicates the maximum data loss limit for an Autonomous Database, in seconds.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "localAdgAutoFailoverMaxDataLossLimitDuration": { + "description": "Optional. This field indicates the maximum data loss limit for an Autonomous Database, in seconds.", + "format": "int32", + "type": "integer" + }, + "localDataGuardEnabled": { + "description": "Optional. Indicates whether the Autonomous Database has a local (in-region) standby database. Not applicable to cross-region Data Guard or dedicated Exadata infrastructure.", + "type": "boolean" + }, + "localDisasterRecoveryType": { + "description": "Output only. This field indicates the local disaster recovery (DR) type of an Autonomous Database.", + "enum": [ + "LOCAL_DISASTER_RECOVERY_TYPE_UNSPECIFIED", + "ADG", + "BACKUP_BASED", + "NOT_AVAILABLE" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Autonomous Data Guard recovery.", + "Backup based recovery.", + "Local disaster recovery is not available." + ], + "readOnly": true, + "type": "string" + }, + "localStandbyDb": { + "$ref": "AutonomousDatabaseStandbySummary", + "description": "Output only. The details of the Autonomous Data Guard standby database.", + "readOnly": true + }, + "maintenanceBeginTime": { + "description": "Output only. The date and time when maintenance will begin.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "maintenanceEndTime": { + "description": "Output only. The date and time when maintenance will end.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "maintenanceScheduleType": { + "description": "Optional. Immutable. The maintenance schedule of the Autonomous Database.", + "enum": [ + "MAINTENANCE_SCHEDULE_TYPE_UNSPECIFIED", + "EARLY", + "REGULAR" + ], + "enumDescriptions": [ + "Default unspecified value.", + "An EARLY maintenance schedule patches the database before the regular scheduled maintenance.", + "A REGULAR maintenance schedule follows the normal maintenance cycle." + ], + "type": "string" + }, + "memoryPerOracleComputeUnitGbs": { + "description": "Output only. The amount of memory enabled per ECPU, in gigabytes.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "memoryTableGbs": { + "description": "Output only. The memory assigned to in-memory tables in an Autonomous Database.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "mtlsConnectionRequired": { + "description": "Optional. Immutable. This field specifies if the Autonomous Database requires mTLS connections.", + "type": "boolean" + }, + "nCharacterSet": { + "description": "Optional. Immutable. The national character set for the Autonomous Database. The default is AL16UTF16.", + "type": "string" + }, + "nextLongTermBackupTime": { + "description": "Output only. The long term backup schedule of the Autonomous Database.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "ociUrl": { + "description": "Output only. The Oracle Cloud Infrastructure link for the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "ocid": { + "description": "Output only. OCID of the Autonomous Database. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle", + "readOnly": true, + "type": "string" + }, + "openMode": { + "description": "Output only. This field indicates the current mode of the Autonomous Database.", + "enum": [ + "OPEN_MODE_UNSPECIFIED", + "READ_ONLY", + "READ_WRITE" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Read Only Mode", + "Read Write Mode" + ], + "readOnly": true, + "type": "string" + }, + "operationsInsightsState": { + "description": "Output only. This field indicates the state of Operations Insights for the Autonomous Database.", + "enum": [ + "OPERATIONS_INSIGHTS_STATE_UNSPECIFIED", + "ENABLING", + "ENABLED", + "DISABLING", + "NOT_ENABLED", + "FAILED_ENABLING", + "FAILED_DISABLING" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Enabling status for operation insights.", + "Enabled status for operation insights.", + "Disabling status for operation insights.", + "Not Enabled status for operation insights.", + "Failed enabling status for operation insights.", + "Failed disabling status for operation insights." + ], + "readOnly": true, + "type": "string" + }, + "peerDbIds": { + "description": "Output only. The list of OCIDs of standby databases located in Autonomous Data Guard remote regions that are associated with the source database.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "permissionLevel": { + "description": "Output only. The permission level of the Autonomous Database.", + "enum": [ + "PERMISSION_LEVEL_UNSPECIFIED", + "RESTRICTED", + "UNRESTRICTED" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Restricted mode allows access only by admin users.", + "Normal access." + ], + "readOnly": true, + "type": "string" + }, + "privateEndpoint": { + "description": "Output only. The private endpoint for the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "privateEndpointIp": { + "description": "Optional. Immutable. The private endpoint IP address for the Autonomous Database.", + "type": "string" + }, + "privateEndpointLabel": { + "description": "Optional. Immutable. The private endpoint label for the Autonomous Database.", + "type": "string" + }, + "refreshableMode": { + "description": "Output only. The refresh mode of the cloned Autonomous Database.", + "enum": [ + "REFRESHABLE_MODE_UNSPECIFIED", + "AUTOMATIC", + "MANUAL" + ], + "enumDescriptions": [ + "The default unspecified value.", + "AUTOMATIC indicates that the cloned database is automatically refreshed with data from the source Autonomous Database.", + "MANUAL indicates that the cloned database is manually refreshed with data from the source Autonomous Database." + ], + "readOnly": true, + "type": "string" + }, + "refreshableState": { + "description": "Output only. The refresh State of the clone.", + "enum": [ + "REFRESHABLE_STATE_UNSPECIFIED", + "REFRESHING", + "NOT_REFRESHING" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Refreshing", + "Not refreshed" + ], + "readOnly": true, + "type": "string" + }, + "role": { + "description": "Output only. The Data Guard role of the Autonomous Database.", + "enum": [ + "ROLE_UNSPECIFIED", + "PRIMARY", + "STANDBY", + "DISABLED_STANDBY", + "BACKUP_COPY", + "SNAPSHOT_STANDBY" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Primary role", + "Standby role", + "Disabled standby role", + "Backup copy role", + "Snapshot standby role" + ], + "readOnly": true, + "type": "string" + }, + "scheduledOperationDetails": { + "description": "Output only. The list and details of the scheduled operations of the Autonomous Database.", + "items": { + "$ref": "ScheduledOperationDetails" + }, + "readOnly": true, + "type": "array" + }, + "secretId": { + "description": "Optional. Immutable. The ID of the Oracle Cloud Infrastructure vault secret.", + "type": "string" + }, + "serviceAgentEmail": { + "description": "Output only. An Oracle-managed Google Cloud service account on which customers can grant roles to access resources in the customer project.", + "readOnly": true, + "type": "string" + }, + "sqlWebDeveloperUrl": { + "description": "Output only. The SQL Web Developer URL for the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The current lifecycle state of the Autonomous Database.", + "enum": [ + "STATE_UNSPECIFIED", + "PROVISIONING", + "AVAILABLE", + "STOPPING", + "STOPPED", + "STARTING", + "TERMINATING", + "TERMINATED", + "UNAVAILABLE", + "RESTORE_IN_PROGRESS", + "RESTORE_FAILED", + "BACKUP_IN_PROGRESS", + "SCALE_IN_PROGRESS", + "AVAILABLE_NEEDS_ATTENTION", + "UPDATING", + "MAINTENANCE_IN_PROGRESS", + "RESTARTING", + "RECREATING", + "ROLE_CHANGE_IN_PROGRESS", + "UPGRADING", + "INACCESSIBLE", + "STANDBY" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Indicates that the Autonomous Database is in provisioning state.", + "Indicates that the Autonomous Database is in available state.", + "Indicates that the Autonomous Database is in stopping state.", + "Indicates that the Autonomous Database is in stopped state.", + "Indicates that the Autonomous Database is in starting state.", + "Indicates that the Autonomous Database is in terminating state.", + "Indicates that the Autonomous Database is in terminated state.", + "Indicates that the Autonomous Database is in unavailable state.", + "Indicates that the Autonomous Database restore is in progress.", + "Indicates that the Autonomous Database failed to restore.", + "Indicates that the Autonomous Database backup is in progress.", + "Indicates that the Autonomous Database scale is in progress.", + "Indicates that the Autonomous Database is available but needs attention state.", + "Indicates that the Autonomous Database is in updating state.", + "Indicates that the Autonomous Database's maintenance is in progress state.", + "Indicates that the Autonomous Database is in restarting state.", + "Indicates that the Autonomous Database is in recreating state.", + "Indicates that the Autonomous Database's role change is in progress state.", + "Indicates that the Autonomous Database is in upgrading state.", + "Indicates that the Autonomous Database is in inaccessible state.", + "Indicates that the Autonomous Database is in standby state." + ], + "readOnly": true, + "type": "string" + }, + "supportedCloneRegions": { + "description": "Output only. The list of available regions that can be used to create a clone for the Autonomous Database.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "totalAutoBackupStorageSizeGbs": { + "description": "Output only. The storage space used by automatic backups of Autonomous Database, in gigabytes.", + "format": "float", + "readOnly": true, + "type": "number" + }, + "usedDataStorageSizeTbs": { + "description": "Output only. The storage space used by Autonomous Database, in gigabytes.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "vaultId": { + "description": "Optional. Immutable. The ID of the Oracle Cloud Infrastructure vault.", + "type": "string" + } + }, + "type": "object" + }, + "AutonomousDatabaseStandbySummary": { + "description": "Autonomous Data Guard standby database details. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseStandbySummary", + "id": "AutonomousDatabaseStandbySummary", + "properties": { + "dataGuardRoleChangedTime": { + "description": "Output only. The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "disasterRecoveryRoleChangedTime": { + "description": "Output only. The date and time the Disaster Recovery role was switched for the standby Autonomous Database.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "lagTimeDuration": { + "description": "Output only. The amount of time, in seconds, that the data of the standby database lags in comparison to the data of the primary database.", + "format": "google-duration", + "readOnly": true, + "type": "string" + }, + "lifecycleDetails": { + "description": "Output only. The additional details about the current lifecycle state of the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The current lifecycle state of the Autonomous Database.", + "enum": [ + "STATE_UNSPECIFIED", + "PROVISIONING", + "AVAILABLE", + "STOPPING", + "STOPPED", + "STARTING", + "TERMINATING", + "TERMINATED", + "UNAVAILABLE", + "RESTORE_IN_PROGRESS", + "RESTORE_FAILED", + "BACKUP_IN_PROGRESS", + "SCALE_IN_PROGRESS", + "AVAILABLE_NEEDS_ATTENTION", + "UPDATING", + "MAINTENANCE_IN_PROGRESS", + "RESTARTING", + "RECREATING", + "ROLE_CHANGE_IN_PROGRESS", + "UPGRADING", + "INACCESSIBLE", + "STANDBY" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Indicates that the Autonomous Database is in provisioning state.", + "Indicates that the Autonomous Database is in available state.", + "Indicates that the Autonomous Database is in stopping state.", + "Indicates that the Autonomous Database is in stopped state.", + "Indicates that the Autonomous Database is in starting state.", + "Indicates that the Autonomous Database is in terminating state.", + "Indicates that the Autonomous Database is in terminated state.", + "Indicates that the Autonomous Database is in unavailable state.", + "Indicates that the Autonomous Database restore is in progress.", + "Indicates that the Autonomous Database failed to restore.", + "Indicates that the Autonomous Database backup is in progress.", + "Indicates that the Autonomous Database scale is in progress.", + "Indicates that the Autonomous Database is available but needs attention state.", + "Indicates that the Autonomous Database is in updating state.", + "Indicates that the Autonomous Database's maintenance is in progress state.", + "Indicates that the Autonomous Database is in restarting state.", + "Indicates that the Autonomous Database is in recreating state.", + "Indicates that the Autonomous Database's role change is in progress state.", + "Indicates that the Autonomous Database is in upgrading state.", + "Indicates that the Autonomous Database is in inaccessible state.", + "Indicates that the Autonomous Database is in standby state." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AutonomousDbVersion": { + "description": "Details of the Autonomous Database version. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDbVersionSummary/", + "id": "AutonomousDbVersion", + "properties": { + "dbWorkload": { + "description": "Output only. The Autonomous Database workload type.", + "enum": [ + "DB_WORKLOAD_UNSPECIFIED", + "OLTP", + "DW", + "AJD", + "APEX" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Autonomous Transaction Processing database.", + "Autonomous Data Warehouse database.", + "Autonomous JSON Database.", + "Autonomous Database with the Oracle APEX Application Development workload type." + ], + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The name of the Autonomous Database Version resource with the format: projects/{project}/locations/{region}/autonomousDbVersions/{autonomous_db_version}", + "type": "string" + }, + "version": { + "description": "Output only. An Oracle Database version for Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "workloadUri": { + "description": "Output only. A URL that points to a detailed description of the Autonomous Database version.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AzureDataLakeStorageIcebergStorage": { + "description": "The Azure Data Lake Storage Iceberg storage.", + "id": "AzureDataLakeStorageIcebergStorage", + "properties": { + "accountKeySecret": { + "description": "Optional. The account key of Azure Data Lake Storage.", + "type": "string" + }, + "azureAccount": { + "description": "Required. The account of Azure Data Lake Storage.", + "type": "string" + }, + "container": { + "description": "Required. The container of Azure Data Lake Storage.", + "type": "string" + }, + "endpoint": { + "description": "Optional. The endpoint of Azure Data Lake Storage.", + "type": "string" + } + }, + "type": "object" + }, + "BackupDestinationDetails": { + "description": "The details of the database backup destination.", + "id": "BackupDestinationDetails", + "properties": { + "type": { + "description": "Optional. The type of the database backup destination.", + "enum": [ + "BACKUP_DESTINATION_TYPE_UNSPECIFIED", + "NFS", + "RECOVERY_APPLIANCE", + "OBJECT_STORE", + "LOCAL", + "DBRS" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Backup destination type is NFS.", + "Backup destination type is Recovery Appliance.", + "Backup destination type is Object Store.", + "Backup destination type is Local.", + "Backup destination type is DBRS." + ], + "type": "string" + } + }, + "type": "object" + }, + "CancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "id": "CancelOperationRequest", + "properties": {}, + "type": "object" + }, + "CloudAccountDetails": { + "description": "Details of the OCI Cloud Account.", + "id": "CloudAccountDetails", + "properties": { + "accountCreationUri": { + "description": "Output only. URL to create a new account and link.", + "readOnly": true, + "type": "string" + }, + "cloudAccount": { + "description": "Output only. OCI account name.", + "readOnly": true, + "type": "string" + }, + "cloudAccountHomeRegion": { + "description": "Output only. OCI account home region.", + "readOnly": true, + "type": "string" + }, + "linkExistingAccountUri": { + "description": "Output only. URL to link an existing account.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "CloudExadataInfrastructure": { + "description": "Represents CloudExadataInfrastructure resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudExadataInfrastructure/", + "id": "CloudExadataInfrastructure", + "properties": { + "createTime": { + "description": "Output only. The date and time that the Exadata Infrastructure was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. User friendly name for this resource.", + "type": "string" + }, + "entitlementId": { + "description": "Output only. Entitlement ID of the private offer against which this infrastructure resource is provisioned.", + "readOnly": true, + "type": "string" + }, + "gcpOracleZone": { + "description": "Optional. The GCP Oracle zone where Oracle Exadata Infrastructure is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels or tags associated with the resource.", + "type": "object" + }, + "name": { + "description": "Identifier. The name of the Exadata Infrastructure resource with the format: projects/{project}/locations/{region}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}", + "type": "string" + }, + "properties": { + "$ref": "CloudExadataInfrastructureProperties", + "description": "Optional. Various properties of the infra." + } + }, + "type": "object" + }, + "CloudExadataInfrastructureProperties": { + "description": "Various properties of Exadata Infrastructure.", + "id": "CloudExadataInfrastructureProperties", + "properties": { + "activatedStorageCount": { + "description": "Output only. The requested number of additional storage servers activated for the Exadata Infrastructure.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "additionalStorageCount": { + "description": "Output only. The requested number of additional storage servers for the Exadata Infrastructure.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "availableStorageSizeGb": { + "description": "Output only. The available storage can be allocated to the Exadata Infrastructure resource, in gigabytes (GB).", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "computeCount": { + "description": "Optional. The number of compute servers for the Exadata Infrastructure.", + "format": "int32", + "type": "integer" + }, + "computeModel": { + "description": "Output only. The compute model of the Exadata Infrastructure.", + "enum": [ + "COMPUTE_MODEL_UNSPECIFIED", + "COMPUTE_MODEL_ECPU", + "COMPUTE_MODEL_OCPU" + ], + "enumDescriptions": [ + "Unspecified compute model.", + "Abstract measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers.", + "Physical measure of compute resources. OCPUs are based on the physical core of a processor." + ], + "readOnly": true, + "type": "string" + }, + "cpuCount": { + "description": "Output only. The number of enabled CPU cores.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "customerContacts": { + "description": "Optional. The list of customer contacts.", + "items": { + "$ref": "CustomerContact" + }, + "type": "array" + }, + "dataStorageSizeTb": { + "description": "Output only. Size, in terabytes, of the DATA disk group.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "databaseServerType": { + "description": "Output only. The database server type of the Exadata Infrastructure.", + "readOnly": true, + "type": "string" + }, + "dbNodeStorageSizeGb": { + "description": "Output only. The local node storage allocated in GBs.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "dbServerVersion": { + "description": "Output only. The software version of the database servers (dom0) in the Exadata Infrastructure.", + "readOnly": true, + "type": "string" + }, + "maintenanceWindow": { + "$ref": "MaintenanceWindow", + "description": "Optional. Maintenance window for repair." + }, + "maxCpuCount": { + "description": "Output only. The total number of CPU cores available.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "maxDataStorageTb": { + "description": "Output only. The total available DATA disk group size.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "maxDbNodeStorageSizeGb": { + "description": "Output only. The total local node storage available in GBs.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "maxMemoryGb": { + "description": "Output only. The total memory available in GBs.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "memorySizeGb": { + "description": "Output only. The memory allocated in GBs.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "monthlyDbServerVersion": { + "description": "Output only. The monthly software version of the database servers (dom0) in the Exadata Infrastructure. Example: 20.1.15", + "readOnly": true, + "type": "string" + }, + "monthlyStorageServerVersion": { + "description": "Output only. The monthly software version of the storage servers (cells) in the Exadata Infrastructure. Example: 20.1.15", + "readOnly": true, + "type": "string" + }, + "nextMaintenanceRunId": { + "description": "Output only. The OCID of the next maintenance run.", + "readOnly": true, + "type": "string" + }, + "nextMaintenanceRunTime": { + "description": "Output only. The time when the next maintenance run will occur.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "nextSecurityMaintenanceRunTime": { + "description": "Output only. The time when the next security maintenance run will occur.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "ociUrl": { + "description": "Output only. Deep link to the OCI console to view this resource.", + "readOnly": true, + "type": "string" + }, + "ocid": { + "description": "Output only. OCID of created infra. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle", + "readOnly": true, + "type": "string" + }, + "shape": { + "description": "Required. The shape of the Exadata Infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance.", + "type": "string" + }, + "state": { + "description": "Output only. The current lifecycle state of the Exadata Infrastructure.", + "enum": [ + "STATE_UNSPECIFIED", + "PROVISIONING", + "AVAILABLE", + "UPDATING", + "TERMINATING", + "TERMINATED", + "FAILED", + "MAINTENANCE_IN_PROGRESS" + ], + "enumDescriptions": [ + "Default unspecified value.", + "The Exadata Infrastructure is being provisioned.", + "The Exadata Infrastructure is available for use.", + "The Exadata Infrastructure is being updated.", + "The Exadata Infrastructure is being terminated.", + "The Exadata Infrastructure is terminated.", + "The Exadata Infrastructure is in failed state.", + "The Exadata Infrastructure is in maintenance." + ], + "readOnly": true, + "type": "string" + }, + "storageCount": { + "description": "Optional. The number of Cloud Exadata storage servers for the Exadata Infrastructure.", + "format": "int32", + "type": "integer" + }, + "storageServerType": { + "description": "Output only. The storage server type of the Exadata Infrastructure.", + "readOnly": true, + "type": "string" + }, + "storageServerVersion": { + "description": "Output only. The software version of the storage servers (cells) in the Exadata Infrastructure.", + "readOnly": true, + "type": "string" + }, + "totalStorageSizeGb": { + "description": "Optional. The total storage allocated to the Exadata Infrastructure resource, in gigabytes (GB).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CloudVmCluster": { + "description": "Details of the Cloud VM Cluster resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudVmCluster/", + "id": "CloudVmCluster", + "properties": { + "backupOdbSubnet": { + "description": "Optional. The name of the backup OdbSubnet associated with the VM Cluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", + "type": "string" + }, + "backupSubnetCidr": { + "description": "Optional. CIDR range of the backup subnet.", + "type": "string" + }, + "cidr": { + "description": "Optional. Network settings. CIDR to use for cluster IP allocation.", + "type": "string" + }, + "createTime": { + "description": "Output only. The date and time that the VM cluster was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. User friendly name for this resource.", + "type": "string" + }, + "exadataInfrastructure": { + "description": "Required. The name of the Exadata Infrastructure resource on which VM cluster resource is created, in the following format: projects/{project}/locations/{region}/cloudExadataInfrastuctures/{cloud_extradata_infrastructure}", + "type": "string" + }, + "gcpOracleZone": { + "description": "Output only. The GCP Oracle zone where Oracle CloudVmCluster is hosted. This will be the same as the gcp_oracle_zone of the CloudExadataInfrastructure. Example: us-east4-b-r2.", + "readOnly": true, + "type": "string" + }, + "identityConnector": { + "$ref": "IdentityConnector", + "description": "Output only. The identity connector details which will allow OCI to securely access the resources in the customer project.", + "readOnly": true + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels or tags associated with the VM Cluster.", + "type": "object" + }, + "name": { + "description": "Identifier. The name of the VM Cluster resource with the format: projects/{project}/locations/{region}/cloudVmClusters/{cloud_vm_cluster}", + "type": "string" + }, + "network": { + "description": "Optional. The name of the VPC network. Format: projects/{project}/global/networks/{network}", + "type": "string" + }, + "odbNetwork": { + "description": "Optional. The name of the OdbNetwork associated with the VM Cluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the odb_subnet and backup_odb_subnet.", + "type": "string" + }, + "odbSubnet": { + "description": "Optional. The name of the OdbSubnet associated with the VM Cluster for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", + "type": "string" + }, + "properties": { + "$ref": "CloudVmClusterProperties", + "description": "Optional. Various properties of the VM Cluster." + } + }, + "type": "object" + }, + "CloudVmClusterProperties": { + "description": "Various properties and settings associated with Exadata VM cluster.", + "id": "CloudVmClusterProperties", + "properties": { + "clusterName": { + "description": "Optional. OCI Cluster name.", + "type": "string" + }, + "compartmentId": { + "description": "Output only. Compartment ID of cluster.", + "readOnly": true, + "type": "string" + }, + "computeModel": { + "description": "Output only. The compute model of the VM Cluster.", + "enum": [ + "COMPUTE_MODEL_UNSPECIFIED", + "COMPUTE_MODEL_ECPU", + "COMPUTE_MODEL_OCPU" + ], + "enumDescriptions": [ + "Unspecified compute model.", + "Abstract measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers.", + "Physical measure of compute resources. OCPUs are based on the physical core of a processor." + ], + "readOnly": true, + "type": "string" + }, + "cpuCoreCount": { + "description": "Required. Number of enabled CPU cores.", + "format": "int32", + "type": "integer" + }, + "dataStorageSizeTb": { + "description": "Optional. The data disk group size to be allocated in TBs.", + "format": "double", + "type": "number" + }, + "dbNodeStorageSizeGb": { + "description": "Optional. Local storage per VM.", + "format": "int32", + "type": "integer" + }, + "dbServerOcids": { + "description": "Optional. OCID of database servers.", + "items": { + "type": "string" + }, + "type": "array" + }, + "diagnosticsDataCollectionOptions": { + "$ref": "DataCollectionOptions", + "description": "Optional. Data collection options for diagnostics." + }, + "diskRedundancy": { + "description": "Optional. The type of redundancy.", + "enum": [ + "DISK_REDUNDANCY_UNSPECIFIED", + "HIGH", + "NORMAL" + ], + "enumDescriptions": [ + "Unspecified.", + "High - 3 way mirror.", + "Normal - 2 way mirror." + ], + "type": "string" + }, + "dnsListenerIp": { + "description": "Output only. DNS listener IP.", + "readOnly": true, + "type": "string" + }, + "domain": { + "description": "Output only. Parent DNS domain where SCAN DNS and hosts names are qualified. ex: ocispdelegated.ocisp10jvnet.oraclevcn.com", + "readOnly": true, + "type": "string" + }, + "giVersion": { + "description": "Optional. Grid Infrastructure Version.", + "type": "string" + }, + "hostname": { + "description": "Output only. host name without domain. format: \"-\" with some suffix. ex: sp2-yi0xq where \"sp2\" is the hostname_prefix.", + "readOnly": true, + "type": "string" + }, + "hostnamePrefix": { + "description": "Optional. Prefix for VM cluster host names.", + "type": "string" + }, + "licenseType": { + "description": "Required. License type of VM Cluster.", + "enum": [ + "LICENSE_TYPE_UNSPECIFIED", + "LICENSE_INCLUDED", + "BRING_YOUR_OWN_LICENSE" + ], + "enumDescriptions": [ + "Unspecified", + "License included part of offer", + "Bring your own license" + ], + "type": "string" + }, + "localBackupEnabled": { + "description": "Optional. Use local backup.", + "type": "boolean" + }, + "memorySizeGb": { + "description": "Optional. Memory allocated in GBs.", + "format": "int32", + "type": "integer" + }, + "nodeCount": { + "description": "Optional. Number of database servers.", + "format": "int32", + "type": "integer" + }, + "ociUrl": { + "description": "Output only. Deep link to the OCI console to view this resource.", + "readOnly": true, + "type": "string" + }, + "ocid": { + "description": "Output only. Oracle Cloud Infrastructure ID of VM Cluster.", + "readOnly": true, + "type": "string" + }, + "ocpuCount": { + "description": "Optional. OCPU count per VM. Minimum is 0.1.", "format": "float", + "type": "number" + }, + "scanDns": { + "description": "Output only. SCAN DNS name. ex: sp2-yi0xq-scan.ocispdelegated.ocisp10jvnet.oraclevcn.com", + "readOnly": true, + "type": "string" + }, + "scanDnsRecordId": { + "description": "Output only. OCID of scan DNS record.", + "readOnly": true, + "type": "string" + }, + "scanIpIds": { + "description": "Output only. OCIDs of scan IPs.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "scanListenerPortTcp": { + "description": "Output only. SCAN listener port - TCP", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "scanListenerPortTcpSsl": { + "description": "Output only. SCAN listener port - TLS", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "shape": { + "description": "Output only. Shape of VM Cluster.", + "readOnly": true, + "type": "string" + }, + "sparseDiskgroupEnabled": { + "description": "Optional. Use exadata sparse snapshots.", + "type": "boolean" + }, + "sshPublicKeys": { + "description": "Optional. SSH public keys to be stored with cluster.", + "items": { + "type": "string" + }, + "type": "array" + }, + "state": { + "description": "Output only. State of the cluster.", + "enum": [ + "STATE_UNSPECIFIED", + "PROVISIONING", + "AVAILABLE", + "UPDATING", + "TERMINATING", + "TERMINATED", + "FAILED", + "MAINTENANCE_IN_PROGRESS" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Indicates that the resource is in provisioning state.", + "Indicates that the resource is in available state.", + "Indicates that the resource is in updating state.", + "Indicates that the resource is in terminating state.", + "Indicates that the resource is in terminated state.", + "Indicates that the resource is in failed state.", + "Indicates that the resource is in maintenance in progress state." + ], + "readOnly": true, + "type": "string" + }, + "storageSizeGb": { + "description": "Output only. The storage allocation for the disk group, in gigabytes (GB).", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "systemVersion": { + "description": "Optional. Operating system version of the image.", + "type": "string" + }, + "timeZone": { + "$ref": "TimeZone", + "description": "Optional. Time zone of VM Cluster to set. Defaults to UTC if not specified." + } + }, + "type": "object" + }, + "CustomerContact": { + "description": "The CustomerContact reference as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/CustomerContact", + "id": "CustomerContact", + "properties": { + "email": { + "description": "Required. The email address used by Oracle to send notifications regarding databases and infrastructure.", + "type": "string" + } + }, + "type": "object" + }, + "DataCollectionOptions": { + "description": "Data collection options for diagnostics.", + "id": "DataCollectionOptions", + "properties": { + "diagnosticsEventsEnabled": { + "description": "Optional. Indicates whether diagnostic collection is enabled for the VM cluster", + "type": "boolean" + }, + "healthMonitoringEnabled": { + "description": "Optional. Indicates whether health monitoring is enabled for the VM cluster", + "type": "boolean" + }, + "incidentLogsEnabled": { + "description": "Optional. Indicates whether incident logs and trace collection are enabled for the VM cluster", + "type": "boolean" + } + }, + "type": "object" + }, + "DataCollectionOptionsCommon": { + "description": "Data collection options for diagnostics. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DataCollectionOptions", + "id": "DataCollectionOptionsCommon", + "properties": { + "isDiagnosticsEventsEnabled": { + "description": "Optional. Indicates whether to enable data collection for diagnostics.", + "type": "boolean" + }, + "isHealthMonitoringEnabled": { + "description": "Optional. Indicates whether to enable health monitoring.", + "type": "boolean" + }, + "isIncidentLogsEnabled": { + "description": "Optional. Indicates whether to enable incident logs and trace collection.", + "type": "boolean" + } + }, + "type": "object" + }, + "DataCollectionOptionsDbSystem": { + "description": "Data collection options for DbSystem.", + "id": "DataCollectionOptionsDbSystem", + "properties": { + "isDiagnosticsEventsEnabled": { + "description": "Optional. Indicates whether to enable data collection for diagnostics.", + "type": "boolean" + }, + "isIncidentLogsEnabled": { + "description": "Optional. Indicates whether to enable incident logs and trace collection.", + "type": "boolean" + } + }, + "type": "object" + }, + "Database": { + "description": "Details of the Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/Database/", + "id": "Database", + "properties": { + "adminPassword": { + "description": "Optional. The password for the default ADMIN user. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated.", + "type": "string" + }, + "adminPasswordSecretVersion": { + "description": "Optional. The resource name of a secret version in Secret Manager which contains the database admin user's password. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated.", + "type": "string" + }, + "characterSet": { + "description": "Optional. The character set for the database. The default is AL32UTF8.", + "type": "string" + }, + "createTime": { + "description": "Output only. The date and time that the Database was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "databaseId": { + "description": "Optional. The database ID of the Database.", + "type": "string" + }, + "dbHomeName": { + "description": "Optional. The name of the DbHome resource associated with the Database.", + "type": "string" + }, + "dbName": { + "description": "Optional. The database name. The name must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.", + "type": "string" + }, + "dbUniqueName": { + "description": "Optional. The DB_UNIQUE_NAME of the Oracle Database being backed up.", + "type": "string" + }, + "gcpOracleZone": { + "description": "Output only. The GCP Oracle zone where the Database is created.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The name of the Database resource in the following format: projects/{project}/locations/{region}/databases/{database}", + "type": "string" + }, + "ncharacterSet": { + "description": "Optional. The national character set for the database. The default is AL16UTF16.", + "type": "string" + }, + "ociUrl": { + "description": "Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.", + "readOnly": true, + "type": "string" + }, + "opsInsightsStatus": { + "description": "Output only. The Status of Operations Insights for this Database.", + "enum": [ + "OPERATIONS_INSIGHTS_STATUS_UNSPECIFIED", + "ENABLING", + "ENABLED", + "DISABLING", + "NOT_ENABLED", + "FAILED_ENABLING", + "FAILED_DISABLING" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Indicates that the operations insights are being enabled.", + "Indicates that the operations insights are enabled.", + "Indicates that the operations insights are being disabled.", + "Indicates that the operations insights are not enabled.", + "Indicates that the operations insights failed to enable.", + "Indicates that the operations insights failed to disable." + ], + "readOnly": true, + "type": "string" + }, + "pluggableDatabaseId": { + "description": "Optional. The ID of the pluggable database associated with the Database. The ID must be unique within the project and location.", + "type": "string" + }, + "pluggableDatabaseName": { + "description": "Optional. The pluggable database associated with the Database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters.", + "type": "string" + }, + "properties": { + "$ref": "DatabaseProperties", + "description": "Optional. The properties of the Database." + }, + "tdeWalletPassword": { + "description": "Optional. The TDE wallet password for the database. Note: Only one of `tde_wallet_password_secret_version` or `tde_wallet_password` can be populated.", + "type": "string" + }, + "tdeWalletPasswordSecretVersion": { + "description": "Optional. The resource name of a secret version in Secret Manager which contains the TDE wallet password for the database. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `tde_wallet_password_secret_version` or `tde_wallet_password` can be populated.", + "type": "string" + } + }, + "type": "object" + }, + "DatabaseCharacterSet": { + "description": "Details of the Database character set resource.", + "id": "DatabaseCharacterSet", + "properties": { + "characterSet": { + "description": "Output only. The character set name for the Database which is the ID in the resource name.", + "readOnly": true, + "type": "string" + }, + "characterSetType": { + "description": "Output only. The character set type for the Database.", + "enum": [ + "CHARACTER_SET_TYPE_UNSPECIFIED", + "DATABASE", + "NATIONAL" + ], + "enumDescriptions": [ + "Character set type is not specified.", + "Character set type is set to database.", + "Character set type is set to national." + ], + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The name of the Database Character Set resource in the following format: projects/{project}/locations/{region}/databaseCharacterSets/{database_character_set}", + "type": "string" + } + }, + "type": "object" + }, + "DatabaseConnectionStringProfile": { + "description": "The connection string profile to allow clients to group. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DatabaseConnectionStringProfile", + "id": "DatabaseConnectionStringProfile", + "properties": { + "consumerGroup": { + "description": "Output only. The current consumer group being used by the connection.", + "enum": [ + "CONSUMER_GROUP_UNSPECIFIED", + "HIGH", + "MEDIUM", + "LOW", + "TP", + "TPURGENT" + ], + "enumDescriptions": [ + "Default unspecified value.", + "High consumer group.", + "Medium consumer group.", + "Low consumer group.", + "TP consumer group.", + "TPURGENT consumer group." + ], + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Output only. The display name for the database connection.", + "readOnly": true, + "type": "string" + }, + "hostFormat": { + "description": "Output only. The host name format being currently used in connection string.", + "enum": [ + "HOST_FORMAT_UNSPECIFIED", + "FQDN", + "IP" + ], + "enumDescriptions": [ + "Default unspecified value.", + "FQDN", + "IP" + ], + "readOnly": true, + "type": "string" + }, + "isRegional": { + "description": "Output only. This field indicates if the connection string is regional and is only applicable for cross-region Data Guard.", + "readOnly": true, + "type": "boolean" + }, + "protocol": { + "description": "Output only. The protocol being used by the connection.", + "enum": [ + "PROTOCOL_UNSPECIFIED", + "TCP", + "TCPS" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Tcp", + "Tcps" + ], + "readOnly": true, + "type": "string" + }, + "sessionMode": { + "description": "Output only. The current session mode of the connection.", + "enum": [ + "SESSION_MODE_UNSPECIFIED", + "DIRECT", + "INDIRECT" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Direct", + "Indirect" + ], + "readOnly": true, + "type": "string" + }, + "syntaxFormat": { + "description": "Output only. The syntax of the connection string.", + "enum": [ + "SYNTAX_FORMAT_UNSPECIFIED", + "LONG", + "EZCONNECT", + "EZCONNECTPLUS" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Long", + "Ezconnect", + "Ezconnectplus" + ], + "readOnly": true, + "type": "string" + }, + "tlsAuthentication": { + "description": "Output only. This field indicates the TLS authentication type of the connection.", + "enum": [ + "TLS_AUTHENTICATION_UNSPECIFIED", + "SERVER", + "MUTUAL" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Server", + "Mutual" + ], + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Output only. The value of the connection string.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "DatabaseManagementConfig": { + "description": "The configuration of the Database Management service.", + "id": "DatabaseManagementConfig", + "properties": { + "managementState": { + "description": "Output only. The status of the Database Management service.", + "enum": [ + "MANAGEMENT_STATE_UNSPECIFIED", + "ENABLING", + "ENABLED", + "DISABLING", + "DISABLED", + "UPDATING", + "FAILED_ENABLING", + "FAILED_DISABLING", + "FAILED_UPDATING" + ], + "enumDescriptions": [ + "The status is not specified.", + "The Database Management service is enabling.", + "The Database Management service is enabled.", + "The Database Management service is disabling.", + "The Database Management service is disabled.", + "The Database Management service is updating.", + "The Database Management service failed to enable.", + "The Database Management service failed to disable.", + "The Database Management service failed to update." + ], + "readOnly": true, + "type": "string" + }, + "managementType": { + "description": "Output only. The Database Management type.", + "enum": [ + "MANAGEMENT_TYPE_UNSPECIFIED", + "BASIC", + "ADVANCED" + ], + "enumDescriptions": [ + "The type is not specified.", + "Basic Database Management.", + "Advanced Database Management." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "DatabaseProperties": { + "description": "The properties of a Database.", + "id": "DatabaseProperties", + "properties": { + "databaseManagementConfig": { + "$ref": "DatabaseManagementConfig", + "description": "Output only. The Database Management config.", + "readOnly": true + }, + "dbBackupConfig": { + "$ref": "DbBackupConfig", + "description": "Optional. Backup options for the Database." + }, + "dbVersion": { + "description": "Required. The Oracle Database version.", + "type": "string" + }, + "state": { + "description": "Output only. State of the Database.", + "enum": [ + "DATABASE_LIFECYCLE_STATE_UNSPECIFIED", + "PROVISIONING", + "AVAILABLE", + "UPDATING", + "BACKUP_IN_PROGRESS", + "UPGRADING", + "CONVERTING", + "TERMINATING", + "TERMINATED", + "RESTORE_FAILED", + "FAILED" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Indicates that the resource is in provisioning state.", + "Indicates that the resource is in available state.", + "Indicates that the resource is in updating state.", + "Indicates that the resource is in backup in progress state.", + "Indicates that the resource is in upgrading state.", + "Indicates that the resource is in converting state.", + "Indicates that the resource is in terminating state.", + "Indicates that the resource is in terminated state.", + "Indicates that the resource is in restore failed state.", + "Indicates that the resource is in failed state." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "DbBackupConfig": { + "description": "Backup Options for the Database.", + "id": "DbBackupConfig", + "properties": { + "autoBackupEnabled": { + "description": "Optional. If set to true, enables automatic backups on the database.", + "type": "boolean" + }, + "autoFullBackupDay": { + "description": "Optional. The day of the week on which the full backup should be performed on the database. If no value is provided, it will default to Sunday.", + "enum": [ + "DAY_OF_WEEK_UNSPECIFIED", + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY", + "SUNDAY" + ], + "enumDescriptions": [ + "The day of the week is unspecified.", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "type": "string" + }, + "autoFullBackupWindow": { + "description": "Optional. The window in which the full backup should be performed on the database. If no value is provided, the default is anytime.", + "enum": [ + "BACKUP_WINDOW_UNSPECIFIED", + "SLOT_ONE", + "SLOT_TWO", + "SLOT_THREE", + "SLOT_FOUR", + "SLOT_FIVE", + "SLOT_SIX", + "SLOT_SEVEN", + "SLOT_EIGHT", + "SLOT_NINE", + "SLOT_TEN", + "SLOT_ELEVEN", + "SLOT_TWELVE" + ], + "enumDescriptions": [ + "Default unspecified value.", + "12:00 AM - 2:00 AM", + "2:00 AM - 4:00 AM", + "4:00 AM - 6:00 AM", + "6:00 AM - 8:00 AM", + "8:00 AM - 10:00 AM", + "10:00 AM - 12:00 PM", + "12:00 PM - 2:00 PM", + "2:00 PM - 4:00 PM", + "4:00 PM - 6:00 PM", + "6:00 PM - 8:00 PM", + "8:00 PM - 10:00 PM", + "10:00 PM - 12:00 AM" + ], + "type": "string" + }, + "autoIncrementalBackupWindow": { + "description": "Optional. The window in which the incremental backup should be performed on the database. If no value is provided, the default is anytime except the auto full backup day.", + "enum": [ + "BACKUP_WINDOW_UNSPECIFIED", + "SLOT_ONE", + "SLOT_TWO", + "SLOT_THREE", + "SLOT_FOUR", + "SLOT_FIVE", + "SLOT_SIX", + "SLOT_SEVEN", + "SLOT_EIGHT", + "SLOT_NINE", + "SLOT_TEN", + "SLOT_ELEVEN", + "SLOT_TWELVE" + ], + "enumDescriptions": [ + "Default unspecified value.", + "12:00 AM - 2:00 AM", + "2:00 AM - 4:00 AM", + "4:00 AM - 6:00 AM", + "6:00 AM - 8:00 AM", + "8:00 AM - 10:00 AM", + "10:00 AM - 12:00 PM", + "12:00 PM - 2:00 PM", + "2:00 PM - 4:00 PM", + "4:00 PM - 6:00 PM", + "6:00 PM - 8:00 PM", + "8:00 PM - 10:00 PM", + "10:00 PM - 12:00 AM" + ], + "type": "string" + }, + "backupDeletionPolicy": { + "description": "Optional. This defines when the backups will be deleted after Database termination.", + "enum": [ + "BACKUP_DELETION_POLICY_UNSPECIFIED", + "DELETE_IMMEDIATELY", + "DELETE_AFTER_RETENTION_PERIOD" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Keeps the backup for predefined time i.e. 72 hours and then delete permanently.", + "Keeps the backups as per the policy defined for database backups." + ], + "type": "string" + }, + "backupDestinationDetails": { + "description": "Optional. Details of the database backup destinations.", + "items": { + "$ref": "BackupDestinationDetails" + }, + "type": "array" + }, + "retentionPeriodDays": { + "description": "Optional. The number of days an automatic backup is retained before being automatically deleted. This value determines the earliest point in time to which a database can be restored. Min: 1, Max: 60.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "DbHome": { + "description": "Details of the Database Home resource.", + "id": "DbHome", + "properties": { + "database": { + "$ref": "Database", + "description": "Required. The Database resource." + }, + "dbVersion": { + "description": "Required. A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.", + "type": "string" + }, + "displayName": { + "description": "Optional. The display name for the Database Home. The name does not have to be unique within your project.", + "type": "string" + }, + "isUnifiedAuditingEnabled": { + "description": "Optional. Whether unified auditing is enabled for the Database Home.", + "type": "boolean" + } + }, + "type": "object" + }, + "DbNode": { + "description": "Details of the database node resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbNode/", + "id": "DbNode", + "properties": { + "name": { + "description": "Identifier. The name of the database node resource in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}/dbNodes/{db_node}", + "type": "string" + }, + "properties": { + "$ref": "DbNodeProperties", + "description": "Optional. Various properties of the database node." + } + }, + "type": "object" + }, + "DbNodeProperties": { + "description": "Various properties and settings associated with Db node.", + "id": "DbNodeProperties", + "properties": { + "createTime": { + "description": "Output only. The date and time that the database node was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "dbNodeStorageSizeGb": { + "description": "Optional. Local storage per database node.", + "format": "int32", + "type": "integer" + }, + "dbServerOcid": { + "description": "Optional. Database server OCID.", + "type": "string" + }, + "hostname": { + "description": "Optional. DNS", + "type": "string" + }, + "memorySizeGb": { + "description": "Memory allocated in GBs.", + "format": "int32", + "type": "integer" + }, + "ocid": { + "description": "Output only. OCID of database node.", + "readOnly": true, + "type": "string" + }, + "ocpuCount": { + "description": "Optional. OCPU count per database node.", + "format": "int32", + "type": "integer" + }, + "state": { + "description": "Output only. State of the database node.", + "enum": [ + "STATE_UNSPECIFIED", + "PROVISIONING", + "AVAILABLE", + "UPDATING", + "STOPPING", + "STOPPED", + "STARTING", + "TERMINATING", + "TERMINATED", + "FAILED" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Indicates that the resource is in provisioning state.", + "Indicates that the resource is in available state.", + "Indicates that the resource is in updating state.", + "Indicates that the resource is in stopping state.", + "Indicates that the resource is in stopped state.", + "Indicates that the resource is in starting state.", + "Indicates that the resource is in terminating state.", + "Indicates that the resource is in terminated state.", + "Indicates that the resource is in failed state." + ], + "readOnly": true, + "type": "string" + }, + "totalCpuCoreCount": { + "description": "Total CPU core count of the database node.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "DbServer": { + "description": "Details of the database server resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbServer/", + "id": "DbServer", + "properties": { + "displayName": { + "description": "Optional. User friendly name for this resource.", + "type": "string" + }, + "name": { + "description": "Identifier. The name of the database server resource with the format: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}/dbServers/{db_server}", + "type": "string" + }, + "properties": { + "$ref": "DbServerProperties", + "description": "Optional. Various properties of the database server." + } + }, + "type": "object" + }, + "DbServerProperties": { + "description": "Various properties and settings associated with Exadata database server.", + "id": "DbServerProperties", + "properties": { + "dbNodeIds": { + "description": "Output only. OCID of database nodes associated with the database server.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "dbNodeStorageSizeGb": { + "description": "Optional. Local storage per VM.", + "format": "int32", + "type": "integer" + }, + "maxDbNodeStorageSizeGb": { + "description": "Optional. Maximum local storage per VM.", + "format": "int32", + "type": "integer" + }, + "maxMemorySizeGb": { + "description": "Optional. Maximum memory allocated in GBs.", + "format": "int32", + "type": "integer" + }, + "maxOcpuCount": { + "description": "Optional. Maximum OCPU count per database.", + "format": "int32", + "type": "integer" + }, + "memorySizeGb": { + "description": "Optional. Memory allocated in GBs.", + "format": "int32", + "type": "integer" + }, + "ocid": { + "description": "Output only. OCID of database server.", "readOnly": true, - "type": "number" + "type": "string" }, - "dbVersion": { - "description": "Output only. A valid Oracle Database version for Autonomous Database.", + "ocpuCount": { + "description": "Optional. OCPU count per database.", + "format": "int32", + "type": "integer" + }, + "state": { + "description": "Output only. State of the database server.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "AVAILABLE", + "UNAVAILABLE", + "DELETING", + "DELETED" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Indicates that the resource is in creating state.", + "Indicates that the resource is in available state.", + "Indicates that the resource is in unavailable state.", + "Indicates that the resource is in deleting state.", + "Indicates that the resource is in deleted state." + ], "readOnly": true, "type": "string" }, - "endTime": { - "description": "Output only. The date and time the backup completed.", + "vmCount": { + "description": "Optional. Vm count per database.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "DbSystem": { + "description": "Details of the DbSystem (BaseDB) resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystem/", + "id": "DbSystem", + "properties": { + "createTime": { + "description": "Output only. The date and time that the DbSystem was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, - "isAutomaticBackup": { - "description": "Output only. Indicates if the backup is automatic or user initiated.", - "readOnly": true, - "type": "boolean" + "displayName": { + "description": "Required. The display name for the System db. The name does not have to be unique within your project.", + "type": "string" }, - "isLongTermBackup": { - "description": "Output only. Indicates if the backup is long term backup.", + "entitlementId": { + "description": "Output only. The ID of the subscription entitlement associated with the DbSystem", "readOnly": true, - "type": "boolean" + "type": "string" }, - "isRestorable": { - "description": "Output only. Indicates if the backup can be used to restore the Autonomous Database.", - "readOnly": true, - "type": "boolean" + "gcpOracleZone": { + "description": "Optional. The GCP Oracle zone where Oracle DbSystem is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.", + "type": "string" }, - "keyStoreId": { - "description": "Optional. The OCID of the key store of Oracle Vault.", + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The labels or tags associated with the DbSystem.", + "type": "object" + }, + "name": { + "description": "Identifier. The name of the DbSystem resource in the following format: projects/{project}/locations/{region}/dbSystems/{db_system}", "type": "string" }, - "keyStoreWallet": { - "description": "Optional. The wallet name for Oracle Key Vault.", + "ociUrl": { + "description": "Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.", + "readOnly": true, "type": "string" }, - "kmsKeyId": { - "description": "Optional. The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.", + "odbNetwork": { + "description": "Optional. The name of the OdbNetwork associated with the DbSystem. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.", "type": "string" }, - "kmsKeyVersionId": { - "description": "Optional. The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.", + "odbSubnet": { + "description": "Required. The name of the OdbSubnet associated with the DbSystem for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", "type": "string" }, - "lifecycleDetails": { - "description": "Output only. Additional information about the current lifecycle state.", + "properties": { + "$ref": "DbSystemProperties", + "description": "Optional. The properties of the DbSystem." + } + }, + "type": "object" + }, + "DbSystemInitialStorageSize": { + "description": "Summary of the DbSystem initial storage size.", + "id": "DbSystemInitialStorageSize", + "properties": { + "name": { + "description": "Output only. The name of the resource.", "readOnly": true, "type": "string" }, - "lifecycleState": { - "description": "Output only. The lifecycle state of the backup.", + "properties": { + "$ref": "DbSystemInitialStorageSizeProperties", + "description": "Output only. The properties of the DbSystem initial storage size summary.", + "readOnly": true + } + }, + "type": "object" + }, + "DbSystemInitialStorageSizeProperties": { + "description": "The properties of a DbSystem initial storage size summary.", + "id": "DbSystemInitialStorageSizeProperties", + "properties": { + "launchFromBackupStorageSizeDetails": { + "description": "Output only. List of storage disk details available for launches from backup.", + "items": { + "$ref": "StorageSizeDetails" + }, + "readOnly": true, + "type": "array" + }, + "shapeType": { + "description": "Output only. VM shape platform type", "enum": [ - "STATE_UNSPECIFIED", - "CREATING", - "ACTIVE", - "DELETING", - "DELETED", - "FAILED", - "UPDATING" + "SHAPE_TYPE_UNSPECIFIED", + "STANDARD_X86" ], "enumDescriptions": [ - "Default unspecified value.", - "Indicates that the resource is in creating state.", - "Indicates that the resource is in active state.", - "Indicates that the resource is in deleting state.", - "Indicates that the resource is in deleted state.", - "Indicates that the resource is in failed state.", - "Indicates that the resource is in updating state." + "Unspecified shape type.", + "Standard X86." ], "readOnly": true, "type": "string" }, - "ocid": { - "description": "Output only. OCID of the Autonomous Database backup. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle", + "storageManagement": { + "description": "Output only. The storage option used in DB system.", + "enum": [ + "STORAGE_MANAGEMENT_UNSPECIFIED", + "ASM", + "LVM" + ], + "enumDescriptions": [ + "Unspecified storage management.", + "Automatic Storage Management.", + "Logical Volume Management." + ], "readOnly": true, "type": "string" }, - "retentionPeriodDays": { - "description": "Optional. Retention period in days for the backup.", + "storageSizeDetails": { + "description": "Output only. List of storage disk details.", + "items": { + "$ref": "StorageSizeDetails" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "DbSystemOptions": { + "description": "Details of the DbSystem Options.", + "id": "DbSystemOptions", + "properties": { + "storageManagement": { + "description": "Optional. The storage option used in DB system.", + "enum": [ + "STORAGE_MANAGEMENT_UNSPECIFIED", + "ASM", + "LVM" + ], + "enumDescriptions": [ + "The storage management is unspecified.", + "Automatic storage management.", + "Logical Volume management." + ], + "type": "string" + } + }, + "type": "object" + }, + "DbSystemProperties": { + "description": "The properties of a DbSystem.", + "id": "DbSystemProperties", + "properties": { + "computeCount": { + "description": "Required. The number of CPU cores to enable for the DbSystem.", + "format": "int32", + "type": "integer" + }, + "computeModel": { + "description": "Optional. The compute model of the DbSystem.", + "enum": [ + "COMPUTE_MODEL_UNSPECIFIED", + "ECPU", + "OCPU" + ], + "enumDescriptions": [ + "The compute model is unspecified.", + "The compute model is virtual.", + "The compute model is physical." + ], + "type": "string" + }, + "dataCollectionOptions": { + "$ref": "DataCollectionOptionsDbSystem", + "description": "Optional. Data collection options for diagnostics." + }, + "dataStorageSizeGb": { + "description": "Optional. The data storage size in GB that is currently available to DbSystems.", "format": "int32", "type": "integer" }, - "sizeTb": { - "description": "Output only. The backup size in terabytes.", - "format": "float", + "databaseEdition": { + "description": "Required. The database edition of the DbSystem.", + "enum": [ + "DB_SYSTEM_DATABASE_EDITION_UNSPECIFIED", + "STANDARD_EDITION", + "ENTERPRISE_EDITION", + "ENTERPRISE_EDITION_HIGH_PERFORMANCE" + ], + "enumDescriptions": [ + "The database edition is unspecified.", + "The database edition is Standard.", + "The database edition is Enterprise.", + "The database edition is Enterprise Edition." + ], + "type": "string" + }, + "dbHome": { + "$ref": "DbHome", + "description": "Optional. Details for creating a Database Home." + }, + "dbSystemOptions": { + "$ref": "DbSystemOptions", + "description": "Optional. The options for the DbSystem." + }, + "domain": { + "description": "Optional. The host domain name of the DbSystem.", + "type": "string" + }, + "hostname": { + "description": "Output only. The hostname of the DbSystem.", "readOnly": true, - "type": "number" + "type": "string" }, - "startTime": { - "description": "Output only. The date and time the backup started.", - "format": "google-datetime", - "readOnly": true, + "hostnamePrefix": { + "description": "Optional. Prefix for DB System host names.", "type": "string" }, - "type": { - "description": "Output only. The type of the backup.", + "initialDataStorageSizeGb": { + "description": "Required. The initial data storage size in GB.", + "format": "int32", + "type": "integer" + }, + "licenseModel": { + "description": "Required. The license model of the DbSystem.", "enum": [ - "TYPE_UNSPECIFIED", - "INCREMENTAL", - "FULL", - "LONG_TERM" + "LICENSE_MODEL_UNSPECIFIED", + "LICENSE_INCLUDED", + "BRING_YOUR_OWN_LICENSE" ], "enumDescriptions": [ - "Default unspecified value.", - "Incremental backups.", - "Full backups.", - "Long term backups." + "The license model is unspecified.", + "The license model is included.", + "The license model is bring your own license." ], - "readOnly": true, - "type": "string" - }, - "vaultId": { - "description": "Optional. The OCID of the vault.", - "type": "string" - } - }, - "type": "object" - }, - "AutonomousDatabaseCharacterSet": { - "description": "Details of the Autonomous Database character set resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/", - "id": "AutonomousDatabaseCharacterSet", - "properties": { - "characterSet": { - "description": "Output only. The character set name for the Autonomous Database which is the ID in the resource name.", - "readOnly": true, "type": "string" }, - "characterSetType": { - "description": "Output only. The character set type for the Autonomous Database.", + "lifecycleState": { + "description": "Output only. State of the DbSystem.", "enum": [ - "CHARACTER_SET_TYPE_UNSPECIFIED", - "DATABASE", - "NATIONAL" + "DB_SYSTEM_LIFECYCLE_STATE_UNSPECIFIED", + "PROVISIONING", + "AVAILABLE", + "UPDATING", + "TERMINATING", + "TERMINATED", + "FAILED", + "MIGRATED", + "MAINTENANCE_IN_PROGRESS", + "NEEDS_ATTENTION", + "UPGRADING" ], "enumDescriptions": [ - "Character set type is not specified.", - "Character set type is set to database.", - "Character set type is set to national." + "Default unspecified value.", + "Indicates that the resource is in provisioning state.", + "Indicates that the resource is in available state.", + "Indicates that the resource is in updating state.", + "Indicates that the resource is in terminating state.", + "Indicates that the resource is in terminated state.", + "Indicates that the resource is in failed state.", + "Indicates that the resource has been migrated.", + "Indicates that the resource is in maintenance in progress state.", + "Indicates that the resource needs attention.", + "Indicates that the resource is upgrading." ], "readOnly": true, "type": "string" }, - "name": { - "description": "Identifier. The name of the Autonomous Database Character Set resource in the following format: projects/{project}/locations/{region}/autonomousDatabaseCharacterSets/{autonomous_database_character_set}", - "type": "string" - } - }, - "type": "object" - }, - "AutonomousDatabaseConnectionStrings": { - "description": "The connection string used to connect to the Autonomous Database. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionStrings", - "id": "AutonomousDatabaseConnectionStrings", - "properties": { - "allConnectionStrings": { - "$ref": "AllConnectionStrings", - "description": "Output only. Returns all connection strings that can be used to connect to the Autonomous Database.", - "readOnly": true + "memorySizeGb": { + "description": "Optional. The memory size in GB.", + "format": "int32", + "type": "integer" }, - "dedicated": { - "description": "Output only. The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.", - "readOnly": true, - "type": "string" + "nodeCount": { + "description": "Optional. The number of nodes in the DbSystem.", + "format": "int32", + "type": "integer" }, - "high": { - "description": "Output only. The database service provides the highest level of resources to each SQL statement.", + "ocid": { + "description": "Output only. OCID of the DbSystem.", "readOnly": true, "type": "string" }, - "low": { - "description": "Output only. The database service provides the least level of resources to each SQL statement.", - "readOnly": true, + "privateIp": { + "description": "Optional. The private IP address of the DbSystem.", "type": "string" }, - "medium": { - "description": "Output only. The database service provides a lower level of resources to each SQL statement.", - "readOnly": true, + "recoStorageSizeGb": { + "description": "Optional. The reco/redo storage size in GB.", + "format": "int32", + "type": "integer" + }, + "shape": { + "description": "Required. Shape of DB System.", "type": "string" }, - "profiles": { - "description": "Output only. A list of connection string profiles to allow clients to group, filter, and select values based on the structured metadata.", + "sshPublicKeys": { + "description": "Required. SSH public keys to be stored with the DbSystem.", "items": { - "$ref": "DatabaseConnectionStringProfile" + "type": "string" }, - "readOnly": true, "type": "array" + }, + "timeZone": { + "$ref": "TimeZone", + "description": "Optional. Time zone of the DbSystem." } }, "type": "object" }, - "AutonomousDatabaseConnectionUrls": { - "description": "The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionUrls", - "id": "AutonomousDatabaseConnectionUrls", + "DbSystemShape": { + "description": "Details of the Database System Shapes resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystemShapeSummary/", + "id": "DbSystemShape", "properties": { - "apexUri": { - "description": "Output only. Oracle Application Express (APEX) URL.", - "readOnly": true, - "type": "string" + "availableCoreCountPerNode": { + "description": "Optional. Number of cores per node.", + "format": "int32", + "type": "integer" }, - "databaseTransformsUri": { - "description": "Output only. The URL of the Database Transforms for the Autonomous Database.", - "readOnly": true, - "type": "string" + "availableDataStorageTb": { + "description": "Optional. Storage per storage server in terabytes.", + "format": "int32", + "type": "integer" }, - "graphStudioUri": { - "description": "Output only. The URL of the Graph Studio for the Autonomous Database.", - "readOnly": true, - "type": "string" + "availableMemoryPerNodeGb": { + "description": "Optional. Memory per database server node in gigabytes.", + "format": "int32", + "type": "integer" }, - "machineLearningNotebookUri": { - "description": "Output only. The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database.", - "readOnly": true, - "type": "string" + "maxNodeCount": { + "description": "Optional. Maximum number of database servers.", + "format": "int32", + "type": "integer" }, - "machineLearningUserManagementUri": { - "description": "Output only. The URL of Machine Learning user management the Autonomous Database.", - "readOnly": true, - "type": "string" + "maxStorageCount": { + "description": "Optional. Maximum number of storage servers.", + "format": "int32", + "type": "integer" }, - "mongoDbUri": { - "description": "Output only. The URL of the MongoDB API for the Autonomous Database.", - "readOnly": true, - "type": "string" + "minCoreCountPerNode": { + "description": "Optional. Minimum core count per node.", + "format": "int32", + "type": "integer" }, - "ordsUri": { - "description": "Output only. The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database.", - "readOnly": true, + "minDbNodeStoragePerNodeGb": { + "description": "Optional. Minimum node storage per database server in gigabytes.", + "format": "int32", + "type": "integer" + }, + "minMemoryPerNodeGb": { + "description": "Optional. Minimum memory per node in gigabytes.", + "format": "int32", + "type": "integer" + }, + "minNodeCount": { + "description": "Optional. Minimum number of database servers.", + "format": "int32", + "type": "integer" + }, + "minStorageCount": { + "description": "Optional. Minimum number of storage servers.", + "format": "int32", + "type": "integer" + }, + "name": { + "description": "Identifier. The name of the Database System Shape resource with the format: projects/{project}/locations/{region}/dbSystemShapes/{db_system_shape}", "type": "string" }, - "sqlDevWebUri": { - "description": "Output only. The URL of the Oracle SQL Developer Web for the Autonomous Database.", - "readOnly": true, + "shape": { + "description": "Optional. shape", "type": "string" } }, "type": "object" }, - "AutonomousDatabaseProperties": { - "description": "The properties of an Autonomous Database.", - "id": "AutonomousDatabaseProperties", + "DbVersion": { + "description": "A valid Oracle Database version.", + "id": "DbVersion", "properties": { - "actualUsedDataStorageSizeTb": { - "description": "Output only. The amount of storage currently being used for user and system data, in terabytes.", - "format": "double", + "name": { + "description": "Output only. The name of the DbVersion resource in the following format: projects/{project}/locations/{region}/dbVersions/{db_version}", "readOnly": true, - "type": "number" + "type": "string" }, - "allocatedStorageSizeTb": { - "description": "Output only. The amount of storage currently allocated for the database tables and billed for, rounded up in terabytes.", - "format": "double", + "properties": { + "$ref": "DbVersionProperties", + "description": "Output only. The properties of the DbVersion.", + "readOnly": true + } + }, + "type": "object" + }, + "DbVersionProperties": { + "description": "The properties of a DbVersion.", + "id": "DbVersionProperties", + "properties": { + "isLatestForMajorVersion": { + "description": "Output only. True if this version of the Oracle Database software is the latest version for a release.", "readOnly": true, - "type": "number" + "type": "boolean" }, - "allowlistedIps": { - "description": "Optional. Immutable. The list of allowlisted IP addresses for the Autonomous Database.", - "items": { - "type": "string" - }, - "type": "array" + "isPreviewDbVersion": { + "description": "Output only. True if this version of the Oracle Database software is the preview version.", + "readOnly": true, + "type": "boolean" }, - "apexDetails": { - "$ref": "AutonomousDatabaseApex", - "description": "Output only. The details for the Oracle APEX Application Development.", - "readOnly": true + "isUpgradeSupported": { + "description": "Output only. True if this version of the Oracle Database software is supported for Upgrade.", + "readOnly": true, + "type": "boolean" }, - "arePrimaryAllowlistedIpsUsed": { - "description": "Output only. This field indicates the status of Data Guard and Access control for the Autonomous Database. The field's value is null if Data Guard is disabled or Access Control is disabled. The field's value is TRUE if both Data Guard and Access Control are enabled, and the Autonomous Database is using primary IP access control list (ACL) for standby. The field's value is FALSE if both Data Guard and Access Control are enabled, and the Autonomous Database is using a different IP access control list (ACL) for standby compared to primary.", + "supportsPdb": { + "description": "Output only. True if this version of the Oracle Database software supports pluggable databases.", "readOnly": true, "type": "boolean" }, - "autonomousContainerDatabaseId": { - "description": "Output only. The Autonomous Container Database OCID.", + "version": { + "description": "Output only. A valid Oracle Database version.", "readOnly": true, "type": "string" - }, - "availableUpgradeVersions": { - "description": "Output only. The list of available Oracle Database upgrade versions for an Autonomous Database.", - "items": { + } + }, + "type": "object" + }, + "DefinedTagValue": { + "description": "Wrapper message for the value of a defined tag.", + "id": "DefinedTagValue", + "properties": { + "tags": { + "additionalProperties": { "type": "string" }, + "description": "The tags within the namespace.", + "type": "object" + } + }, + "type": "object" + }, + "DeploymentDiagnosticData": { + "description": "The deployment diagnostic data.", + "id": "DeploymentDiagnosticData", + "properties": { + "bucket": { + "description": "Output only. The bucket name.", "readOnly": true, - "type": "array" - }, - "backupRetentionPeriodDays": { - "description": "Optional. Immutable. The retention period for the Autonomous Database. This field is specified in days, can range from 1 day to 60 days, and has a default value of 60 days.", - "format": "int32", - "type": "integer" - }, - "characterSet": { - "description": "Optional. Immutable. The character set for the Autonomous Database. The default is AL32UTF8.", "type": "string" }, - "computeCount": { - "description": "Optional. Immutable. The number of compute servers for the Autonomous Database.", - "format": "float", - "type": "number" - }, - "connectionStrings": { - "$ref": "AutonomousDatabaseConnectionStrings", - "description": "Output only. The connection strings used to connect to an Autonomous Database.", - "readOnly": true - }, - "connectionUrls": { - "$ref": "AutonomousDatabaseConnectionUrls", - "description": "Output only. The Oracle Connection URLs for an Autonomous Database.", - "readOnly": true - }, - "cpuCoreCount": { - "description": "Optional. Immutable. The number of CPU cores to be made available to the database.", - "format": "int32", - "type": "integer" - }, - "customerContacts": { - "description": "Optional. Immutable. The list of customer contacts.", - "items": { - "$ref": "CustomerContact" - }, - "type": "array" + "diagnosticEndTime": { + "description": "Output only. The time diagnostic end.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "dataGuardRoleChangedTime": { - "description": "Output only. The date and time the Autonomous Data Guard role was changed for the standby Autonomous Database.", + "diagnosticStartTime": { + "description": "Output only. The time diagnostic start.", "format": "google-datetime", "readOnly": true, "type": "string" }, - "dataSafeState": { - "description": "Output only. The current state of the Data Safe registration for the Autonomous Database.", + "diagnosticState": { + "description": "Output only. The diagnostic state.", "enum": [ - "DATA_SAFE_STATE_UNSPECIFIED", - "REGISTERING", - "REGISTERED", - "DEREGISTERING", - "NOT_REGISTERED", + "DIAGNOSTIC_STATE_UNSPECIFIED", + "IN_PROGRESS", + "SUCCEEDED", "FAILED" ], "enumDescriptions": [ - "Default unspecified value.", - "Registering data safe state.", - "Registered data safe state.", - "Deregistering data safe state.", - "Not registered data safe state.", - "Failed data safe state." + "The diagnostic state is unspecified.", + "The diagnostic is in progress.", + "The diagnostic completed successfully.", + "The diagnostic failed." ], "readOnly": true, "type": "string" }, - "dataStorageSizeGb": { - "description": "Optional. Immutable. The size of the data stored in the database, in gigabytes.", - "format": "int32", - "type": "integer" - }, - "dataStorageSizeTb": { - "description": "Optional. Immutable. The size of the data stored in the database, in terabytes.", - "format": "int32", - "type": "integer" - }, - "databaseManagementState": { - "description": "Output only. The current state of database management for the Autonomous Database.", - "enum": [ - "DATABASE_MANAGEMENT_STATE_UNSPECIFIED", - "ENABLING", - "ENABLED", - "DISABLING", - "NOT_ENABLED", - "FAILED_ENABLING", - "FAILED_DISABLING" - ], - "enumDescriptions": [ - "Default unspecified value.", - "Enabling Database Management state", - "Enabled Database Management state", - "Disabling Database Management state", - "Not Enabled Database Management state", - "Failed enabling Database Management state", - "Failed disabling Database Management state" - ], + "namespace": { + "description": "Output only. The namespace name.", "readOnly": true, "type": "string" }, - "dbEdition": { - "description": "Optional. Immutable. The edition of the Autonomous Databases.", - "enum": [ - "DATABASE_EDITION_UNSPECIFIED", - "STANDARD_EDITION", - "ENTERPRISE_EDITION" - ], - "enumDescriptions": [ - "Default unspecified value.", - "Standard Database Edition", - "Enterprise Database Edition" - ], + "object": { + "description": "Output only. The object name.", + "readOnly": true, "type": "string" - }, - "dbVersion": { - "description": "Optional. Immutable. The Oracle Database version for the Autonomous Database.", + } + }, + "type": "object" + }, + "Empty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "EncryptionKey": { + "description": "The encryption key used to encrypt the Autonomous Database.", + "id": "EncryptionKey", + "properties": { + "kmsKey": { + "description": "Optional. The KMS key used to encrypt the Autonomous Database. This field is required if the provider is GOOGLE_MANAGED. The name of the KMS key resource in the following format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.", "type": "string" }, - "dbWorkload": { - "description": "Required. Immutable. The workload type of the Autonomous Database.", + "provider": { + "description": "Optional. The provider of the encryption key.", "enum": [ - "DB_WORKLOAD_UNSPECIFIED", - "OLTP", - "DW", - "AJD", - "APEX" + "PROVIDER_UNSPECIFIED", + "GOOGLE_MANAGED", + "ORACLE_MANAGED" ], "enumDescriptions": [ "Default unspecified value.", - "Autonomous Transaction Processing database.", - "Autonomous Data Warehouse database.", - "Autonomous JSON Database.", - "Autonomous Database with the Oracle APEX Application Development workload type." + "Google Managed KMS key, if selected, please provide the KMS key name.", + "Oracle Managed." ], "type": "string" - }, - "disasterRecoveryRoleChangedTime": { - "description": "Output only. The date and time the Disaster Recovery role was changed for the standby Autonomous Database.", + } + }, + "type": "object" + }, + "EncryptionKeyHistoryEntry": { + "description": "The history of the encryption keys used to encrypt the Autonomous Database.", + "id": "EncryptionKeyHistoryEntry", + "properties": { + "activationTime": { + "description": "Output only. The date and time when the encryption key was activated on the Autonomous Database..", "format": "google-datetime", "readOnly": true, "type": "string" }, "encryptionKey": { "$ref": "EncryptionKey", - "description": "Optional. The encryption key used to encrypt the Autonomous Database. Updating this field will add a new entry in the `encryption_key_history_entries` field with the former version." - }, - "encryptionKeyHistoryEntries": { - "description": "Output only. The history of the encryption keys used to encrypt the Autonomous Database.", - "items": { - "$ref": "EncryptionKeyHistoryEntry" - }, - "readOnly": true, - "type": "array" - }, - "failedDataRecoveryDuration": { - "description": "Output only. This field indicates the number of seconds of data loss during a Data Guard failover.", - "format": "google-duration", - "readOnly": true, - "type": "string" - }, - "isAutoScalingEnabled": { - "description": "Optional. Immutable. This field indicates if auto scaling is enabled for the Autonomous Database CPU core count.", - "type": "boolean" - }, - "isLocalDataGuardEnabled": { - "deprecated": true, - "description": "Output only. Deprecated: Please use `local_data_guard_enabled` instead. This field indicates whether the Autonomous Database has local (in-region) Data Guard enabled.", - "readOnly": true, - "type": "boolean" - }, - "isStorageAutoScalingEnabled": { - "description": "Optional. Immutable. This field indicates if auto scaling is enabled for the Autonomous Database storage.", - "type": "boolean" - }, - "licenseType": { - "description": "Required. Immutable. The license type used for the Autonomous Database.", - "enum": [ - "LICENSE_TYPE_UNSPECIFIED", - "LICENSE_INCLUDED", - "BRING_YOUR_OWN_LICENSE" - ], - "enumDescriptions": [ - "Unspecified", - "License included part of offer", - "Bring your own license" - ], - "type": "string" + "description": "Output only. The encryption key used to encrypt the Autonomous Database.", + "readOnly": true + } + }, + "type": "object" + }, + "Entitlement": { + "description": "Details of the Entitlement resource.", + "id": "Entitlement", + "properties": { + "cloudAccountDetails": { + "$ref": "CloudAccountDetails", + "description": "Details of the OCI Cloud Account." }, - "lifecycleDetails": { - "description": "Output only. The details of the current lifestyle state of the Autonomous Database.", + "entitlementId": { + "description": "Output only. Google Cloud Marketplace order ID (aka entitlement ID)", "readOnly": true, "type": "string" }, - "localAdgAutoFailoverMaxDataLossLimit": { - "deprecated": true, - "description": "Output only. Deprecated: Please use `local_adg_auto_failover_max_data_loss_limit_duration` instead. This field indicates the maximum data loss limit for an Autonomous Database, in seconds.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "localAdgAutoFailoverMaxDataLossLimitDuration": { - "description": "Optional. This field indicates the maximum data loss limit for an Autonomous Database, in seconds.", - "format": "int32", - "type": "integer" - }, - "localDataGuardEnabled": { - "description": "Optional. Indicates whether the Autonomous Database has a local (in-region) standby database. Not applicable to cross-region Data Guard or dedicated Exadata infrastructure.", - "type": "boolean" + "name": { + "description": "Identifier. The name of the Entitlement resource with the format: projects/{project}/locations/{region}/entitlements/{entitlement}", + "type": "string" }, - "localDisasterRecoveryType": { - "description": "Output only. This field indicates the local disaster recovery (DR) type of an Autonomous Database.", + "state": { + "description": "Output only. Entitlement State.", "enum": [ - "LOCAL_DISASTER_RECOVERY_TYPE_UNSPECIFIED", - "ADG", - "BACKUP_BASED", - "NOT_AVAILABLE" + "STATE_UNSPECIFIED", + "ACCOUNT_NOT_LINKED", + "ACCOUNT_NOT_ACTIVE", + "ACTIVE", + "ACCOUNT_SUSPENDED", + "NOT_APPROVED_IN_PRIVATE_MARKETPLACE" ], "enumDescriptions": [ "Default unspecified value.", - "Autonomous Data Guard recovery.", - "Backup based recovery.", - "Local disaster recovery is not available." + "Account not linked.", + "Account is linked but not active.", + "Entitlement and Account are active.", + "Account is suspended.", + "Entitlement is not approved in private marketplace." ], "readOnly": true, "type": "string" - }, - "localStandbyDb": { - "$ref": "AutonomousDatabaseStandbySummary", - "description": "Output only. The details of the Autonomous Data Guard standby database.", - "readOnly": true - }, - "maintenanceBeginTime": { - "description": "Output only. The date and time when maintenance will begin.", - "format": "google-datetime", - "readOnly": true, + } + }, + "type": "object" + }, + "ExadbVmCluster": { + "description": "ExadbVmCluster represents a cluster of VMs that are used to run Exadata workloads. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/ExadbVmCluster/", + "id": "ExadbVmCluster", + "properties": { + "backupOdbSubnet": { + "description": "Required. Immutable. The name of the backup OdbSubnet associated with the ExadbVmCluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", "type": "string" }, - "maintenanceEndTime": { - "description": "Output only. The date and time when maintenance will end.", + "createTime": { + "description": "Output only. The date and time that the ExadbVmCluster was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, - "maintenanceScheduleType": { - "description": "Optional. Immutable. The maintenance schedule of the Autonomous Database.", - "enum": [ - "MAINTENANCE_SCHEDULE_TYPE_UNSPECIFIED", - "EARLY", - "REGULAR" - ], - "enumDescriptions": [ - "Default unspecified value.", - "An EARLY maintenance schedule patches the database before the regular scheduled maintenance.", - "A REGULAR maintenance schedule follows the normal maintenance cycle." - ], + "displayName": { + "description": "Required. Immutable. The display name for the ExadbVmCluster. The name does not have to be unique within your project. The name must be 1-255 characters long and can only contain alphanumeric characters.", "type": "string" }, - "memoryPerOracleComputeUnitGbs": { - "description": "Output only. The amount of memory enabled per ECPU, in gigabytes.", - "format": "int32", + "entitlementId": { + "description": "Output only. The ID of the subscription entitlement associated with the ExadbVmCluster.", "readOnly": true, - "type": "integer" + "type": "string" }, - "memoryTableGbs": { - "description": "Output only. The memory assigned to in-memory tables in an Autonomous Database.", - "format": "int32", + "gcpOracleZone": { + "description": "Output only. Immutable. The GCP Oracle zone where Oracle ExadbVmCluster is hosted. Example: us-east4-b-r2. During creation, the system will pick the zone assigned to the ExascaleDbStorageVault.", "readOnly": true, - "type": "integer" + "type": "string" }, - "mtlsConnectionRequired": { - "description": "Optional. Immutable. This field specifies if the Autonomous Database requires mTLS connections.", - "type": "boolean" + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The labels or tags associated with the ExadbVmCluster.", + "type": "object" }, - "nCharacterSet": { - "description": "Optional. Immutable. The national character set for the Autonomous Database. The default is AL16UTF16.", + "name": { + "description": "Identifier. The name of the ExadbVmCluster resource in the following format: projects/{project}/locations/{region}/exadbVmClusters/{exadb_vm_cluster}", "type": "string" }, - "nextLongTermBackupTime": { - "description": "Output only. The long term backup schedule of the Autonomous Database.", - "format": "google-datetime", - "readOnly": true, + "odbNetwork": { + "description": "Optional. Immutable. The name of the OdbNetwork associated with the ExadbVmCluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.", "type": "string" }, - "ociUrl": { - "description": "Output only. The Oracle Cloud Infrastructure link for the Autonomous Database.", - "readOnly": true, + "odbSubnet": { + "description": "Required. Immutable. The name of the OdbSubnet associated with the ExadbVmCluster for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", "type": "string" }, - "ocid": { - "description": "Output only. OCID of the Autonomous Database. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle", - "readOnly": true, - "type": "string" + "properties": { + "$ref": "ExadbVmClusterProperties", + "description": "Required. The properties of the ExadbVmCluster." + } + }, + "type": "object" + }, + "ExadbVmClusterProperties": { + "description": "The properties of an ExadbVmCluster.", + "id": "ExadbVmClusterProperties", + "properties": { + "additionalEcpuCountPerNode": { + "description": "Optional. Immutable. The number of additional ECPUs per node for an Exadata VM cluster on exascale infrastructure.", + "format": "int32", + "type": "integer" }, - "openMode": { - "description": "Output only. This field indicates the current mode of the Autonomous Database.", - "enum": [ - "OPEN_MODE_UNSPECIFIED", - "READ_ONLY", - "READ_WRITE" - ], - "enumDescriptions": [ - "Default unspecified value.", - "Read Only Mode", - "Read Write Mode" - ], - "readOnly": true, + "clusterName": { + "description": "Optional. Immutable. The cluster name for Exascale vm cluster. The cluster name must begin with an alphabetic character and may contain hyphens(-) but can not contain underscores(_). It should be not more than 11 characters and is not case sensitive. OCI Cluster name.", "type": "string" }, - "operationsInsightsState": { - "description": "Output only. This field indicates the state of Operations Insights for the Autonomous Database.", - "enum": [ - "OPERATIONS_INSIGHTS_STATE_UNSPECIFIED", - "ENABLING", - "ENABLED", - "DISABLING", - "NOT_ENABLED", - "FAILED_ENABLING", - "FAILED_DISABLING" - ], - "enumDescriptions": [ - "Default unspecified value.", - "Enabling status for operation insights.", - "Enabled status for operation insights.", - "Disabling status for operation insights.", - "Not Enabled status for operation insights.", - "Failed enabling status for operation insights.", - "Failed disabling status for operation insights." - ], - "readOnly": true, - "type": "string" + "dataCollectionOptions": { + "$ref": "DataCollectionOptionsCommon", + "description": "Optional. Immutable. Indicates user preference for data collection options." }, - "peerDbIds": { - "description": "Output only. The list of OCIDs of standby databases located in Autonomous Data Guard remote regions that are associated with the source database.", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" + "enabledEcpuCountPerNode": { + "description": "Required. Immutable. The number of ECPUs enabled per node for an exadata vm cluster on exascale infrastructure.", + "format": "int32", + "type": "integer" }, - "permissionLevel": { - "description": "Output only. The permission level of the Autonomous Database.", - "enum": [ - "PERMISSION_LEVEL_UNSPECIFIED", - "RESTRICTED", - "UNRESTRICTED" - ], - "enumDescriptions": [ - "Default unspecified value.", - "Restricted mode allows access only by admin users.", - "Normal access." - ], - "readOnly": true, + "exascaleDbStorageVault": { + "description": "Required. Immutable. The name of ExascaleDbStorageVault associated with the ExadbVmCluster. It can refer to an existing ExascaleDbStorageVault. Or a new one can be created during the ExadbVmCluster creation (requires storage_vault_properties to be set). Format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}", "type": "string" }, - "privateEndpoint": { - "description": "Output only. The private endpoint for the Autonomous Database.", + "giVersion": { + "description": "Output only. The Oracle Grid Infrastructure (GI) software version.", "readOnly": true, "type": "string" }, - "privateEndpointIp": { - "description": "Optional. Immutable. The private endpoint IP address for the Autonomous Database.", + "gridImageId": { + "description": "Required. Immutable. Grid Infrastructure Version.", "type": "string" }, - "privateEndpointLabel": { - "description": "Optional. Immutable. The private endpoint label for the Autonomous Database.", + "hostname": { + "description": "Output only. The hostname of the ExadbVmCluster.", + "readOnly": true, "type": "string" }, - "refreshableMode": { - "description": "Output only. The refresh mode of the cloned Autonomous Database.", - "enum": [ - "REFRESHABLE_MODE_UNSPECIFIED", - "AUTOMATIC", - "MANUAL" - ], - "enumDescriptions": [ - "The default unspecified value.", - "AUTOMATIC indicates that the cloned database is automatically refreshed with data from the source Autonomous Database.", - "MANUAL indicates that the cloned database is manually refreshed with data from the source Autonomous Database." - ], - "readOnly": true, + "hostnamePrefix": { + "description": "Required. Immutable. Prefix for VM cluster host names.", "type": "string" }, - "refreshableState": { - "description": "Output only. The refresh State of the clone.", + "licenseModel": { + "description": "Optional. Immutable. The license type of the ExadbVmCluster.", "enum": [ - "REFRESHABLE_STATE_UNSPECIFIED", - "REFRESHING", - "NOT_REFRESHING" + "LICENSE_MODEL_UNSPECIFIED", + "LICENSE_INCLUDED", + "BRING_YOUR_OWN_LICENSE" ], "enumDescriptions": [ - "Default unspecified value.", - "Refreshing", - "Not refreshed" + "Unspecified.", + "Default is license included.", + "Bring your own license." ], - "readOnly": true, "type": "string" - }, - "role": { - "description": "Output only. The Data Guard role of the Autonomous Database.", - "enum": [ - "ROLE_UNSPECIFIED", - "PRIMARY", - "STANDBY", - "DISABLED_STANDBY", - "BACKUP_COPY", - "SNAPSHOT_STANDBY" + }, + "lifecycleState": { + "description": "Output only. State of the cluster.", + "enum": [ + "EXADB_VM_CLUSTER_LIFECYCLE_STATE_UNSPECIFIED", + "PROVISIONING", + "AVAILABLE", + "UPDATING", + "TERMINATING", + "TERMINATED", + "FAILED", + "MAINTENANCE_IN_PROGRESS" ], "enumDescriptions": [ "Default unspecified value.", - "Primary role", - "Standby role", - "Disabled standby role", - "Backup copy role", - "Snapshot standby role" + "Indicates that the resource is in provisioning state.", + "Indicates that the resource is in available state.", + "Indicates that the resource is in updating state.", + "Indicates that the resource is in terminating state.", + "Indicates that the resource is in terminated state.", + "Indicates that the resource is in failed state.", + "Indicates that the resource is in maintenance in progress state." ], "readOnly": true, "type": "string" }, - "scheduledOperationDetails": { - "description": "Output only. The list and details of the scheduled operations of the Autonomous Database.", - "items": { - "$ref": "ScheduledOperationDetails" - }, + "memorySizeGb": { + "description": "Output only. Memory per VM (GB) (Read-only): Shows the amount of memory allocated to each VM. Memory is calculated based on 2.75 GB per Total ECPUs.", + "format": "int32", "readOnly": true, - "type": "array" + "type": "integer" }, - "secretId": { - "description": "Optional. Immutable. The ID of the Oracle Cloud Infrastructure vault secret.", - "type": "string" + "nodeCount": { + "description": "Required. The number of nodes/VMs in the ExadbVmCluster.", + "format": "int32", + "type": "integer" }, - "serviceAgentEmail": { - "description": "Output only. An Oracle-managed Google Cloud service account on which customers can grant roles to access resources in the customer project.", + "ociUri": { + "description": "Output only. Deep link to the OCI console to view this resource.", "readOnly": true, "type": "string" }, - "sqlWebDeveloperUrl": { - "description": "Output only. The SQL Web Developer URL for the Autonomous Database.", - "readOnly": true, - "type": "string" + "scanListenerPortTcp": { + "description": "Optional. Immutable. SCAN listener port - TCP", + "format": "int32", + "type": "integer" }, - "state": { - "description": "Output only. The current lifecycle state of the Autonomous Database.", + "shapeAttribute": { + "description": "Required. Immutable. The shape attribute of the VM cluster. The type of Exascale storage used for Exadata VM cluster. The default is SMART_STORAGE which supports Oracle Database 23ai and later", "enum": [ - "STATE_UNSPECIFIED", - "PROVISIONING", - "AVAILABLE", - "STOPPING", - "STOPPED", - "STARTING", - "TERMINATING", - "TERMINATED", - "UNAVAILABLE", - "RESTORE_IN_PROGRESS", - "RESTORE_FAILED", - "BACKUP_IN_PROGRESS", - "SCALE_IN_PROGRESS", - "AVAILABLE_NEEDS_ATTENTION", - "UPDATING", - "MAINTENANCE_IN_PROGRESS", - "RESTARTING", - "RECREATING", - "ROLE_CHANGE_IN_PROGRESS", - "UPGRADING", - "INACCESSIBLE", - "STANDBY" + "SHAPE_ATTRIBUTE_UNSPECIFIED", + "SMART_STORAGE", + "BLOCK_STORAGE" ], "enumDescriptions": [ "Default unspecified value.", - "Indicates that the Autonomous Database is in provisioning state.", - "Indicates that the Autonomous Database is in available state.", - "Indicates that the Autonomous Database is in stopping state.", - "Indicates that the Autonomous Database is in stopped state.", - "Indicates that the Autonomous Database is in starting state.", - "Indicates that the Autonomous Database is in terminating state.", - "Indicates that the Autonomous Database is in terminated state.", - "Indicates that the Autonomous Database is in unavailable state.", - "Indicates that the Autonomous Database restore is in progress.", - "Indicates that the Autonomous Database failed to restore.", - "Indicates that the Autonomous Database backup is in progress.", - "Indicates that the Autonomous Database scale is in progress.", - "Indicates that the Autonomous Database is available but needs attention state.", - "Indicates that the Autonomous Database is in updating state.", - "Indicates that the Autonomous Database's maintenance is in progress state.", - "Indicates that the Autonomous Database is in restarting state.", - "Indicates that the Autonomous Database is in recreating state.", - "Indicates that the Autonomous Database's role change is in progress state.", - "Indicates that the Autonomous Database is in upgrading state.", - "Indicates that the Autonomous Database is in inaccessible state.", - "Indicates that the Autonomous Database is in standby state." + "Indicates that the resource is in smart storage.", + "Indicates that the resource is in block storage." ], - "readOnly": true, "type": "string" }, - "supportedCloneRegions": { - "description": "Output only. The list of available regions that can be used to create a clone for the Autonomous Database.", + "sshPublicKeys": { + "description": "Required. Immutable. The SSH public keys for the ExadbVmCluster.", "items": { "type": "string" }, - "readOnly": true, "type": "array" }, - "totalAutoBackupStorageSizeGbs": { - "description": "Output only. The storage space used by automatic backups of Autonomous Database, in gigabytes.", - "format": "float", - "readOnly": true, - "type": "number" + "timeZone": { + "$ref": "TimeZone", + "description": "Optional. Immutable. The time zone of the ExadbVmCluster." }, - "usedDataStorageSizeTbs": { - "description": "Output only. The storage space used by Autonomous Database, in gigabytes.", + "vmFileSystemStorage": { + "$ref": "ExadbVmClusterStorageDetails", + "description": "Required. Immutable. Total storage details for the ExadbVmCluster." + } + }, + "type": "object" + }, + "ExadbVmClusterStorageDetails": { + "description": "The storage allocation for the exadbvmcluster, in gigabytes (GB).", + "id": "ExadbVmClusterStorageDetails", + "properties": { + "sizeInGbsPerNode": { + "description": "Required. The storage allocation for the exadbvmcluster per node, in gigabytes (GB). This field is used to calculate the total storage allocation for the exadbvmcluster.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ExascaleDbStorageDetails": { + "description": "The storage details of the ExascaleDbStorageVault.", + "id": "ExascaleDbStorageDetails", + "properties": { + "availableSizeGbs": { + "description": "Output only. The available storage capacity for the ExascaleDbStorageVault, in gigabytes (GB).", "format": "int32", "readOnly": true, "type": "integer" }, - "vaultId": { - "description": "Optional. Immutable. The ID of the Oracle Cloud Infrastructure vault.", - "type": "string" + "totalSizeGbs": { + "description": "Required. The total storage allocation for the ExascaleDbStorageVault, in gigabytes (GB).", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "AutonomousDatabaseStandbySummary": { - "description": "Autonomous Data Guard standby database details. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseStandbySummary", - "id": "AutonomousDatabaseStandbySummary", + "ExascaleDbStorageVault": { + "description": "ExascaleDbStorageVault represents a storage vault exadb vm cluster resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/ExascaleDbStorageVault/", + "id": "ExascaleDbStorageVault", "properties": { - "dataGuardRoleChangedTime": { - "description": "Output only. The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database.", + "createTime": { + "description": "Output only. The date and time when the ExascaleDbStorageVault was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, - "disasterRecoveryRoleChangedTime": { - "description": "Output only. The date and time the Disaster Recovery role was switched for the standby Autonomous Database.", - "format": "google-datetime", + "displayName": { + "description": "Required. The display name for the ExascaleDbStorageVault. The name does not have to be unique within your project. The name must be 1-255 characters long and can only contain alphanumeric characters.", + "type": "string" + }, + "entitlementId": { + "description": "Output only. The ID of the subscription entitlement associated with the ExascaleDbStorageVault.", "readOnly": true, "type": "string" }, - "lagTimeDuration": { - "description": "Output only. The amount of time, in seconds, that the data of the standby database lags in comparison to the data of the primary database.", - "format": "google-duration", + "gcpOracleZone": { + "description": "Optional. The GCP Oracle zone where Oracle ExascaleDbStorageVault is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The labels or tags associated with the ExascaleDbStorageVault.", + "type": "object" + }, + "name": { + "description": "Identifier. The resource name of the ExascaleDbStorageVault. Format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}", + "type": "string" + }, + "properties": { + "$ref": "ExascaleDbStorageVaultProperties", + "description": "Required. The properties of the ExascaleDbStorageVault." + } + }, + "type": "object" + }, + "ExascaleDbStorageVaultProperties": { + "description": "The properties of the ExascaleDbStorageVault. next ID: 12", + "id": "ExascaleDbStorageVaultProperties", + "properties": { + "additionalFlashCachePercent": { + "description": "Optional. The size of additional flash cache in percentage of high capacity database storage.", + "format": "int32", + "type": "integer" + }, + "attachedShapeAttributes": { + "description": "Output only. The shape attributes of the VM clusters attached to the ExascaleDbStorageVault.", + "items": { + "enum": [ + "SHAPE_ATTRIBUTE_UNSPECIFIED", + "SMART_STORAGE", + "BLOCK_STORAGE" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Indicates that the resource is in smart storage.", + "Indicates that the resource is in block storage." + ], + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "availableShapeAttributes": { + "description": "Output only. The shape attributes available for the VM clusters to be attached to the ExascaleDbStorageVault.", + "items": { + "enum": [ + "SHAPE_ATTRIBUTE_UNSPECIFIED", + "SMART_STORAGE", + "BLOCK_STORAGE" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Indicates that the resource is in smart storage.", + "Indicates that the resource is in block storage." + ], + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "description": { + "description": "Optional. The description of the ExascaleDbStorageVault.", + "type": "string" + }, + "exascaleDbStorageDetails": { + "$ref": "ExascaleDbStorageDetails", + "description": "Required. The storage details of the ExascaleDbStorageVault." + }, + "ociUri": { + "description": "Output only. Deep link to the OCI console to view this resource.", "readOnly": true, "type": "string" }, - "lifecycleDetails": { - "description": "Output only. The additional details about the current lifecycle state of the Autonomous Database.", + "ocid": { + "description": "Output only. The OCID for the ExascaleDbStorageVault.", "readOnly": true, "type": "string" }, "state": { - "description": "Output only. The current lifecycle state of the Autonomous Database.", + "description": "Output only. The state of the ExascaleDbStorageVault.", "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "AVAILABLE", - "STOPPING", - "STOPPED", - "STARTING", + "UPDATING", "TERMINATING", "TERMINATED", - "UNAVAILABLE", - "RESTORE_IN_PROGRESS", - "RESTORE_FAILED", - "BACKUP_IN_PROGRESS", - "SCALE_IN_PROGRESS", - "AVAILABLE_NEEDS_ATTENTION", - "UPDATING", - "MAINTENANCE_IN_PROGRESS", - "RESTARTING", - "RECREATING", - "ROLE_CHANGE_IN_PROGRESS", - "UPGRADING", - "INACCESSIBLE", - "STANDBY" - ], - "enumDescriptions": [ - "Default unspecified value.", - "Indicates that the Autonomous Database is in provisioning state.", - "Indicates that the Autonomous Database is in available state.", - "Indicates that the Autonomous Database is in stopping state.", - "Indicates that the Autonomous Database is in stopped state.", - "Indicates that the Autonomous Database is in starting state.", - "Indicates that the Autonomous Database is in terminating state.", - "Indicates that the Autonomous Database is in terminated state.", - "Indicates that the Autonomous Database is in unavailable state.", - "Indicates that the Autonomous Database restore is in progress.", - "Indicates that the Autonomous Database failed to restore.", - "Indicates that the Autonomous Database backup is in progress.", - "Indicates that the Autonomous Database scale is in progress.", - "Indicates that the Autonomous Database is available but needs attention state.", - "Indicates that the Autonomous Database is in updating state.", - "Indicates that the Autonomous Database's maintenance is in progress state.", - "Indicates that the Autonomous Database is in restarting state.", - "Indicates that the Autonomous Database is in recreating state.", - "Indicates that the Autonomous Database's role change is in progress state.", - "Indicates that the Autonomous Database is in upgrading state.", - "Indicates that the Autonomous Database is in inaccessible state.", - "Indicates that the Autonomous Database is in standby state." - ], - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "AutonomousDbVersion": { - "description": "Details of the Autonomous Database version. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDbVersionSummary/", - "id": "AutonomousDbVersion", - "properties": { - "dbWorkload": { - "description": "Output only. The Autonomous Database workload type.", - "enum": [ - "DB_WORKLOAD_UNSPECIFIED", - "OLTP", - "DW", - "AJD", - "APEX" + "FAILED" ], "enumDescriptions": [ - "Default unspecified value.", - "Autonomous Transaction Processing database.", - "Autonomous Data Warehouse database.", - "Autonomous JSON Database.", - "Autonomous Database with the Oracle APEX Application Development workload type." + "The state of the ExascaleDbStorageVault is unspecified.", + "The ExascaleDbStorageVault is being provisioned.", + "The ExascaleDbStorageVault is available.", + "The ExascaleDbStorageVault is being updated.", + "The ExascaleDbStorageVault is being deleted.", + "The ExascaleDbStorageVault has been deleted.", + "The ExascaleDbStorageVault has failed." ], "readOnly": true, "type": "string" }, - "name": { - "description": "Identifier. The name of the Autonomous Database Version resource with the format: projects/{project}/locations/{region}/autonomousDbVersions/{autonomous_db_version}", - "type": "string" + "timeZone": { + "$ref": "TimeZone", + "description": "Output only. The time zone of the ExascaleDbStorageVault.", + "readOnly": true }, - "version": { - "description": "Output only. An Oracle Database version for Autonomous Database.", + "vmClusterCount": { + "description": "Output only. The number of VM clusters associated with the ExascaleDbStorageVault.", + "format": "int32", "readOnly": true, - "type": "string" + "type": "integer" }, - "workloadUri": { - "description": "Output only. A URL that points to a detailed description of the Autonomous Database version.", + "vmClusterIds": { + "description": "Output only. The list of VM cluster OCIDs associated with the ExascaleDbStorageVault.", + "items": { + "type": "string" + }, "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "FailoverAutonomousDatabaseRequest": { + "description": "The request for `OracleDatabase.FailoverAutonomousDatabase`.", + "id": "FailoverAutonomousDatabaseRequest", + "properties": { + "peerAutonomousDatabase": { + "description": "Optional. The peer database name to fail over to. Required for cross-region standby, and must be omitted for in-region Data Guard.", "type": "string" } }, "type": "object" }, - "BackupDestinationDetails": { - "description": "The details of the database backup destination.", - "id": "BackupDestinationDetails", + "GenerateAutonomousDatabaseWalletRequest": { + "description": "The request for `AutonomousDatabase.GenerateWallet`.", + "id": "GenerateAutonomousDatabaseWalletRequest", "properties": { + "isRegional": { + "description": "Optional. True when requesting regional connection strings in PDB connect info, applicable to cross-region Data Guard only.", + "type": "boolean" + }, + "password": { + "description": "Required. The password used to encrypt the keys inside the wallet. The password must be a minimum of 8 characters.", + "type": "string" + }, "type": { - "description": "Optional. The type of the database backup destination.", + "description": "Optional. The type of wallet generation for the Autonomous Database. The default value is SINGLE.", "enum": [ - "BACKUP_DESTINATION_TYPE_UNSPECIFIED", - "NFS", - "RECOVERY_APPLIANCE", - "OBJECT_STORE", - "LOCAL", - "DBRS" + "GENERATE_TYPE_UNSPECIFIED", + "ALL", + "SINGLE" ], "enumDescriptions": [ "Default unspecified value.", - "Backup destination type is NFS.", - "Backup destination type is Recovery Appliance.", - "Backup destination type is Object Store.", - "Backup destination type is Local.", - "Backup destination type is DBRS." + "Used to generate wallet for all databases in the region.", + "Used to generate wallet for a single database." ], "type": "string" } }, "type": "object" }, - "CancelOperationRequest": { - "description": "The request message for Operations.CancelOperation.", - "id": "CancelOperationRequest", - "properties": {}, - "type": "object" - }, - "CloudAccountDetails": { - "description": "Details of the OCI Cloud Account.", - "id": "CloudAccountDetails", + "GenerateAutonomousDatabaseWalletResponse": { + "description": "The response for `AutonomousDatabase.GenerateWallet`.", + "id": "GenerateAutonomousDatabaseWalletResponse", "properties": { - "accountCreationUri": { - "description": "Output only. URL to create a new account and link.", + "archiveContent": { + "description": "Output only. The base64 encoded wallet files.", + "format": "byte", "readOnly": true, "type": "string" - }, - "cloudAccount": { - "description": "Output only. OCI account name.", - "readOnly": true, + } + }, + "type": "object" + }, + "GiVersion": { + "description": "Details of the Oracle Grid Infrastructure (GI) version resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/GiVersionSummary/", + "id": "GiVersion", + "properties": { + "name": { + "description": "Identifier. The name of the Oracle Grid Infrastructure (GI) version resource with the format: projects/{project}/locations/{region}/giVersions/{gi_versions}", "type": "string" }, - "cloudAccountHomeRegion": { - "description": "Output only. OCI account home region.", - "readOnly": true, + "version": { + "description": "Optional. version", "type": "string" - }, - "linkExistingAccountUri": { - "description": "Output only. URL to link an existing account.", - "readOnly": true, + } + }, + "type": "object" + }, + "GlueIcebergCatalog": { + "description": "The Glue Iceberg catalog.", + "id": "GlueIcebergCatalog", + "properties": { + "glueId": { + "description": "Required. The catalog ID of Glue.", "type": "string" } }, "type": "object" }, - "CloudExadataInfrastructure": { - "description": "Represents CloudExadataInfrastructure resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudExadataInfrastructure/", - "id": "CloudExadataInfrastructure", + "GoldengateAmazonKinesisConnectionProperties": { + "description": "The properties of GoldengateAmazonKinesisConnection.", + "id": "GoldengateAmazonKinesisConnectionProperties", "properties": { - "createTime": { - "description": "Output only. The date and time that the Exadata Infrastructure was created.", - "format": "google-datetime", - "readOnly": true, + "accessKeyId": { + "description": "Optional. Access key ID to access the Amazon Kinesis.", "type": "string" }, - "displayName": { - "description": "Optional. User friendly name for this resource.", + "awsRegion": { + "description": "Optional. The name of the AWS region. If not provided, Goldengate will default to 'us-west-1'.", "type": "string" }, - "entitlementId": { - "description": "Output only. Entitlement ID of the private offer against which this infrastructure resource is provisioned.", - "readOnly": true, + "endpoint": { + "description": "Optional. The endpoint URL of the Amazon Kinesis service. e.g.: 'https://kinesis.us-east-1.amazonaws.com' If not provided, Goldengate will default to 'https://kinesis..amazonaws.com'.", "type": "string" }, - "gcpOracleZone": { - "description": "Optional. The GCP Oracle zone where Oracle Exadata Infrastructure is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.", + "secretAccessKeySecret": { + "description": "Optional. Secret access key to access the Amazon Kinesis.", "type": "string" }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. Labels or tags associated with the resource.", - "type": "object" - }, - "name": { - "description": "Identifier. The name of the Exadata Infrastructure resource with the format: projects/{project}/locations/{region}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}", + "technologyType": { + "description": "Optional. The technology type of AmazonKinesisConnection.", "type": "string" - }, - "properties": { - "$ref": "CloudExadataInfrastructureProperties", - "description": "Optional. Various properties of the infra." } }, "type": "object" }, - "CloudExadataInfrastructureProperties": { - "description": "Various properties of Exadata Infrastructure.", - "id": "CloudExadataInfrastructureProperties", + "GoldengateAmazonRedshiftConnectionProperties": { + "description": "The properties of GoldengateAmazonRedshiftConnection.", + "id": "GoldengateAmazonRedshiftConnectionProperties", "properties": { - "activatedStorageCount": { - "description": "Output only. The requested number of additional storage servers activated for the Exadata Infrastructure.", - "format": "int32", - "readOnly": true, - "type": "integer" + "connectionUrl": { + "description": "Optional. Connection URL. e.g.: 'jdbc:redshift://aws-redshift-instance.aaaaaaaaaaaa.us-east-2.redshift.amazonaws.com:5439/mydb'", + "type": "string" }, - "additionalStorageCount": { - "description": "Output only. The requested number of additional storage servers for the Exadata Infrastructure.", - "format": "int32", - "readOnly": true, - "type": "integer" + "password": { + "description": "Optional. Input only. The password Oracle Goldengate uses for Amazon Redshift connection in plain text.", + "type": "string" }, - "availableStorageSizeGb": { - "description": "Output only. The available storage can be allocated to the Exadata Infrastructure resource, in gigabytes (GB).", - "format": "int32", - "readOnly": true, - "type": "integer" + "passwordSecretVersion": { + "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses for Amazon Redshift connection. Format: projects/{project}/secrets/{secret}/versions/{version}.", + "type": "string" }, - "computeCount": { - "description": "Optional. The number of compute servers for the Exadata Infrastructure.", - "format": "int32", - "type": "integer" + "technologyType": { + "description": "Optional. The technology type of AmazonRedshiftConnection.", + "type": "string" }, - "computeModel": { - "description": "Output only. The compute model of the Exadata Infrastructure.", - "enum": [ - "COMPUTE_MODEL_UNSPECIFIED", - "COMPUTE_MODEL_ECPU", - "COMPUTE_MODEL_OCPU" - ], - "enumDescriptions": [ - "Unspecified compute model.", - "Abstract measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers.", - "Physical measure of compute resources. OCPUs are based on the physical core of a processor." - ], - "readOnly": true, + "username": { + "description": "Optional. The username Oracle Goldengate uses to connect the associated system of the given technology.", + "type": "string" + } + }, + "type": "object" + }, + "GoldengateAmazonS3ConnectionProperties": { + "description": "The properties of GoldengateAmazonS3Connection.", + "id": "GoldengateAmazonS3ConnectionProperties", + "properties": { + "accessKeyId": { + "description": "Optional. Access key ID to access the Amazon S3 bucket.", "type": "string" }, - "cpuCount": { - "description": "Output only. The number of enabled CPU cores.", - "format": "int32", - "readOnly": true, - "type": "integer" + "endpoint": { + "description": "Optional. The Amazon Endpoint for S3.", + "type": "string" }, - "customerContacts": { - "description": "Optional. The list of customer contacts.", - "items": { - "$ref": "CustomerContact" - }, - "type": "array" + "region": { + "description": "Optional. The name of the AWS region where the bucket is created.", + "type": "string" }, - "dataStorageSizeTb": { - "description": "Output only. Size, in terabytes, of the DATA disk group.", - "format": "double", - "readOnly": true, - "type": "number" + "secretAccessKeySecret": { + "description": "Optional. Secret access key to access the Amazon S3 bucket.", + "type": "string" }, - "databaseServerType": { - "description": "Output only. The database server type of the Exadata Infrastructure.", - "readOnly": true, + "technologyType": { + "description": "Optional. The technology type of AmazonS3Connection.", + "type": "string" + } + }, + "type": "object" + }, + "GoldengateAzureDataLakeStorageConnectionProperties": { + "description": "The properties of GoldengateAzureDataLakeStorageConnection.", + "id": "GoldengateAzureDataLakeStorageConnectionProperties", + "properties": { + "account": { + "description": "Optional. Sets the Azure storage account name.", "type": "string" }, - "dbNodeStorageSizeGb": { - "description": "Output only. The local node storage allocated in GBs.", - "format": "int32", - "readOnly": true, - "type": "integer" + "accountKeySecret": { + "description": "Optional. Azure storage account key. This property is required when 'authentication_type' is set to 'SHARED_KEY'.", + "type": "string" }, - "dbServerVersion": { - "description": "Output only. The software version of the database servers (dom0) in the Exadata Infrastructure.", - "readOnly": true, + "authenticationType": { + "description": "Optional. Authentication mechanism to access Azure Data Lake Storage.", + "enum": [ + "AUTHENTICATION_TYPE_UNSPECIFIED", + "SHARED_KEY", + "SHARED_ACCESS_SIGNATURE", + "AZURE_ACTIVE_DIRECTORY" + ], + "enumDescriptions": [ + "Authentication type not specified.", + "Shared key authentication.", + "Shared access signature authentication.", + "Azure active directory authentication." + ], "type": "string" }, - "maintenanceWindow": { - "$ref": "MaintenanceWindow", - "description": "Optional. Maintenance window for repair." + "azureAuthorityHost": { + "description": "Optional. The endpoint used for authentication with Microsoft Entra ID (formerly Azure Active Directory). Default value: https://login.microsoftonline.com", + "type": "string" }, - "maxCpuCount": { - "description": "Output only. The total number of CPU cores available.", - "format": "int32", - "readOnly": true, - "type": "integer" + "azureTenantId": { + "description": "Optional. Azure tenant ID of the application. This property is required when 'authentication_type' is set to 'AZURE_ACTIVE_DIRECTORY'.", + "type": "string" }, - "maxDataStorageTb": { - "description": "Output only. The total available DATA disk group size.", - "format": "double", - "readOnly": true, - "type": "number" + "clientId": { + "description": "Optional. Azure client ID of the application. This property is required when 'authentication_type' is set to 'AZURE_ACTIVE_DIRECTORY'.", + "type": "string" }, - "maxDbNodeStorageSizeGb": { - "description": "Output only. The total local node storage available in GBs.", - "format": "int32", - "readOnly": true, - "type": "integer" + "clientSecret": { + "description": "Optional. Azure client secret (aka application password) for authentication.", + "type": "string" }, - "maxMemoryGb": { - "description": "Output only. The total memory available in GBs.", - "format": "int32", - "readOnly": true, - "type": "integer" + "endpoint": { + "description": "Optional. Azure Storage service endpoint. e.g: https://test.blob.core.windows.net", + "type": "string" }, - "memorySizeGb": { - "description": "Output only. The memory allocated in GBs.", - "format": "int32", - "readOnly": true, - "type": "integer" + "sasTokenSecret": { + "description": "Optional. Credential that uses a shared access signature (SAS) to authenticate to an Azure Service.", + "type": "string" }, - "monthlyDbServerVersion": { - "description": "Output only. The monthly software version of the database servers (dom0) in the Exadata Infrastructure. Example: 20.1.15", - "readOnly": true, + "technologyType": { + "description": "Optional. The technology type of AzureDataLakeStorageConnection.", + "type": "string" + } + }, + "type": "object" + }, + "GoldengateAzureSynapseAnalyticsConnectionProperties": { + "description": "The properties of GoldengateAzureSynapseAnalyticsConnection.", + "id": "GoldengateAzureSynapseAnalyticsConnectionProperties", + "properties": { + "connectionString": { + "description": "Optional. JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'", "type": "string" }, - "monthlyStorageServerVersion": { - "description": "Output only. The monthly software version of the storage servers (cells) in the Exadata Infrastructure. Example: 20.1.15", - "readOnly": true, + "password": { + "description": "Optional. Input only. The password Oracle Goldengate uses for Azure Synapse Analytics connection in plain text.", "type": "string" }, - "nextMaintenanceRunId": { - "description": "Output only. The OCID of the next maintenance run.", - "readOnly": true, + "passwordSecretVersion": { + "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses for Azure Synapse Analytics connection. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, - "nextMaintenanceRunTime": { - "description": "Output only. The time when the next maintenance run will occur.", - "format": "google-datetime", - "readOnly": true, + "technologyType": { + "description": "Optional. The technology type of AzureSynapseAnalyticsConnection.", "type": "string" }, - "nextSecurityMaintenanceRunTime": { - "description": "Output only. The time when the next security maintenance run will occur.", + "username": { + "description": "Optional. The username Oracle Goldengate uses to connect the associated system of the given technology.", + "type": "string" + } + }, + "type": "object" + }, + "GoldengateBackupSchedule": { + "description": "The backup schedule of the GoldengateDeployment.", + "id": "GoldengateBackupSchedule", + "properties": { + "backupScheduledTime": { + "description": "Output only. The timestamp of when the backup was scheduled.", "format": "google-datetime", "readOnly": true, "type": "string" }, - "ociUrl": { - "description": "Output only. Deep link to the OCI console to view this resource.", + "bucket": { + "description": "Output only. The bucket name.", "readOnly": true, "type": "string" }, - "ocid": { - "description": "Output only. OCID of created infra. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle", + "compartmentId": { + "description": "Output only. The compartment id.", "readOnly": true, "type": "string" }, - "shape": { - "description": "Required. The shape of the Exadata Infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance.", - "type": "string" - }, - "state": { - "description": "Output only. The current lifecycle state of the Exadata Infrastructure.", + "frequencyBackupScheduled": { + "description": "Output only. The frequency backup scheduled.", "enum": [ - "STATE_UNSPECIFIED", - "PROVISIONING", - "AVAILABLE", - "UPDATING", - "TERMINATING", - "TERMINATED", - "FAILED", - "MAINTENANCE_IN_PROGRESS" + "FREQUENCY_BACKUP_SCHEDULED_UNSPECIFIED", + "DAILY", + "WEEKLY", + "MONTHLY" ], "enumDescriptions": [ - "Default unspecified value.", - "The Exadata Infrastructure is being provisioned.", - "The Exadata Infrastructure is available for use.", - "The Exadata Infrastructure is being updated.", - "The Exadata Infrastructure is being terminated.", - "The Exadata Infrastructure is terminated.", - "The Exadata Infrastructure is in failed state.", - "The Exadata Infrastructure is in maintenance." + "The frequency backup scheduled is unspecified.", + "The frequency backup scheduled is daily.", + "The frequency backup scheduled is weekly.", + "The frequency backup scheduled is monthly." ], "readOnly": true, "type": "string" }, - "storageCount": { - "description": "Optional. The number of Cloud Exadata storage servers for the Exadata Infrastructure.", - "format": "int32", - "type": "integer" - }, - "storageServerType": { - "description": "Output only. The storage server type of the Exadata Infrastructure.", + "metadataOnly": { + "description": "Output only. If metadata only.", "readOnly": true, - "type": "string" + "type": "boolean" }, - "storageServerVersion": { - "description": "Output only. The software version of the storage servers (cells) in the Exadata Infrastructure.", + "namespace": { + "description": "Output only. The namespace name.", "readOnly": true, "type": "string" - }, - "totalStorageSizeGb": { - "description": "Optional. The total storage allocated to the Exadata Infrastructure resource, in gigabytes (GB).", - "format": "int32", - "type": "integer" } }, "type": "object" }, - "CloudVmCluster": { - "description": "Details of the Cloud VM Cluster resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudVmCluster/", - "id": "CloudVmCluster", + "GoldengateConnection": { + "description": "Details of the GoldengateConnection resource.", + "id": "GoldengateConnection", "properties": { - "backupOdbSubnet": { - "description": "Optional. The name of the backup OdbSubnet associated with the VM Cluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", - "type": "string" - }, - "backupSubnetCidr": { - "description": "Optional. CIDR range of the backup subnet.", - "type": "string" - }, - "cidr": { - "description": "Optional. Network settings. CIDR to use for cluster IP allocation.", - "type": "string" - }, "createTime": { - "description": "Output only. The date and time that the VM cluster was created.", + "description": "Output only. The date and time that the GoldengateConnection was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, - "displayName": { - "description": "Optional. User friendly name for this resource.", - "type": "string" - }, - "exadataInfrastructure": { - "description": "Required. The name of the Exadata Infrastructure resource on which VM cluster resource is created, in the following format: projects/{project}/locations/{region}/cloudExadataInfrastuctures/{cloud_extradata_infrastructure}", + "entitlementId": { + "description": "Output only. The ID of the subscription entitlement associated with the GoldengateConnection.", + "readOnly": true, "type": "string" }, "gcpOracleZone": { - "description": "Output only. The GCP Oracle zone where Oracle CloudVmCluster is hosted. This will be the same as the gcp_oracle_zone of the CloudExadataInfrastructure. Example: us-east4-b-r2.", - "readOnly": true, + "description": "Optional. The GCP Oracle zone where Oracle GoldengateConnection is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.", "type": "string" }, - "identityConnector": { - "$ref": "IdentityConnector", - "description": "Output only. The identity connector details which will allow OCI to securely access the resources in the customer project.", - "readOnly": true - }, "labels": { "additionalProperties": { "type": "string" }, - "description": "Optional. Labels or tags associated with the VM Cluster.", + "description": "Optional. The labels or tags associated with the GoldengateConnection.", "type": "object" }, "name": { - "description": "Identifier. The name of the VM Cluster resource with the format: projects/{project}/locations/{region}/cloudVmClusters/{cloud_vm_cluster}", + "description": "Identifier. The name of the GoldengateConnection resource in the following format: projects/{project}/locations/{region}/goldengateConnections/{goldengate_connection}", "type": "string" }, - "network": { - "description": "Optional. The name of the VPC network. Format: projects/{project}/global/networks/{network}", + "ociUrl": { + "description": "Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.", + "readOnly": true, "type": "string" }, "odbNetwork": { - "description": "Optional. The name of the OdbNetwork associated with the VM Cluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the odb_subnet and backup_odb_subnet.", + "description": "Optional. The name of the OdbNetwork associated with the GoldengateConnection. The format is projects/{project}/locations/{location}/odbNetworks/{odb_network}. It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.", "type": "string" }, "odbSubnet": { - "description": "Optional. The name of the OdbSubnet associated with the VM Cluster for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", + "description": "Optional. The name of the OdbSubnet associated with the GoldengateConnection for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", "type": "string" }, "properties": { - "$ref": "CloudVmClusterProperties", - "description": "Optional. Various properties of the VM Cluster." + "$ref": "GoldengateConnectionProperties", + "description": "Required. The properties of the GoldengateConnection." } }, "type": "object" }, - "CloudVmClusterProperties": { - "description": "Various properties and settings associated with Exadata VM cluster.", - "id": "CloudVmClusterProperties", - "properties": { - "clusterName": { - "description": "Optional. OCI Cluster name.", - "type": "string" - }, - "compartmentId": { - "description": "Output only. Compartment ID of cluster.", - "readOnly": true, - "type": "string" - }, - "computeModel": { - "description": "Output only. The compute model of the VM Cluster.", - "enum": [ - "COMPUTE_MODEL_UNSPECIFIED", - "COMPUTE_MODEL_ECPU", - "COMPUTE_MODEL_OCPU" - ], - "enumDescriptions": [ - "Unspecified compute model.", - "Abstract measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers.", - "Physical measure of compute resources. OCPUs are based on the physical core of a processor." - ], - "readOnly": true, - "type": "string" - }, - "cpuCoreCount": { - "description": "Required. Number of enabled CPU cores.", - "format": "int32", - "type": "integer" - }, - "dataStorageSizeTb": { - "description": "Optional. The data disk group size to be allocated in TBs.", - "format": "double", - "type": "number" - }, - "dbNodeStorageSizeGb": { - "description": "Optional. Local storage per VM.", - "format": "int32", - "type": "integer" - }, - "dbServerOcids": { - "description": "Optional. OCID of database servers.", - "items": { - "type": "string" - }, - "type": "array" - }, - "diagnosticsDataCollectionOptions": { - "$ref": "DataCollectionOptions", - "description": "Optional. Data collection options for diagnostics." - }, - "diskRedundancy": { - "description": "Optional. The type of redundancy.", - "enum": [ - "DISK_REDUNDANCY_UNSPECIFIED", - "HIGH", - "NORMAL" - ], - "enumDescriptions": [ - "Unspecified.", - "High - 3 way mirror.", - "Normal - 2 way mirror." - ], + "GoldengateConnectionAssignment": { + "description": "Represents the metadata of a Goldengate Connection Assignment.", + "id": "GoldengateConnectionAssignment", + "properties": { + "createTime": { + "description": "Output only. The time when the connection assignment was created.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "dnsListenerIp": { - "description": "Output only. DNS listener IP.", - "readOnly": true, + "displayName": { + "description": "Optional. The display name for the GoldengateConnectionAssignment.", "type": "string" }, - "domain": { - "description": "Output only. Parent DNS domain where SCAN DNS and hosts names are qualified. ex: ocispdelegated.ocisp10jvnet.oraclevcn.com", + "entitlementId": { + "description": "Output only. The OCID of the entitlement linked to this resource.", "readOnly": true, "type": "string" }, - "giVersion": { - "description": "Optional. Grid Infrastructure Version.", + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The labels or tags associated with the GoldengateConnectionAssignment.", + "type": "object" + }, + "name": { + "description": "Identifier. The name of the GoldengateConnectionAssignment resource in the following format: projects/{project}/locations/{region}/goldengateConnectionAssignments/{goldengate_connection_assignment}", "type": "string" }, - "hostname": { - "description": "Output only. host name without domain. format: \"-\" with some suffix. ex: sp2-yi0xq where \"sp2\" is the hostname_prefix.", + "properties": { + "$ref": "GoldengateConnectionAssignmentProperties", + "description": "Required. The properties of the GoldengateConnectionAssignment." + } + }, + "type": "object" + }, + "GoldengateConnectionAssignmentProperties": { + "description": "The properties of a GoldengateConnectionAssignment.", + "id": "GoldengateConnectionAssignmentProperties", + "properties": { + "alias": { + "description": "Output only. Credential store alias.", "readOnly": true, "type": "string" }, - "hostnamePrefix": { - "description": "Optional. Prefix for VM cluster host names.", + "goldengateConnection": { + "description": "Required. The GoldengateConnection resource to be assigned. Format: projects/{project}/locations/{location}/goldengateConnections/{goldengate_connection}", "type": "string" }, - "licenseType": { - "description": "Required. License type of VM Cluster.", + "goldengateDeployment": { + "description": "Required. The GoldenGateDeployment to assign the connection to. Format: projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}", + "type": "string" + }, + "ocid": { + "description": "Output only. The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the connection assignment being referenced.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The lifecycle state of the connection assignment.", "enum": [ - "LICENSE_TYPE_UNSPECIFIED", - "LICENSE_INCLUDED", - "BRING_YOUR_OWN_LICENSE" + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "FAILED", + "UPDATING", + "DELETING" ], "enumDescriptions": [ - "Unspecified", - "License included part of offer", - "Bring your own license" + "Lifecycle state is unspecified.", + "Connection assignment is being created.", + "Connection assignment is active.", + "Connection assignment failed.", + "Connection assignment is being updated.", + "Connection assignment is being deleted." ], + "readOnly": true, "type": "string" + } + }, + "type": "object" + }, + "GoldengateConnectionProperties": { + "description": "The properties of a GoldengateConnection.", + "id": "GoldengateConnectionProperties", + "properties": { + "amazonKinesisConnectionProperties": { + "$ref": "GoldengateAmazonKinesisConnectionProperties", + "description": "Properties for an Amazon Kinesis connection." }, - "localBackupEnabled": { - "description": "Optional. Use local backup.", - "type": "boolean" + "amazonRedshiftConnectionProperties": { + "$ref": "GoldengateAmazonRedshiftConnectionProperties", + "description": "Properties for an Amazon Redshift connection." }, - "memorySizeGb": { - "description": "Optional. Memory allocated in GBs.", - "format": "int32", - "type": "integer" + "amazonS3ConnectionProperties": { + "$ref": "GoldengateAmazonS3ConnectionProperties", + "description": "Properties for an Amazon S3 connection." }, - "nodeCount": { - "description": "Optional. Number of database servers.", - "format": "int32", - "type": "integer" + "azureDataLakeStorageConnectionProperties": { + "$ref": "GoldengateAzureDataLakeStorageConnectionProperties", + "description": "Properties for an Azure Data Lake Storage Connection." }, - "ociUrl": { - "description": "Output only. Deep link to the OCI console to view this resource.", - "readOnly": true, + "azureSynapseAnalyticsConnectionProperties": { + "$ref": "GoldengateAzureSynapseAnalyticsConnectionProperties", + "description": "Properties for an Azure Synapse Analytics connection." + }, + "connectionType": { + "description": "Required. The connection type.", + "enum": [ + "GOLDENGATE_CONNECTION_TYPE_UNSPECIFIED", + "GOLDENGATE", + "KAFKA", + "KAFKA_SCHEMA_REGISTRY", + "MYSQL", + "JAVA_MESSAGE_SERVICE", + "MICROSOFT_SQLSERVER", + "OCI_OBJECT_STORAGE", + "ORACLE", + "AZURE_DATA_LAKE_STORAGE", + "POSTGRESQL", + "AZURE_SYNAPSE_ANALYTICS", + "SNOWFLAKE", + "AMAZON_S3", + "HDFS", + "ORACLE_AI_DATA_PLATFORM", + "ORACLE_NOSQL", + "MONGODB", + "AMAZON_KINESIS", + "AMAZON_REDSHIFT", + "DB2", + "REDIS", + "ELASTICSEARCH", + "GENERIC", + "GOOGLE_CLOUD_STORAGE", + "GOOGLE_BIGQUERY", + "DATABRICKS", + "GOOGLE_PUBSUB", + "MICROSOFT_FABRIC", + "ICEBERG" + ], + "enumDescriptions": [ + "Connection type unspecified.", + "Goldengate connection type.", + "Kafka connection type.", + "Kafka schema registry connection type.", + "MySQL connection type.", + "Java message service connection type.", + "Microsoft SQL Server connection type.", + "OCI object storage connection type.", + "Oracle connection type.", + "Azure data lake storage connection type.", + "PostgreSQL connection type.", + "Azure synapse analytics connection type.", + "Snowflake connection type.", + "Amazon S3 connection type.", + "HDFS connection type.", + "Oracle AI data platform connection type.", + "Oracle NoSQL connection type.", + "MongoDB connection type.", + "Amazon Kinesis connection type.", + "Amazon Redshift connection type.", + "DB2 connection type.", + "Redis connection type.", + "Elasticsearch connection type.", + "Generic connection type.", + "Google Cloud Storage connection type.", + "Google BigQuery connection type.", + "Databricks connection type.", + "Google Pub/Sub connection type.", + "Microsoft Fabric connection type.", + "Iceberg connection type." + ], + "type": "string" + }, + "databricksConnectionProperties": { + "$ref": "GoldengateDatabricksConnectionProperties", + "description": "Properties for a Databricks connection." + }, + "db2ConnectionProperties": { + "$ref": "GoldengateDb2ConnectionProperties", + "description": "Properties for a DB2 connection." + }, + "description": { + "description": "Optional. Metadata about this specific object.", "type": "string" }, - "ocid": { - "description": "Output only. Oracle Cloud Infrastructure ID of VM Cluster.", - "readOnly": true, + "displayName": { + "description": "Required. An object's Display Name.", "type": "string" }, - "ocpuCount": { - "description": "Optional. OCPU count per VM. Minimum is 0.1.", - "format": "float", - "type": "number" + "elasticsearchConnectionProperties": { + "$ref": "GoldengateElasticsearchConnectionProperties", + "description": "Properties for an Elasticsearch connection." }, - "scanDns": { - "description": "Output only. SCAN DNS name. ex: sp2-yi0xq-scan.ocispdelegated.ocisp10jvnet.oraclevcn.com", - "readOnly": true, - "type": "string" + "genericConnectionProperties": { + "$ref": "GoldengateGenericConnectionProperties", + "description": "Properties for a Generic Connection." }, - "scanDnsRecordId": { - "description": "Output only. OCID of scan DNS record.", - "readOnly": true, - "type": "string" + "goldengateConnectionProperties": { + "$ref": "GoldengateGoldengateConnectionProperties", + "description": "Properties for a Goldengate Connection." }, - "scanIpIds": { - "description": "Output only. OCIDs of scan IPs.", + "googleBigQueryConnectionProperties": { + "$ref": "GoldengateGoogleBigQueryConnectionProperties", + "description": "Properties for a Google BigQuery Connection." + }, + "googleCloudStorageConnectionProperties": { + "$ref": "GoldengateGoogleCloudStorageConnectionProperties", + "description": "Properties for a Google Cloud Storage Connection." + }, + "googlePubsubConnectionProperties": { + "$ref": "GoldengateGooglePubsubConnectionProperties", + "description": "Properties for a Google Pub/Sub connection." + }, + "hdfsConnectionProperties": { + "$ref": "GoldengateHdfsConnectionProperties", + "description": "Properties for an HDFS connection." + }, + "icebergConnectionProperties": { + "$ref": "GoldengateIcebergConnectionProperties", + "description": "Properties for an Iceberg connection." + }, + "ingressIpAddresses": { + "description": "Output only. The Ingress IPs of the GoldengateConnection.", "items": { "type": "string" }, "readOnly": true, "type": "array" }, - "scanListenerPortTcp": { - "description": "Output only. SCAN listener port - TCP", - "format": "int32", - "readOnly": true, - "type": "integer" + "javaMessageServiceConnectionProperties": { + "$ref": "GoldengateJavaMessageServiceConnectionProperties", + "description": "Properties for a Java Message Service connection." }, - "scanListenerPortTcpSsl": { - "description": "Output only. SCAN listener port - TLS", - "format": "int32", - "readOnly": true, - "type": "integer" + "kafkaConnectionProperties": { + "$ref": "GoldengateKafkaConnectionProperties", + "description": "Properties for a Kafka Connection." }, - "shape": { - "description": "Output only. Shape of VM Cluster.", + "kafkaSchemaRegistryConnectionProperties": { + "$ref": "GoldengateKafkaSchemaRegistryConnectionProperties", + "description": "Properties for a Kafka Schema Registry Connection." + }, + "lifecycleDetails": { + "description": "Output only. Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.", "readOnly": true, "type": "string" }, - "sparseDiskgroupEnabled": { - "description": "Optional. Use exadata sparse snapshots.", - "type": "boolean" - }, - "sshPublicKeys": { - "description": "Optional. SSH public keys to be stored with cluster.", - "items": { - "type": "string" - }, - "type": "array" - }, - "state": { - "description": "Output only. State of the cluster.", + "lifecycleState": { + "description": "Output only. The lifecycle state of the connection.", "enum": [ - "STATE_UNSPECIFIED", - "PROVISIONING", - "AVAILABLE", + "GOLDENGATE_CONNECTION_LIFECYCLE_STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", "UPDATING", - "TERMINATING", - "TERMINATED", - "FAILED", - "MAINTENANCE_IN_PROGRESS" + "DELETING", + "DELETED", + "FAILED" ], "enumDescriptions": [ "Default unspecified value.", "Indicates that the resource is in provisioning state.", - "Indicates that the resource is in available state.", + "Indicates that the resource is in active state.", "Indicates that the resource is in updating state.", - "Indicates that the resource is in terminating state.", - "Indicates that the resource is in terminated state.", - "Indicates that the resource is in failed state.", - "Indicates that the resource is in maintenance in progress state." + "Indicates that the resource is in deleting state.", + "Indicates that the resource is in deleted state.", + "Indicates that the resource is in failed state." ], "readOnly": true, "type": "string" }, - "storageSizeGb": { - "description": "Output only. The storage allocation for the disk group, in gigabytes (GB).", - "format": "int32", + "microsoftFabricConnectionProperties": { + "$ref": "GoldengateMicrosoftFabricConnectionProperties", + "description": "Properties for a Microsoft Fabric connection." + }, + "microsoftSqlserverConnectionProperties": { + "$ref": "GoldengateMicrosoftSqlserverConnectionProperties", + "description": "Properties for a Microsoft SQL Server connection." + }, + "mongodbConnectionProperties": { + "$ref": "GoldengateMongodbConnectionProperties", + "description": "Properties for a MongoDB connection." + }, + "mysqlConnectionProperties": { + "$ref": "GoldengateMysqlConnectionProperties", + "description": "Properties for a Mysql Connection." + }, + "ociObjectStorageConnectionProperties": { + "$ref": "GoldengateOciObjectStorageConnectionProperties", + "description": "Properties for an OCI Object Storage Connection." + }, + "ocid": { + "description": "Output only. The [OCID] of the connection being referenced.", "readOnly": true, - "type": "integer" + "type": "string" }, - "systemVersion": { - "description": "Optional. Operating system version of the image.", + "oracleAiDataPlatformConnectionProperties": { + "$ref": "GoldengateOracleAIDataPlatformConnectionProperties", + "description": "Properties for an Oracle AI Data Platform connection." + }, + "oracleConnectionProperties": { + "$ref": "GoldengateOracleConnectionProperties", + "description": "Properties for an Oracle Database Connection." + }, + "oracleNosqlConnectionProperties": { + "$ref": "GoldengateOracleNosqlConnectionProperties", + "description": "Properties for an Oracle NoSQL connection." + }, + "postgresqlConnectionProperties": { + "$ref": "GoldengatePostgresqlConnectionProperties", + "description": "Properties for a PostgreSQL connection." + }, + "redisConnectionProperties": { + "$ref": "GoldengateRedisConnectionProperties", + "description": "Properties for a Redis connection." + }, + "routingMethod": { + "description": "Optional. The routing method for the GoldengateConnection.", + "enum": [ + "GOLDENGATE_CONNECTION_ROUTING_METHOD_UNSPECIFIED", + "SHARED_DEPLOYMENT_ENDPOINT", + "DEDICATED_ENDPOINT" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.", + "A dedicated private endpoint is created in the target VCN subnet for the connection." + ], "type": "string" }, - "timeZone": { - "$ref": "TimeZone", - "description": "Optional. Time zone of VM Cluster to set. Defaults to UTC if not specified." - } - }, - "type": "object" - }, - "CustomerContact": { - "description": "The CustomerContact reference as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/CustomerContact", - "id": "CustomerContact", - "properties": { - "email": { - "description": "Required. The email address used by Oracle to send notifications regarding databases and infrastructure.", + "snowflakeConnectionProperties": { + "$ref": "GoldengateSnowflakeConnectionProperties", + "description": "Properties for a Snowflake connection." + }, + "updateTime": { + "description": "Output only. The time the resource was last updated.", + "format": "google-datetime", + "readOnly": true, "type": "string" } }, "type": "object" }, - "DataCollectionOptions": { - "description": "Data collection options for diagnostics.", - "id": "DataCollectionOptions", + "GoldengateConnectionType": { + "description": "Details of the Goldengate Connection Type resource.", + "id": "GoldengateConnectionType", "properties": { - "diagnosticsEventsEnabled": { - "description": "Optional. Indicates whether diagnostic collection is enabled for the VM cluster", - "type": "boolean" + "connectionType": { + "description": "Output only. The connection type of the Goldengate Connection Type resource.", + "enum": [ + "CONNECTION_TYPE_UNSPECIFIED", + "GOLDENGATE", + "KAFKA", + "KAFKA_SCHEMA_REGISTRY", + "MYSQL", + "JAVA_MESSAGE_SERVICE", + "MICROSOFT_SQLSERVER", + "OCI_OBJECT_STORAGE", + "ORACLE", + "AZURE_DATA_LAKE_STORAGE", + "POSTGRESQL", + "AZURE_SYNAPSE_ANALYTICS", + "SNOWFLAKE", + "AMAZON_S3", + "HDFS", + "ORACLE_AI_DATA_PLATFORM", + "ORACLE_NOSQL", + "MONGODB", + "AMAZON_KINESIS", + "AMAZON_REDSHIFT", + "DB2", + "REDIS", + "ELASTICSEARCH", + "GENERIC", + "GOOGLE_CLOUD_STORAGE", + "GOOGLE_BIGQUERY", + "DATABRICKS", + "GOOGLE_PUBSUB", + "MICROSOFT_FABRIC", + "ICEBERG" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Goldengate Connection Type category is GOLDENGATE.", + "Goldengate Connection Type category is KAFKA.", + "Goldengate Connection Type category is KAFKA_SCHEMA_REGISTRY.", + "Goldengate Connection Type category is MYSQL.", + "Goldengate Connection Type category is JAVA_MESSAGE_SERVICE.", + "Goldengate Connection Type category is MICROSOFT_SQLSERVER.", + "Goldengate Connection Type category is OCI_OBJECT_STORAGE.", + "Goldengate Connection Type category is ORACLE.", + "Goldengate Connection Type category is AZURE_DATA_LAKE_STORAGE.", + "Goldengate Connection Type category is POSTGRESQL.", + "Goldengate Connection Type category is AZURE_SYNAPSE_ANALYTICS.", + "Goldengate Connection Type category is SNOWFLAKE.", + "Goldengate Connection Type category is AMAZON_S3.", + "Goldengate Connection Type category is HDFS.", + "Goldengate Connection Type category is ORACLE_AI_DATA_PLATFORM.", + "Goldengate Connection Type category is ORACLE_NOSQL.", + "Goldengate Connection Type category is MONGODB.", + "Goldengate Connection Type category is AMAZON_KINESIS.", + "Goldengate Connection Type category is AMAZON_REDSHIFT.", + "Goldengate Connection Type category is DB2.", + "Goldengate Connection Type category is REDIS.", + "Goldengate Connection Type category is ELASTICSEARCH.", + "Goldengate Connection Type category is GENERIC.", + "Goldengate Connection Type category is GOOGLE_CLOUD_STORAGE.", + "Goldengate Connection Type category is GOOGLE_BIGQUERY.", + "Goldengate Connection Type category is DATABRICKS.", + "Goldengate Connection Type category is GOOGLE_PUBSUB.", + "Goldengate Connection Type category is MICROSOFT_FABRIC.", + "Goldengate Connection Type category is ICEBERG." + ], + "readOnly": true, + "type": "string" }, - "healthMonitoringEnabled": { - "description": "Optional. Indicates whether health monitoring is enabled for the VM cluster", - "type": "boolean" + "name": { + "description": "Identifier. The name of the Goldengate Connection Type resource with the format: projects/{project}/locations/{region}/goldengateConnectionTypes/{goldengate_connection_type}", + "type": "string" }, - "incidentLogsEnabled": { - "description": "Optional. Indicates whether incident logs and trace collection are enabled for the VM cluster", - "type": "boolean" + "technologyTypes": { + "description": "Output only. The technology type of the Goldengate Connection Type resource.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" } }, "type": "object" }, - "DataCollectionOptionsCommon": { - "description": "Data collection options for diagnostics. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DataCollectionOptions", - "id": "DataCollectionOptionsCommon", + "GoldengateDatabricksConnectionProperties": { + "description": "The properties of GoldengateDatabricksConnection.", + "id": "GoldengateDatabricksConnectionProperties", "properties": { - "isDiagnosticsEventsEnabled": { - "description": "Optional. Indicates whether to enable data collection for diagnostics.", - "type": "boolean" + "authenticationType": { + "description": "Optional. Authentication type for Databricks.", + "enum": [ + "DATABRICKS_AUTHENTICATION_TYPE_UNSPECIFIED", + "PERSONAL_ACCESS_TOKEN", + "OAUTH_M2M" + ], + "enumDescriptions": [ + "Authentication type not specified.", + "Personal access token authentication.", + "OAuth M2M authentication." + ], + "type": "string" }, - "isHealthMonitoringEnabled": { - "description": "Optional. Indicates whether to enable health monitoring.", - "type": "boolean" + "clientId": { + "description": "Optional. OAuth client id, only applicable for authentication_type == OAUTH_M2M", + "type": "string" }, - "isIncidentLogsEnabled": { - "description": "Optional. Indicates whether to enable incident logs and trace collection.", - "type": "boolean" - } - }, - "type": "object" - }, - "DataCollectionOptionsDbSystem": { - "description": "Data collection options for DbSystem.", - "id": "DataCollectionOptionsDbSystem", - "properties": { - "isDiagnosticsEventsEnabled": { - "description": "Optional. Indicates whether to enable data collection for diagnostics.", - "type": "boolean" + "clientSecret": { + "description": "Optional. OAuth client secret, only applicable for authentication_type == OAUTH_M2M", + "type": "string" }, - "isIncidentLogsEnabled": { - "description": "Optional. Indicates whether to enable incident logs and trace collection.", - "type": "boolean" + "connectionUrl": { + "description": "Optional. Connection URL. e.g.: 'jdbc:databricks://adb-33934.4.azuredatabricks.net:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/3393########44/0##3-7-hlrb'", + "type": "string" + }, + "password": { + "description": "Optional. Input only. The password used to connect to Databricks in plain text.", + "type": "string" + }, + "passwordSecretVersion": { + "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password used to connect to Databricks. Format: projects/{project}/secrets/{secret}/versions/{version}.", + "type": "string" + }, + "storageCredential": { + "description": "Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or Cloud Storage.", + "type": "string" + }, + "technologyType": { + "description": "Optional. The technology type of DatabricksConnection.", + "type": "string" } }, "type": "object" }, - "Database": { - "description": "Details of the Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/Database/", - "id": "Database", + "GoldengateDb2ConnectionProperties": { + "description": "The properties of GoldengateDb2Connection.", + "id": "GoldengateDb2ConnectionProperties", "properties": { - "adminPassword": { - "description": "Optional. The password for the default ADMIN user. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated.", + "additionalAttributes": { + "description": "Optional. An array of name-value pair attribute entries. Used as additional parameters in connection string.", + "items": { + "$ref": "NameValuePair" + }, + "type": "array" + }, + "database": { + "description": "Optional. The name of the database.", "type": "string" }, - "adminPasswordSecretVersion": { - "description": "Optional. The resource name of a secret version in Secret Manager which contains the database admin user's password. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated.", + "host": { + "description": "Optional. The name or address of a host.", "type": "string" }, - "characterSet": { - "description": "Optional. The character set for the database. The default is AL32UTF8.", + "password": { + "description": "Optional. Input only. The password Oracle Goldengate uses for Db2 connection in plain text.", "type": "string" }, - "createTime": { - "description": "Output only. The date and time that the Database was created.", - "format": "google-datetime", - "readOnly": true, + "passwordSecretVersion": { + "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses for Db2 connection. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, - "databaseId": { - "description": "Optional. The database ID of the Database.", + "port": { + "description": "Optional. The port of an endpoint usually specified for a connection.", + "format": "int32", + "type": "integer" + }, + "securityProtocol": { + "description": "Optional. Security protocol for the DB2 database.", + "enum": [ + "DB2_SECURITY_PROTOCOL_UNSPECIFIED", + "PLAIN", + "TLS" + ], + "enumDescriptions": [ + "Security protocol not specified.", + "Plain text communication.", + "Transport Layer Security." + ], "type": "string" }, - "dbHomeName": { - "description": "Optional. The name of the DbHome resource associated with the Database.", + "sslClientKeystashFile": { + "description": "Optional. The keystash file which contains the encrypted password to the key database file. Not supported for IBM Db2 for i.", "type": "string" }, - "dbName": { - "description": "Optional. The database name. The name must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.", + "sslClientKeystoredbFile": { + "description": "Optional. The keystore file created at the client containing the server certificate / CA root certificate. Not supported for IBM Db2 for i.", "type": "string" }, - "dbUniqueName": { - "description": "Optional. The DB_UNIQUE_NAME of the Oracle Database being backed up.", + "sslServerCertificateFile": { + "description": "Optional. The file which contains the self-signed server certificate / Certificate Authority (CA) certificate.", "type": "string" }, - "gcpOracleZone": { - "description": "Output only. The GCP Oracle zone where the Database is created.", + "technologyType": { + "description": "Optional. The technology type of Db2Connection.", + "type": "string" + }, + "username": { + "description": "Optional. The username Oracle Goldengate uses to connect to the DB2 database.", + "type": "string" + } + }, + "type": "object" + }, + "GoldengateDeployment": { + "description": "GoldengateDeployment Goldengate Deployment resource model.", + "id": "GoldengateDeployment", + "properties": { + "createTime": { + "description": "Output only. The date and time that the GoldengateDeployment was created.", + "format": "google-datetime", "readOnly": true, "type": "string" }, - "name": { - "description": "Identifier. The name of the Database resource in the following format: projects/{project}/locations/{region}/databases/{database}", + "displayName": { + "description": "Required. The display name for the GoldengateDeployment.", "type": "string" }, - "ncharacterSet": { - "description": "Optional. The national character set for the database. The default is AL16UTF16.", + "entitlementId": { + "description": "Output only. The ID of the subscription entitlement associated with the GoldengateDeployment", + "readOnly": true, + "type": "string" + }, + "gcpOracleZone": { + "description": "Optional. The GCP Oracle zone where Oracle GoldengateDeployment is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The labels or tags associated with the GoldengateDeployment.", + "type": "object" + }, + "name": { + "description": "Identifier. The name of the GoldengateDeployment resource in the following format: projects/{project}/locations/{region}/goldengateDeployments/{goldengate_deployment}", "type": "string" }, "ociUrl": { @@ -4314,1594 +7681,2092 @@ "readOnly": true, "type": "string" }, - "opsInsightsStatus": { - "description": "Output only. The Status of Operations Insights for this Database.", + "odbNetwork": { + "description": "Optional. The name of the OdbNetwork associated with the GoldengateDeployment.", + "type": "string" + }, + "odbSubnet": { + "description": "Required. The name of the OdbSubnet associated with the GoldengateDeployment for IP allocation.", + "type": "string" + }, + "properties": { + "$ref": "GoldengateDeploymentProperties", + "description": "Required. The properties of the GoldengateDeployment." + } + }, + "type": "object" + }, + "GoldengateDeploymentEnvironment": { + "description": "Details of the Goldengate Deployment Environment resource.", + "id": "GoldengateDeploymentEnvironment", + "properties": { + "autoScalingEnabled": { + "description": "Output only. Whether auto scaling is enabled by default for the Goldengate Deployment Environment resource.", + "readOnly": true, + "type": "boolean" + }, + "category": { + "description": "Output only. The category of the Goldengate Deployment Environment resource.", "enum": [ - "OPERATIONS_INSIGHTS_STATUS_UNSPECIFIED", - "ENABLING", - "ENABLED", - "DISABLING", - "NOT_ENABLED", - "FAILED_ENABLING", - "FAILED_DISABLING" + "DEPLOYMENT_CATEGORY_UNSPECIFIED", + "DATA_REPLICATION_CATEGORY", + "DATA_TRANSFORMS_CATEGORY" ], "enumDescriptions": [ "Default unspecified value.", - "Indicates that the operations insights are being enabled.", - "Indicates that the operations insights are enabled.", - "Indicates that the operations insights are being disabled.", - "Indicates that the operations insights are not enabled.", - "Indicates that the operations insights failed to enable.", - "Indicates that the operations insights failed to disable." + "Goldengate Deployment Environment category is DATA_REPLICATION_CATEGORY.", + "Goldengate Deployment Environment category is DATA_TRANSFORMS_CATEGORY." ], "readOnly": true, "type": "string" }, - "pluggableDatabaseId": { - "description": "Optional. The ID of the pluggable database associated with the Database. The ID must be unique within the project and location.", + "defaultCpuCoreCount": { + "description": "Output only. The default CPU core count of the Goldengate Deployment Environment resource.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "displayName": { + "description": "The display name of the Goldengate Deployment Environment resource.", "type": "string" }, - "pluggableDatabaseName": { - "description": "Optional. The pluggable database associated with the Database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters.", + "environmentType": { + "description": "Output only. The environment type of the Goldengate Deployment Environment resource.", + "enum": [ + "DEPLOYMENT_ENVIRONMENT_TYPE_UNSPECIFIED", + "PRODUCTION", + "DEVELOPMENT_OR_TESTING" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Goldengate Deployment Environment type is PRODUCTION.", + "Goldengate Deployment Environment type is DEVELOPMENT_OR_TESTING." + ], + "readOnly": true, "type": "string" }, - "properties": { - "$ref": "DatabaseProperties", - "description": "Optional. The properties of the Database." + "maxCpuCoreCount": { + "description": "Output only. The max CPU core count of the Goldengate Deployment Environment resource.", + "format": "int32", + "readOnly": true, + "type": "integer" }, - "tdeWalletPassword": { - "description": "Optional. The TDE wallet password for the database. Note: Only one of `tde_wallet_password_secret_version` or `tde_wallet_password` can be populated.", - "type": "string" + "memoryGbPerCpuCore": { + "description": "Output only. The memory per CPU core in GBs of the Goldengate Deployment Environment resource.", + "format": "int32", + "readOnly": true, + "type": "integer" }, - "tdeWalletPasswordSecretVersion": { - "description": "Optional. The resource name of a secret version in Secret Manager which contains the TDE wallet password for the database. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `tde_wallet_password_secret_version` or `tde_wallet_password` can be populated.", + "minCpuCoreCount": { + "description": "Output only. The min CPU core count of the Goldengate Deployment Environment resource.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "name": { + "description": "Identifier. The name of the Goldengate Deployment Environment resource with the format: projects/{project}/locations/{location}/goldengateDeploymentEnvironments/{goldengate_deployment_environment}", "type": "string" + }, + "networkBandwidthGbpsPerCpuCore": { + "description": "Output only. The network bandwidth per CPU core in Gbps of the Goldengate Deployment Environment resource.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "storageUsageLimitGbPerCpuCore": { + "description": "Output only. The storage usage limit per CPU core in GBs of the Goldengate Deployment Environment resource.", + "format": "int32", + "readOnly": true, + "type": "integer" } }, "type": "object" }, - "DatabaseCharacterSet": { - "description": "Details of the Database character set resource.", - "id": "DatabaseCharacterSet", + "GoldengateDeploymentLock": { + "description": "The lock of the GoldengateDeployment.", + "id": "GoldengateDeploymentLock", "properties": { - "characterSet": { - "description": "Output only. The character set name for the Database which is the ID in the resource name.", + "compartmentId": { + "description": "Output only. The compartment id.", "readOnly": true, "type": "string" }, - "characterSetType": { - "description": "Output only. The character set type for the Database.", + "createTime": { + "description": "Output only. The time created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "Output only. The message.", + "readOnly": true, + "type": "string" + }, + "relatedResourceId": { + "description": "Output only. The related resource id.", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Output only. The type of lock.", "enum": [ - "CHARACTER_SET_TYPE_UNSPECIFIED", - "DATABASE", - "NATIONAL" + "LOCK_TYPE_UNSPECIFIED", + "FULL", + "DELETE" ], "enumDescriptions": [ - "Character set type is not specified.", - "Character set type is set to database.", - "Character set type is set to national." + "The lock type is unspecified.", + "The lock type is full.", + "The lock type is delete." ], "readOnly": true, "type": "string" - }, - "name": { - "description": "Identifier. The name of the Database Character Set resource in the following format: projects/{project}/locations/{region}/databaseCharacterSets/{database_character_set}", - "type": "string" } }, "type": "object" }, - "DatabaseConnectionStringProfile": { - "description": "The connection string profile to allow clients to group. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DatabaseConnectionStringProfile", - "id": "DatabaseConnectionStringProfile", + "GoldengateDeploymentProperties": { + "description": "Properties of GoldengateDeployment.", + "id": "GoldengateDeploymentProperties", "properties": { - "consumerGroup": { - "description": "Output only. The current consumer group being used by the connection.", + "backupSchedule": { + "$ref": "GoldengateBackupSchedule", + "description": "Output only. The backup schedule of the GoldengateDeployment.", + "readOnly": true + }, + "category": { + "description": "Output only. The category of the GoldengateDeployment.", "enum": [ - "CONSUMER_GROUP_UNSPECIFIED", - "HIGH", - "MEDIUM", - "LOW", - "TP", - "TPURGENT" + "GOLDENGATE_DEPLOYMENT_CATEGORY_UNSPECIFIED", + "DATA_REPLICATION", + "DATA_TRANSFORMS" ], "enumDescriptions": [ - "Default unspecified value.", - "High consumer group.", - "Medium consumer group.", - "Low consumer group.", - "TP consumer group.", - "TPURGENT consumer group." + "The category is unspecified.", + "The deployment is data replication.", + "The deployment is data transforms." ], "readOnly": true, "type": "string" }, - "displayName": { - "description": "Output only. The display name for the database connection.", + "cpuCoreCount": { + "description": "Optional. The Minimum number of OCPUs to be made available for this Deployment.", + "format": "int32", + "type": "integer" + }, + "deploymentBackupId": { + "description": "Output only. The deployment backup id of the GoldengateDeployment.", "readOnly": true, "type": "string" }, - "hostFormat": { - "description": "Output only. The host name format being currently used in connection string.", + "deploymentDiagnosticData": { + "$ref": "DeploymentDiagnosticData", + "description": "Output only. The deployment diagnostic data of the GoldengateDeployment.", + "readOnly": true + }, + "deploymentRole": { + "description": "Output only. The deployment role of the GoldengateDeployment.", "enum": [ - "HOST_FORMAT_UNSPECIFIED", - "FQDN", - "IP" + "GOLDENGATE_DEPLOYMENT_ROLE_TYPE_UNSPECIFIED", + "PRIMARY", + "STANDBY" ], "enumDescriptions": [ - "Default unspecified value.", - "FQDN", - "IP" + "The deployment role type is unspecified.", + "The deployment role type is primary.", + "The deployment role type is standby." + ], + "readOnly": true, + "type": "string" + }, + "deploymentType": { + "description": "Required. A valid Goldengate Deployment type. For a list of supported types, use the `ListGoldengateDeploymentTypes` operation.", + "type": "string" + }, + "deploymentUrl": { + "description": "Output only. The deployment url of the GoldengateDeployment.", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. The description of the GoldengateDeployment.", + "type": "string" + }, + "environmentType": { + "description": "Optional. The environment type of the GoldengateDeployment.", + "type": "string" + }, + "fqdn": { + "description": "Output only. The Fully Qualified Domain Name of the GoldengateDeployment.", + "readOnly": true, + "type": "string" + }, + "healthy": { + "description": "Output only. Whether the GoldengateDeployment is healthy.", + "readOnly": true, + "type": "boolean" + }, + "ingressIps": { + "description": "Output only. The ingress ips of the GoldengateDeployment.", + "items": { + "$ref": "IngressIp" + }, + "readOnly": true, + "type": "array" + }, + "isAutoScalingEnabled": { + "description": "Optional. Indicates if auto scaling is enabled for the Deployment's CPU core count.", + "type": "boolean" + }, + "isLatestVersion": { + "description": "Output only. Whether the GoldengateDeployment is of the latest version.", + "readOnly": true, + "type": "boolean" + }, + "isPublic": { + "description": "Output only. Whether the GoldengateDeployment is public.", + "readOnly": true, + "type": "boolean" + }, + "isStorageUtilizationLimitExceeded": { + "description": "Output only. Whether storage utilization limit is exceeded of the GoldengateDeployment.", + "readOnly": true, + "type": "boolean" + }, + "lastBackupScheduleTime": { + "description": "Output only. The time last backup scheduled of the GoldengateDeployment.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "licenseModel": { + "description": "Optional. The Oracle license model that applies to a Deployment.", + "enum": [ + "LICENSE_MODEL_UNSPECIFIED", + "LICENSE_INCLUDED", + "BRING_YOUR_OWN_LICENSE" + ], + "enumDescriptions": [ + "The license model is unspecified.", + "The license model is included.", + "The license model is bring your own license." ], - "readOnly": true, "type": "string" }, - "isRegional": { - "description": "Output only. This field indicates if the connection string is regional and is only applicable for cross-region Data Guard.", + "lifecycleDetails": { + "description": "Output only. The lifecycle details of the GoldengateDeployment.", "readOnly": true, - "type": "boolean" + "type": "string" }, - "protocol": { - "description": "Output only. The protocol being used by the connection.", + "lifecycleState": { + "description": "Output only. State of the GoldengateDeployment.", "enum": [ - "PROTOCOL_UNSPECIFIED", - "TCP", - "TCPS" + "GOLDENGATE_DEPLOYMENT_LIFECYCLE_STATE_UNSPECIFIED", + "CREATING", + "UPDATING", + "ACTIVE", + "INACTIVE", + "DELETING", + "DELETED", + "FAILED", + "NEEDS_ATTENTION", + "IN_PROGRESS", + "CANCELLING", + "CANCELLED", + "SUCCEEDED", + "WAITING" ], "enumDescriptions": [ "Default unspecified value.", - "Tcp", - "Tcps" + "The deployment is being created.", + "The deployment is being updated.", + "The deployment is active.", + "The deployment is inactive.", + "The deployment is being deleted.", + "The deployment is deleted.", + "The deployment failed.", + "The deployment needs attention.", + "The deployment is in progress.", + "The deployment is canceling.", + "The deployment is canceled.", + "The deployment succeeded.", + "The deployment is waiting." ], "readOnly": true, "type": "string" }, - "sessionMode": { - "description": "Output only. The current session mode of the connection.", + "lifecycleSubState": { + "description": "Output only. The lifecycle sub-state of the GoldengateDeployment.", "enum": [ - "SESSION_MODE_UNSPECIFIED", - "DIRECT", - "INDIRECT" + "GOLDENGATE_DEPLOYMENT_LIFECYCLE_SUB_STATE_UNSPECIFIED", + "RECOVERING", + "STARTING", + "STOPPING", + "MOVING", + "UPGRADING", + "RESTORING", + "BACKING_UP", + "ROLLING_BACK" ], "enumDescriptions": [ - "Default unspecified value.", - "Direct", - "Indirect" + "The lifecycle sub-state is unspecified.", + "The deployment is recovering.", + "The deployment is starting.", + "The deployment is stopping.", + "The deployment is moving.", + "The deployment is upgrading.", + "The deployment is restoring.", + "The deployment is backing up.", + "The deployment is rolling back." ], "readOnly": true, "type": "string" }, - "syntaxFormat": { - "description": "Output only. The syntax of the connection string.", - "enum": [ - "SYNTAX_FORMAT_UNSPECIFIED", - "LONG", - "EZCONNECT", - "EZCONNECTPLUS" - ], - "enumDescriptions": [ - "Default unspecified value.", - "Long", - "Ezconnect", - "Ezconnectplus" - ], + "loadBalancerId": { + "description": "Output only. The load balancer id of the GoldengateDeployment.", "readOnly": true, "type": "string" }, - "tlsAuthentication": { - "description": "Output only. This field indicates the TLS authentication type of the connection.", - "enum": [ - "TLS_AUTHENTICATION_UNSPECIFIED", - "SERVER", - "MUTUAL" - ], - "enumDescriptions": [ - "Default unspecified value.", - "Server", - "Mutual" - ], + "loadBalancerSubnetId": { + "description": "Output only. The load balancer subnet id of the GoldengateDeployment.", "readOnly": true, "type": "string" }, - "value": { - "description": "Output only. The value of the connection string.", + "locks": { + "description": "Output only. The locks of the GoldengateDeployment.", + "items": { + "$ref": "GoldengateDeploymentLock" + }, + "readOnly": true, + "type": "array" + }, + "maintenanceConfig": { + "$ref": "GoldengateMaintenanceConfig", + "description": "Optional. The maintenance configuration of the GoldengateDeployment." + }, + "maintenanceWindow": { + "$ref": "GoldengateMaintenanceWindow", + "description": "Optional. The maintenance window of the GoldengateDeployment." + }, + "nextBackupScheduleTime": { + "description": "Output only. The time next backup scheduled of the GoldengateDeployment.", + "format": "google-datetime", "readOnly": true, "type": "string" - } - }, - "type": "object" - }, - "DatabaseManagementConfig": { - "description": "The configuration of the Database Management service.", - "id": "DatabaseManagementConfig", - "properties": { - "managementState": { - "description": "Output only. The status of the Database Management service.", + }, + "nextMaintenanceActionType": { + "description": "Output only. The next maintenance action type of the GoldengateDeployment.", "enum": [ - "MANAGEMENT_STATE_UNSPECIFIED", - "ENABLING", - "ENABLED", - "DISABLING", - "DISABLED", - "UPDATING", - "FAILED_ENABLING", - "FAILED_DISABLING", - "FAILED_UPDATING" + "NEXT_MAINTENANCE_ACTION_TYPE_UNSPECIFIED", + "UPGRADE" ], "enumDescriptions": [ - "The status is not specified.", - "The Database Management service is enabling.", - "The Database Management service is enabled.", - "The Database Management service is disabling.", - "The Database Management service is disabled.", - "The Database Management service is updating.", - "The Database Management service failed to enable.", - "The Database Management service failed to disable.", - "The Database Management service failed to update." + "The next maintenance action type is unspecified.", + "The next maintenance action type is upgrade." ], "readOnly": true, "type": "string" }, - "managementType": { - "description": "Output only. The Database Management type.", - "enum": [ - "MANAGEMENT_TYPE_UNSPECIFIED", - "BASIC", - "ADVANCED" - ], - "enumDescriptions": [ - "The type is not specified.", - "Basic Database Management.", - "Advanced Database Management." - ], + "nextMaintenanceDescription": { + "description": "Output only. The next maintenance description of the GoldengateDeployment.", "readOnly": true, "type": "string" - } - }, - "type": "object" - }, - "DatabaseProperties": { - "description": "The properties of a Database.", - "id": "DatabaseProperties", - "properties": { - "databaseManagementConfig": { - "$ref": "DatabaseManagementConfig", - "description": "Output only. The Database Management config.", - "readOnly": true }, - "dbBackupConfig": { - "$ref": "DbBackupConfig", - "description": "Optional. Backup options for the Database." + "nextMaintenanceTime": { + "description": "Output only. The time of next maintenance of the GoldengateDeployment.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "dbVersion": { - "description": "Required. The Oracle Database version.", + "nsgIds": { + "description": "Output only. The nsg ids of the GoldengateDeployment.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "ocid": { + "description": "Output only. OCID of the GoldengateDeployment.", + "readOnly": true, "type": "string" }, - "state": { - "description": "Output only. State of the Database.", - "enum": [ - "DATABASE_LIFECYCLE_STATE_UNSPECIFIED", - "PROVISIONING", - "AVAILABLE", - "UPDATING", - "BACKUP_IN_PROGRESS", - "UPGRADING", - "CONVERTING", - "TERMINATING", - "TERMINATED", - "RESTORE_FAILED", - "FAILED" - ], - "enumDescriptions": [ - "Default unspecified value.", - "Indicates that the resource is in provisioning state.", - "Indicates that the resource is in available state.", - "Indicates that the resource is in updating state.", - "Indicates that the resource is in backup in progress state.", - "Indicates that the resource is in upgrading state.", - "Indicates that the resource is in converting state.", - "Indicates that the resource is in terminating state.", - "Indicates that the resource is in terminated state.", - "Indicates that the resource is in restore failed state.", - "Indicates that the resource is in failed state." - ], + "oggData": { + "$ref": "GoldengateOggDeployment", + "description": "Required. The ogg data of the GoldengateDeployment." + }, + "oggVersionSupportEndTime": { + "description": "Output only. The time ogg version supported until of the GoldengateDeployment.", + "format": "google-datetime", "readOnly": true, "type": "string" - } - }, - "type": "object" - }, - "DbBackupConfig": { - "description": "Backup Options for the Database.", - "id": "DbBackupConfig", - "properties": { - "autoBackupEnabled": { - "description": "Optional. If set to true, enables automatic backups on the database.", - "type": "boolean" }, - "autoFullBackupDay": { - "description": "Optional. The day of the week on which the full backup should be performed on the database. If no value is provided, it will default to Sunday.", - "enum": [ - "DAY_OF_WEEK_UNSPECIFIED", - "MONDAY", - "TUESDAY", - "WEDNESDAY", - "THURSDAY", - "FRIDAY", - "SATURDAY", - "SUNDAY" - ], - "enumDescriptions": [ - "The day of the week is unspecified.", - "Monday", - "Tuesday", - "Wednesday", - "Thursday", - "Friday", - "Saturday", - "Sunday" - ], + "placements": { + "description": "Output only. The placements of the GoldengateDeployment.", + "items": { + "$ref": "GoldengatePlacement" + }, + "readOnly": true, + "type": "array" + }, + "privateIpAddress": { + "description": "Output only. The private ip address of the GoldengateDeployment.", + "readOnly": true, "type": "string" }, - "autoFullBackupWindow": { - "description": "Optional. The window in which the full backup should be performed on the database. If no value is provided, the default is anytime.", - "enum": [ - "BACKUP_WINDOW_UNSPECIFIED", - "SLOT_ONE", - "SLOT_TWO", - "SLOT_THREE", - "SLOT_FOUR", - "SLOT_FIVE", - "SLOT_SIX", - "SLOT_SEVEN", - "SLOT_EIGHT", - "SLOT_NINE", - "SLOT_TEN", - "SLOT_ELEVEN", - "SLOT_TWELVE" - ], - "enumDescriptions": [ - "Default unspecified value.", - "12:00 AM - 2:00 AM", - "2:00 AM - 4:00 AM", - "4:00 AM - 6:00 AM", - "6:00 AM - 8:00 AM", - "8:00 AM - 10:00 AM", - "10:00 AM - 12:00 PM", - "12:00 PM - 2:00 PM", - "2:00 PM - 4:00 PM", - "4:00 PM - 6:00 PM", - "6:00 PM - 8:00 PM", - "8:00 PM - 10:00 PM", - "10:00 PM - 12:00 AM" - ], + "publicIpAddress": { + "description": "Output only. The public ip address of the GoldengateDeployment.", + "readOnly": true, "type": "string" }, - "autoIncrementalBackupWindow": { - "description": "Optional. The window in which the incremental backup should be performed on the database. If no value is provided, the default is anytime except the auto full backup day.", + "roleChangeTime": { + "description": "Output only. The time when the role of the GoldengateDeployment was changed.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "storageUtilizationBytes": { + "description": "Output only. The storage utilization in bytes of the GoldengateDeployment.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time the GoldengateDeployment was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "upgradeRequiredTime": { + "description": "Output only. The time upgrade required of the GoldengateDeployment.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoldengateDeploymentType": { + "description": "Details of the Goldengate Deployment Type resource.", + "id": "GoldengateDeploymentType", + "properties": { + "category": { + "description": "Output only. The category of the Goldengate Deployment Type resource.", "enum": [ - "BACKUP_WINDOW_UNSPECIFIED", - "SLOT_ONE", - "SLOT_TWO", - "SLOT_THREE", - "SLOT_FOUR", - "SLOT_FIVE", - "SLOT_SIX", - "SLOT_SEVEN", - "SLOT_EIGHT", - "SLOT_NINE", - "SLOT_TEN", - "SLOT_ELEVEN", - "SLOT_TWELVE" + "DEPLOYMENT_CATEGORY_UNSPECIFIED", + "DATA_REPLICATION_CATEGORY", + "DATA_TRANSFORMS_CATEGORY" ], "enumDescriptions": [ "Default unspecified value.", - "12:00 AM - 2:00 AM", - "2:00 AM - 4:00 AM", - "4:00 AM - 6:00 AM", - "6:00 AM - 8:00 AM", - "8:00 AM - 10:00 AM", - "10:00 AM - 12:00 PM", - "12:00 PM - 2:00 PM", - "2:00 PM - 4:00 PM", - "4:00 PM - 6:00 PM", - "6:00 PM - 8:00 PM", - "8:00 PM - 10:00 PM", - "10:00 PM - 12:00 AM" + "Goldengate Deployment Type category is DATA_REPLICATION_CATEGORY.", + "Goldengate Deployment Type category is DATA_TRANSFORMS_CATEGORY." ], + "readOnly": true, "type": "string" }, - "backupDeletionPolicy": { - "description": "Optional. This defines when the backups will be deleted after Database termination.", + "connectionTypes": { + "description": "Output only. The connection types of the Goldengate Deployment Type resource.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "defaultUsername": { + "description": "Output only. The default username of the Goldengate Deployment Type resource.", + "readOnly": true, + "type": "string" + }, + "deploymentType": { + "description": "Output only. The deployment type of the Goldengate Deployment Type resource.", "enum": [ - "BACKUP_DELETION_POLICY_UNSPECIFIED", - "DELETE_IMMEDIATELY", - "DELETE_AFTER_RETENTION_PERIOD" + "DEPLOYMENT_TYPE_UNSPECIFIED", + "OGG", + "DATABASE_ORACLE", + "BIGDATA", + "DATABASE_MICROSOFT_SQLSERVER", + "DATABASE_MYSQL", + "DATABASE_POSTGRESQL", + "DATABASE_DB2ZOS", + "DATABASE_DB2I", + "GGSA", + "DATA_TRANSFORMS" ], "enumDescriptions": [ "Default unspecified value.", - "Keeps the backup for predefined time i.e. 72 hours and then delete permanently.", - "Keeps the backups as per the policy defined for database backups." + "Goldengate Deployment Type category is OGG.", + "Goldengate Deployment Type category is DATABASE_ORACLE.", + "Goldengate Deployment Type category is BIGDATA.", + "Goldengate Deployment Type category is DATABASE_MICROSOFT_SQLSERVER.", + "Goldengate Deployment Type category is DATABASE_MYSQL.", + "Goldengate Deployment Type category is DATABASE_POSTGRESQL.", + "Goldengate Deployment Type category is DATABASE_DB2ZOS.", + "Goldengate Deployment Type category is DATABASE_DB2I.", + "Goldengate Deployment Type category is GGSA.", + "Goldengate Deployment Type category is DATA_TRANSFORMS." ], + "readOnly": true, "type": "string" }, - "backupDestinationDetails": { - "description": "Optional. Details of the database backup destinations.", + "displayName": { + "description": "Output only. The display name of the Goldengate Deployment Type resource.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The name of the Goldengate Deployment Type resource with the format: projects/{project}/locations/{region}/goldengateDeploymentTypes/{goldengate_deployment_type}", + "type": "string" + }, + "oggVersion": { + "description": "Output only. The Ogg version of the Goldengate Deployment Type resource.", + "readOnly": true, + "type": "string" + }, + "sourceTechnologies": { + "description": "Output only. The source technologies of the Goldengate Deployment Type resource.", "items": { - "$ref": "BackupDestinationDetails" + "type": "string" }, + "readOnly": true, "type": "array" }, - "retentionPeriodDays": { - "description": "Optional. The number of days an automatic backup is retained before being automatically deleted. This value determines the earliest point in time to which a database can be restored. Min: 1, Max: 60.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "DbHome": { - "description": "Details of the Database Home resource.", - "id": "DbHome", - "properties": { - "database": { - "$ref": "Database", - "description": "Required. The Database resource." - }, - "dbVersion": { - "description": "Required. A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.", - "type": "string" + "supportedCapabilities": { + "description": "Output only. The supported capabilities of the Goldengate Deployment Type resource.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" }, - "displayName": { - "description": "Optional. The display name for the Database Home. The name does not have to be unique within your project.", + "supportedTechnologiesUrl": { + "description": "Output only. The supported technologies URL of the Goldengate Deployment Type resource.", + "readOnly": true, "type": "string" }, - "isUnifiedAuditingEnabled": { - "description": "Optional. Whether unified auditing is enabled for the Database Home.", - "type": "boolean" + "targetTechnologies": { + "description": "Output only. The target technologies of the Goldengate Deployment Type resource.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" } }, "type": "object" }, - "DbNode": { - "description": "Details of the database node resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbNode/", - "id": "DbNode", + "GoldengateDeploymentVersion": { + "description": "Details of the Goldengate Deployment Version resource.", + "id": "GoldengateDeploymentVersion", "properties": { "name": { - "description": "Identifier. The name of the database node resource in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}/dbNodes/{db_node}", + "description": "Identifier. The name of the Goldengate Deployment Version resource with the format: projects/{project}/locations/{location}/goldengateDeploymentVersions/{goldengate_deployment_version}", + "type": "string" + }, + "ocid": { + "description": "Output only. The deployment version ocid of the Goldengate Deployment Version resource.", + "readOnly": true, "type": "string" }, "properties": { - "$ref": "DbNodeProperties", - "description": "Optional. Various properties of the database node." + "$ref": "GoldengateDeploymentVersionProperties", + "description": "Output only. The technology type of the Goldengate Deployment Version resource.", + "readOnly": true } }, "type": "object" }, - "DbNodeProperties": { - "description": "Various properties and settings associated with Db node.", - "id": "DbNodeProperties", + "GoldengateDeploymentVersionProperties": { + "description": "Properties of GoldengateDeploymentVersion.", + "id": "GoldengateDeploymentVersionProperties", "properties": { - "createTime": { - "description": "Output only. The date and time that the database node was created.", - "format": "google-datetime", + "deploymentType": { + "description": "Output only. The deployment type of the Goldengate Deployment Version resource.", + "enum": [ + "DEPLOYMENT_TYPE_UNSPECIFIED", + "OGG", + "DATABASE_ORACLE", + "BIGDATA", + "DATABASE_MICROSOFT_SQLSERVER", + "DATABASE_MYSQL", + "DATABASE_POSTGRESQL", + "DATABASE_DB2ZOS", + "DATABASE_DB2I", + "GGSA", + "DATA_TRANSFORMS" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Goldengate Deployment Type category is OGG.", + "Goldengate Deployment Type category is DATABASE_ORACLE.", + "Goldengate Deployment Type category is BIGDATA.", + "Goldengate Deployment Type category is DATABASE_MICROSOFT_SQLSERVER.", + "Goldengate Deployment Type category is DATABASE_MYSQL.", + "Goldengate Deployment Type category is DATABASE_POSTGRESQL.", + "Goldengate Deployment Type category is DATABASE_DB2ZOS.", + "Goldengate Deployment Type category is DATABASE_DB2I.", + "Goldengate Deployment Type category is GGSA.", + "Goldengate Deployment Type category is DATA_TRANSFORMS." + ], "readOnly": true, "type": "string" }, - "dbNodeStorageSizeGb": { - "description": "Optional. Local storage per database node.", - "format": "int32", - "type": "integer" - }, - "dbServerOcid": { - "description": "Optional. Database server OCID.", - "type": "string" - }, - "hostname": { - "description": "Optional. DNS", + "oggVersion": { + "description": "Output only. The OGG version of the Goldengate Deployment Version resource.", + "readOnly": true, "type": "string" }, - "memorySizeGb": { - "description": "Memory allocated in GBs.", - "format": "int32", - "type": "integer" - }, - "ocid": { - "description": "Output only. OCID of database node.", + "releaseTime": { + "description": "Output only. The release time of the Goldengate Deployment Version resource.", + "format": "google-datetime", "readOnly": true, "type": "string" }, - "ocpuCount": { - "description": "Optional. OCPU count per database node.", - "format": "int32", - "type": "integer" - }, - "state": { - "description": "Output only. State of the database node.", + "releaseType": { + "description": "Output only. The release type of the Goldengate Deployment Version resource.", "enum": [ - "STATE_UNSPECIFIED", - "PROVISIONING", - "AVAILABLE", - "UPDATING", - "STOPPING", - "STOPPED", - "STARTING", - "TERMINATING", - "TERMINATED", - "FAILED" + "DEPLOYMENT_RELEASE_TYPE_UNSPECIFIED", + "MAJOR", + "BUNDLE", + "MINOR" ], "enumDescriptions": [ "Default unspecified value.", - "Indicates that the resource is in provisioning state.", - "Indicates that the resource is in available state.", - "Indicates that the resource is in updating state.", - "Indicates that the resource is in stopping state.", - "Indicates that the resource is in stopped state.", - "Indicates that the resource is in starting state.", - "Indicates that the resource is in terminating state.", - "Indicates that the resource is in terminated state.", - "Indicates that the resource is in failed state." + "Goldengate Deployment Version release type is MAJOR.", + "Goldengate Deployment Version release type is BUNDLE.", + "Goldengate Deployment Version release type is MINOR." ], "readOnly": true, "type": "string" }, - "totalCpuCoreCount": { - "description": "Total CPU core count of the database node.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "DbServer": { - "description": "Details of the database server resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbServer/", - "id": "DbServer", - "properties": { - "displayName": { - "description": "Optional. User friendly name for this resource.", - "type": "string" + "securityFix": { + "description": "Optional. Whether the Goldengate Deployment Version resource is a security fix.", + "type": "boolean" }, - "name": { - "description": "Identifier. The name of the database server resource with the format: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}/dbServers/{db_server}", + "supportEndTime": { + "description": "Output only. The support end time of the Goldengate Deployment Version resource.", + "format": "google-datetime", + "readOnly": true, "type": "string" - }, - "properties": { - "$ref": "DbServerProperties", - "description": "Optional. Various properties of the database server." } }, "type": "object" }, - "DbServerProperties": { - "description": "Various properties and settings associated with Exadata database server.", - "id": "DbServerProperties", + "GoldengateElasticsearchConnectionProperties": { + "description": "The properties of GoldengateElasticsearchConnection.", + "id": "GoldengateElasticsearchConnectionProperties", "properties": { - "dbNodeIds": { - "description": "Output only. OCID of database nodes associated with the database server.", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" - }, - "dbNodeStorageSizeGb": { - "description": "Optional. Local storage per VM.", - "format": "int32", - "type": "integer" - }, - "maxDbNodeStorageSizeGb": { - "description": "Optional. Maximum local storage per VM.", - "format": "int32", - "type": "integer" - }, - "maxMemorySizeGb": { - "description": "Optional. Maximum memory allocated in GBs.", - "format": "int32", - "type": "integer" - }, - "maxOcpuCount": { - "description": "Optional. Maximum OCPU count per database.", - "format": "int32", - "type": "integer" + "authenticationType": { + "description": "Optional. Authentication type for Elasticsearch.", + "enum": [ + "ELASTICSEARCH_AUTHENTICATION_TYPE_UNSPECIFIED", + "NONE", + "BASIC" + ], + "enumDescriptions": [ + "Authentication type not specified.", + "No authentication.", + "Basic authentication." + ], + "type": "string" }, - "memorySizeGb": { - "description": "Optional. Memory allocated in GBs.", - "format": "int32", - "type": "integer" + "fingerprint": { + "description": "Optional. Fingerprint required by TLS security protocol. Eg.: '6152b2dfbff200f973c5074a5b91d06ab3b472c07c09a1ea57bb7fd406cdce9c'", + "type": "string" }, - "ocid": { - "description": "Output only. OCID of database server.", - "readOnly": true, + "password": { + "description": "Optional. Input only. The password Oracle Goldengate uses for Elastic Search connection in plain text.", "type": "string" }, - "ocpuCount": { - "description": "Optional. OCPU count per database.", - "format": "int32", - "type": "integer" + "passwordSecretVersion": { + "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses for Elastic Search connection. Format: projects/{project}/secrets/{secret}/versions/{version}.", + "type": "string" }, - "state": { - "description": "Output only. State of the database server.", + "securityProtocol": { + "description": "Optional. Security protocol for Elasticsearch.", "enum": [ - "STATE_UNSPECIFIED", - "CREATING", - "AVAILABLE", - "UNAVAILABLE", - "DELETING", - "DELETED" - ], - "enumDescriptions": [ - "Default unspecified value.", - "Indicates that the resource is in creating state.", - "Indicates that the resource is in available state.", - "Indicates that the resource is in unavailable state.", - "Indicates that the resource is in deleting state.", - "Indicates that the resource is in deleted state." + "ELASTICSEARCH_SECURITY_PROTOCOL_UNSPECIFIED", + "PLAIN", + "TLS" + ], + "enumDescriptions": [ + "Security protocol not specified.", + "Plain text communication.", + "Transport Layer Security." ], - "readOnly": true, "type": "string" }, - "vmCount": { - "description": "Optional. Vm count per database.", - "format": "int32", - "type": "integer" + "servers": { + "description": "Optional. Comma separated list of Elasticsearch server addresses, specified as host:port entries, where :port is optional. If port is not specified, it defaults to 9200. Example: \"server1.example.com:4000,server2.example.com:4000\"", + "type": "string" + }, + "technologyType": { + "description": "Optional. The technology type of ElasticsearchConnection.", + "type": "string" + }, + "username": { + "description": "Optional. The username Oracle Goldengate uses to connect the associated system of the given technology.", + "type": "string" } }, "type": "object" }, - "DbSystem": { - "description": "Details of the DbSystem (BaseDB) resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystem/", - "id": "DbSystem", + "GoldengateGenericConnectionProperties": { + "description": "The properties of GoldengateGenericConnectionProperties.", + "id": "GoldengateGenericConnectionProperties", "properties": { - "createTime": { - "description": "Output only. The date and time that the DbSystem was created.", - "format": "google-datetime", - "readOnly": true, + "host": { + "description": "Optional. The host of the GenericConnection.", "type": "string" }, - "displayName": { - "description": "Required. The display name for the System db. The name does not have to be unique within your project.", + "technologyType": { + "description": "Optional. The technology type.", "type": "string" - }, - "entitlementId": { - "description": "Output only. The ID of the subscription entitlement associated with the DbSystem", - "readOnly": true, + } + }, + "type": "object" + }, + "GoldengateGoldengateConnectionProperties": { + "description": "The properties of GoldengateGoldengateConnectionProperties.", + "id": "GoldengateGoldengateConnectionProperties", + "properties": { + "goldengateDeploymentId": { + "description": "Optional. The name of the GoldengateDeployment associated with the GoldengateConnection. Format: projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}", "type": "string" }, - "gcpOracleZone": { - "description": "Optional. The GCP Oracle zone where Oracle DbSystem is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.", + "host": { + "description": "Optional. The host of the GoldengateConnection.", "type": "string" }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. The labels or tags associated with the DbSystem.", - "type": "object" + "password": { + "description": "Optional. Input only. The password used to connect to the Oracle Goldengate in plain text.", + "type": "string" }, - "name": { - "description": "Identifier. The name of the DbSystem resource in the following format: projects/{project}/locations/{region}/dbSystems/{db_system}", + "passwordSecretVersion": { + "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password used to connect to the Oracle Goldengate. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, - "ociUrl": { - "description": "Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.", - "readOnly": true, + "port": { + "description": "Optional. The port of the GoldengateConnection.", + "format": "int32", + "type": "integer" + }, + "technologyType": { + "description": "Optional. The technology type.", "type": "string" }, - "odbNetwork": { - "description": "Optional. The name of the OdbNetwork associated with the DbSystem. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.", + "username": { + "description": "Optional. The username credential.", + "type": "string" + } + }, + "type": "object" + }, + "GoldengateGoogleBigQueryConnectionProperties": { + "description": "The properties of GoldengateGoogleBigQueryConnectionProperties.", + "id": "GoldengateGoogleBigQueryConnectionProperties", + "properties": { + "serviceAccountKeyFile": { + "description": "Optional. The service account key file Cloud Storage containing the credentials required to use Google BigQuery.", "type": "string" }, - "odbSubnet": { - "description": "Required. The name of the OdbSubnet associated with the DbSystem for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", + "technologyType": { + "description": "Optional. The technology type.", + "type": "string" + } + }, + "type": "object" + }, + "GoldengateGoogleCloudStorageConnectionProperties": { + "description": "The properties of GoldengateGoogleCloudStorageConnectionProperties.", + "id": "GoldengateGoogleCloudStorageConnectionProperties", + "properties": { + "serviceAccountKeyFile": { + "description": "Optional. The service account key Cloud Storage file containing the credentials required to use Google Cloud Storage.", "type": "string" }, - "properties": { - "$ref": "DbSystemProperties", - "description": "Optional. The properties of the DbSystem." + "technologyType": { + "description": "Optional. The technology type.", + "type": "string" } }, "type": "object" }, - "DbSystemInitialStorageSize": { - "description": "Summary of the DbSystem initial storage size.", - "id": "DbSystemInitialStorageSize", + "GoldengateGooglePubsubConnectionProperties": { + "description": "The properties of GoldengateGooglePubsubConnection.", + "id": "GoldengateGooglePubsubConnectionProperties", "properties": { - "name": { - "description": "Output only. The name of the resource.", - "readOnly": true, + "serviceAccountKeyFile": { + "description": "Optional. The content of the service account key file containing the credentials required to use Google Pub/Sub.", "type": "string" }, - "properties": { - "$ref": "DbSystemInitialStorageSizeProperties", - "description": "Output only. The properties of the DbSystem initial storage size summary.", - "readOnly": true + "technologyType": { + "description": "Optional. The technology type of GooglePubsubConnection.", + "type": "string" } }, "type": "object" }, - "DbSystemInitialStorageSizeProperties": { - "description": "The properties of a DbSystem initial storage size summary.", - "id": "DbSystemInitialStorageSizeProperties", + "GoldengateGroupToRolesMapping": { + "description": "The group to roles mapping of the GoldengateDeployment.", + "id": "GoldengateGroupToRolesMapping", "properties": { - "launchFromBackupStorageSizeDetails": { - "description": "Output only. List of storage disk details available for launches from backup.", - "items": { - "$ref": "StorageSizeDetails" - }, + "administratorGroupId": { + "description": "Output only. The administrator group id.", "readOnly": true, - "type": "array" + "type": "string" }, - "shapeType": { - "description": "Output only. VM shape platform type", - "enum": [ - "SHAPE_TYPE_UNSPECIFIED", - "STANDARD_X86" - ], - "enumDescriptions": [ - "Unspecified shape type.", - "Standard X86." - ], + "operatorGroupId": { + "description": "Output only. The operator group id.", "readOnly": true, "type": "string" }, - "storageManagement": { - "description": "Output only. The storage option used in DB system.", - "enum": [ - "STORAGE_MANAGEMENT_UNSPECIFIED", - "ASM", - "LVM" - ], - "enumDescriptions": [ - "Unspecified storage management.", - "Automatic Storage Management.", - "Logical Volume Management." - ], + "securityGroupId": { + "description": "Output only. The security group id.", "readOnly": true, "type": "string" }, - "storageSizeDetails": { - "description": "Output only. List of storage disk details.", - "items": { - "$ref": "StorageSizeDetails" - }, + "userGroupId": { + "description": "Output only. The user group id.", "readOnly": true, - "type": "array" + "type": "string" } }, "type": "object" }, - "DbSystemOptions": { - "description": "Details of the DbSystem Options.", - "id": "DbSystemOptions", + "GoldengateHdfsConnectionProperties": { + "description": "The properties of GoldengateHdfsConnection.", + "id": "GoldengateHdfsConnectionProperties", "properties": { - "storageManagement": { - "description": "Optional. The storage option used in DB system.", - "enum": [ - "STORAGE_MANAGEMENT_UNSPECIFIED", - "ASM", - "LVM" - ], - "enumDescriptions": [ - "The storage management is unspecified.", - "Automatic storage management.", - "Logical Volume management." - ], + "coreSiteXml": { + "description": "Optional. The content of the Hadoop Distributed File System configuration file (core-site.xml).", + "type": "string" + }, + "technologyType": { + "description": "Optional. The technology type of HdfsConnection.", "type": "string" } }, "type": "object" }, - "DbSystemProperties": { - "description": "The properties of a DbSystem.", - "id": "DbSystemProperties", + "GoldengateIcebergConnectionProperties": { + "description": "The properties of GoldengateIcebergConnection.", + "id": "GoldengateIcebergConnectionProperties", "properties": { - "computeCount": { - "description": "Required. The number of CPU cores to enable for the DbSystem.", - "format": "int32", - "type": "integer" + "catalog": { + "$ref": "IcebergCatalog", + "description": "Required. The Iceberg catalog." }, - "computeModel": { - "description": "Optional. The compute model of the DbSystem.", + "storage": { + "$ref": "IcebergStorage", + "description": "Required. The Iceberg storage." + }, + "technologyType": { + "description": "Required. The technology type of Iceberg connection.", + "type": "string" + } + }, + "type": "object" + }, + "GoldengateJavaMessageServiceConnectionProperties": { + "description": "The properties of GoldengateJavaMessageServiceConnection.", + "id": "GoldengateJavaMessageServiceConnectionProperties", + "properties": { + "authenticationType": { + "description": "Optional. Authentication type for Java Message Service.", "enum": [ - "COMPUTE_MODEL_UNSPECIFIED", - "ECPU", - "OCPU" + "JMS_AUTHENTICATION_TYPE_UNSPECIFIED", + "NONE", + "BASIC" ], "enumDescriptions": [ - "The compute model is unspecified.", - "The compute model is virtual.", - "The compute model is physical." + "Authentication type not specified.", + "No authentication.", + "Basic authentication." ], "type": "string" }, - "dataCollectionOptions": { - "$ref": "DataCollectionOptionsDbSystem", - "description": "Optional. Data collection options for diagnostics." + "connectionFactory": { + "description": "Optional. The Java class implementing javax.jms.ConnectionFactory interface supplied by the JMS provider.", + "type": "string" }, - "dataStorageSizeGb": { - "description": "Optional. The data storage size in GB that is currently available to DbSystems.", - "format": "int32", - "type": "integer" + "connectionUrl": { + "description": "Optional. Connection URL of the Java Message Service, specifying the protocol, host, and port. e.g.: 'mq://myjms.host.domain:7676'", + "type": "string" }, - "databaseEdition": { - "description": "Required. The database edition of the DbSystem.", - "enum": [ - "DB_SYSTEM_DATABASE_EDITION_UNSPECIFIED", - "STANDARD_EDITION", - "ENTERPRISE_EDITION", - "ENTERPRISE_EDITION_HIGH_PERFORMANCE" - ], - "enumDescriptions": [ - "The database edition is unspecified.", - "The database edition is Standard.", - "The database edition is Enterprise.", - "The database edition is Enterprise Edition." - ], + "jndiConnectionFactory": { + "description": "Optional. The Connection Factory can be looked up using this name. e.g.: 'ConnectionFactory'", "type": "string" }, - "dbHome": { - "$ref": "DbHome", - "description": "Optional. Details for creating a Database Home." + "jndiInitialContextFactory": { + "description": "Optional. The implementation of javax.naming.spi.InitialContextFactory interface used to obtain initial naming context.", + "type": "string" }, - "dbSystemOptions": { - "$ref": "DbSystemOptions", - "description": "Optional. The options for the DbSystem." + "jndiProviderUrl": { + "description": "Optional. The URL that Java Message Service will use to contact the JNDI provider. e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000'", + "type": "string" }, - "domain": { - "description": "Optional. The host domain name of the DbSystem.", + "jndiSecurityCredentialsSecret": { + "description": "Optional. The password associated to the principal.", "type": "string" }, - "hostname": { - "description": "Output only. The hostname of the DbSystem.", - "readOnly": true, + "jndiSecurityPrincipal": { + "description": "Optional. Specifies the identity of the principal (user) to be authenticated.", "type": "string" }, - "hostnamePrefix": { - "description": "Optional. Prefix for DB System host names.", + "keyStoreFile": { + "description": "Optional. The content of the KeyStore file.", "type": "string" }, - "initialDataStorageSizeGb": { - "description": "Required. The initial data storage size in GB.", - "format": "int32", - "type": "integer" + "keyStorePassword": { + "description": "Optional. Input only. The KeyStore password in plain text.", + "type": "string" }, - "licenseModel": { - "description": "Required. The license model of the DbSystem.", + "keyStorePasswordSecretVersion": { + "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the KeyStore password. Format: projects/{project}/secrets/{secret}/versions/{version}.", + "type": "string" + }, + "password": { + "description": "Optional. Input only. The password Oracle Goldengate uses to connect the Java Message Service in plain text.", + "type": "string" + }, + "passwordSecretVersion": { + "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses to connect the associated Java Message Service. Format: projects/{project}/secrets/{secret}/versions/{version}.", + "type": "string" + }, + "securityProtocol": { + "description": "Optional. Security protocol for Java Message Service.", "enum": [ - "LICENSE_MODEL_UNSPECIFIED", - "LICENSE_INCLUDED", - "BRING_YOUR_OWN_LICENSE" + "JMS_SECURITY_PROTOCOL_UNSPECIFIED", + "PLAIN", + "TLS", + "MTLS" ], "enumDescriptions": [ - "The license model is unspecified.", - "The license model is included.", - "The license model is bring your own license." + "Security protocol not specified.", + "Plain text communication.", + "Transport Layer Security.", + "Mutual Transport Layer Security." ], "type": "string" }, - "lifecycleState": { - "description": "Output only. State of the DbSystem.", + "sslKeyPassword": { + "description": "Optional. Input only. The password for the cert inside of the KeyStore in plain text.", + "type": "string" + }, + "sslKeyPasswordSecretVersion": { + "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password for the cert inside of the KeyStore. Format: projects/{project}/secrets/{secret}/versions/{version}.", + "type": "string" + }, + "technologyType": { + "description": "Optional. The technology type of JavaMessageServiceConnection.", + "type": "string" + }, + "trustStoreFile": { + "description": "Optional. The content of the TrustStore file.", + "type": "string" + }, + "trustStorePassword": { + "description": "Optional. Input only. The TrustStore password in plain text.", + "type": "string" + }, + "trustStorePasswordSecretVersion": { + "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the TrustStore password. Format: projects/{project}/secrets/{secret}/versions/{version}.", + "type": "string" + }, + "useJndi": { + "description": "Optional. If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.", + "type": "boolean" + }, + "username": { + "description": "Optional. The username Oracle Goldengate uses to connect to the Java Message Service.", + "type": "string" + } + }, + "type": "object" + }, + "GoldengateKafkaConnectionProperties": { + "description": "The properties of GoldengateKafkaConnection.", + "id": "GoldengateKafkaConnectionProperties", + "properties": { + "bootstrapServers": { + "description": "Optional. Kafka bootstrap. Equivalent of bootstrap.servers configuration property in Kafka: list of KafkaBootstrapServer objects specified by host/port. Used for establishing the initial connection to the Kafka cluster. Example: \"server1.example.com:9092,server2.example.com:9092\"", + "items": { + "$ref": "KafkaBootstrapServer" + }, + "type": "array" + }, + "clusterId": { + "description": "Optional. The OCID of the Kafka cluster being referenced from OCI Streaming with Apache Kafka.", + "type": "string" + }, + "consumerPropertiesFile": { + "description": "Optional. The content of the consumer.properties file.", + "type": "string" + }, + "keyStoreFile": { + "description": "Optional. The content of the KeyStore file.", + "type": "string" + }, + "keyStorePassword": { + "description": "Optional. Input only. The KeyStore password in plain text.", + "type": "string" + }, + "keyStorePasswordSecretVersion": { + "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the KeyStore password. Format: projects/{project}/secrets/{secret}/versions/{version}.", + "type": "string" + }, + "password": { + "description": "Optional. Input only. The password for Kafka basic/SASL auth in plain text.", + "type": "string" + }, + "passwordSecretVersion": { + "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password for Kafka basic/SASL auth. Format: projects/{project}/secrets/{secret}/versions/{version}.", + "type": "string" + }, + "producerPropertiesFile": { + "description": "Optional. The content of the producer.properties file.", + "type": "string" + }, + "securityProtocol": { + "description": "Optional. Security Type for Kafka.", "enum": [ - "DB_SYSTEM_LIFECYCLE_STATE_UNSPECIFIED", - "PROVISIONING", - "AVAILABLE", - "UPDATING", - "TERMINATING", - "TERMINATED", - "FAILED", - "MIGRATED", - "MAINTENANCE_IN_PROGRESS", - "NEEDS_ATTENTION", - "UPGRADING" + "KAFKA_SECURITY_PROTOCOL_UNSPECIFIED", + "SSL", + "SASL_SSL", + "PLAINTEXT", + "SASL_PLAINTEXT" ], "enumDescriptions": [ - "Default unspecified value.", - "Indicates that the resource is in provisioning state.", - "Indicates that the resource is in available state.", - "Indicates that the resource is in updating state.", - "Indicates that the resource is in terminating state.", - "Indicates that the resource is in terminated state.", - "Indicates that the resource is in failed state.", - "Indicates that the resource has been migrated.", - "Indicates that the resource is in maintenance in progress state.", - "Indicates that the resource needs attention.", - "Indicates that the resource is upgrading." + "Security type not specified.", + "SSL security protocol.", + "SASL SSL security protocol.", + "Plaintext security protocol.", + "SASL Plaintext security protocol." ], - "readOnly": true, "type": "string" }, - "memorySizeGb": { - "description": "Optional. The memory size in GB.", - "format": "int32", - "type": "integer" + "sslKeyPassword": { + "description": "Optional. Input only. The password for the cert inside of the KeyStore in plain text.", + "type": "string" }, - "nodeCount": { - "description": "Optional. The number of nodes in the DbSystem.", - "format": "int32", - "type": "integer" + "sslKeyPasswordSecretVersion": { + "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password for the cert inside of the KeyStore. Format: projects/{project}/secrets/{secret}/versions/{version}.", + "type": "string" }, - "ocid": { - "description": "Output only. OCID of the DbSystem.", - "readOnly": true, + "streamPoolId": { + "description": "Optional. The OCID of the stream pool being referenced.", "type": "string" }, - "privateIp": { - "description": "Optional. The private IP address of the DbSystem.", + "technologyType": { + "description": "Optional. The technology type of KafkaConnection.", "type": "string" }, - "recoStorageSizeGb": { - "description": "Optional. The reco/redo storage size in GB.", - "format": "int32", - "type": "integer" + "trustStoreFile": { + "description": "Optional. The content of the TrustStore file.", + "type": "string" }, - "shape": { - "description": "Required. Shape of DB System.", + "trustStorePassword": { + "description": "Optional. Input only. The TrustStore password in plain text.", "type": "string" }, - "sshPublicKeys": { - "description": "Required. SSH public keys to be stored with the DbSystem.", - "items": { - "type": "string" - }, - "type": "array" + "trustStorePasswordSecretVersion": { + "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the TrustStore password. Format: projects/{project}/secrets/{secret}/versions/{version}.", + "type": "string" }, - "timeZone": { - "$ref": "TimeZone", - "description": "Optional. Time zone of the DbSystem." + "useResourcePrincipal": { + "description": "Optional. Specifies that the user intends to authenticate to the instance using a resource principal. Applicable only for OCI Streaming connections.", + "type": "boolean" + }, + "username": { + "description": "Optional. The username Oracle Goldengate uses to connect the associated system of the given technology.", + "type": "string" } }, "type": "object" }, - "DbSystemShape": { - "description": "Details of the Database System Shapes resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystemShapeSummary/", - "id": "DbSystemShape", + "GoldengateKafkaSchemaRegistryConnectionProperties": { + "description": "The properties of GoldengateKafkaSchemaRegistryConnection.", + "id": "GoldengateKafkaSchemaRegistryConnectionProperties", "properties": { - "availableCoreCountPerNode": { - "description": "Optional. Number of cores per node.", - "format": "int32", - "type": "integer" + "authenticationType": { + "description": "Optional. Used authentication mechanism to access Schema Registry.", + "enum": [ + "AUTHENTICATION_TYPE_UNSPECIFIED", + "NONE", + "BASIC", + "MUTUAL" + ], + "enumDescriptions": [ + "Authentication type not specified.", + "No authentication.", + "Basic authentication.", + "Mutual authentication." + ], + "type": "string" }, - "availableDataStorageTb": { - "description": "Optional. Storage per storage server in terabytes.", - "format": "int32", - "type": "integer" + "keyStoreFile": { + "description": "Optional. The content of the KeyStore file.", + "type": "string" }, - "availableMemoryPerNodeGb": { - "description": "Optional. Memory per database server node in gigabytes.", - "format": "int32", - "type": "integer" + "keyStorePassword": { + "description": "Optional. Input only. The KeyStore password in plain text.", + "type": "string" }, - "maxNodeCount": { - "description": "Optional. Maximum number of database servers.", - "format": "int32", - "type": "integer" + "keyStorePasswordSecretVersion": { + "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the KeyStore password. Format: projects/{project}/secrets/{secret}/versions/{version}.", + "type": "string" }, - "maxStorageCount": { - "description": "Optional. Maximum number of storage servers.", - "format": "int32", - "type": "integer" + "password": { + "description": "Optional. Input only. The password to access Schema Registry in plain text.", + "type": "string" }, - "minCoreCountPerNode": { - "description": "Optional. Minimum core count per node.", - "format": "int32", - "type": "integer" + "passwordSecretVersion": { + "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password to access Schema Registry using basic authentication. Format: projects/{project}/secrets/{secret}/versions/{version}.", + "type": "string" }, - "minDbNodeStoragePerNodeGb": { - "description": "Optional. Minimum node storage per database server in gigabytes.", + "sslKeyPassword": { + "description": "Optional. Input only. The password for the cert inside the KeyStore in plain text.", + "type": "string" + }, + "sslKeyPasswordSecretVersion": { + "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password for the cert inside the KeyStore. Format: projects/{project}/secrets/{secret}/versions/{version}.", + "type": "string" + }, + "technologyType": { + "description": "Optional. The technology type of KafkaSchemaRegistryConnection.", + "type": "string" + }, + "trustStoreFile": { + "description": "Optional. The content of the TrustStore file.", + "type": "string" + }, + "trustStorePassword": { + "description": "Optional. Input only. The TrustStore password in plain text.", + "type": "string" + }, + "trustStorePasswordSecretVersion": { + "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the TrustStore password. Format: projects/{project}/secrets/{secret}/versions/{version}.", + "type": "string" + }, + "url": { + "description": "Optional. Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'", + "type": "string" + }, + "username": { + "description": "Optional. The username to access Schema Registry using basic authentication. This value is injected into 'schema.registry.basic.auth.user.info=user:password' configuration property.", + "type": "string" + } + }, + "type": "object" + }, + "GoldengateMaintenanceConfig": { + "description": "The maintenance configuration of the GoldengateDeployment.", + "id": "GoldengateMaintenanceConfig", + "properties": { + "bundleReleaseUpgradePeriodDays": { + "description": "Optional. Defines auto upgrade period for bundle releases. Manually configured period cannot be longer than service defined period for bundle releases. This period must be shorter or equal to major release upgrade period. Not passing this field during create will equate to using the service default.", "format": "int32", "type": "integer" }, - "minMemoryPerNodeGb": { - "description": "Optional. Minimum memory per node in gigabytes.", + "interimReleaseUpgradePeriodDays": { + "description": "Optional. Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.", "format": "int32", "type": "integer" }, - "minNodeCount": { - "description": "Optional. Minimum number of database servers.", + "isInterimReleaseAutoUpgradeEnabled": { + "description": "Optional. By default auto upgrade for interim releases are not enabled. If auto-upgrade is enabled for interim release, you have to specify interim_release_upgrade_period_days too.", + "type": "boolean" + }, + "majorReleaseUpgradePeriodDays": { + "description": "Optional. Defines auto upgrade period for major releases. Manually configured period cannot be longer than service defined period for major releases. Not passing this field during create will equate to using the service default.", "format": "int32", "type": "integer" }, - "minStorageCount": { - "description": "Optional. Minimum number of storage servers.", + "securityPatchUpgradePeriodDays": { + "description": "Optional. Defines auto upgrade period for releases with security fix. Manually configured period cannot be longer than service defined period for security releases. Not passing this field during create will equate to using the service default.", "format": "int32", "type": "integer" - }, - "name": { - "description": "Identifier. The name of the Database System Shape resource with the format: projects/{project}/locations/{region}/dbSystemShapes/{db_system_shape}", - "type": "string" - }, - "shape": { - "description": "Optional. shape", - "type": "string" } }, "type": "object" }, - "DbVersion": { - "description": "A valid Oracle Database version.", - "id": "DbVersion", + "GoldengateMaintenanceWindow": { + "description": "The maintenance window of the GoldengateDeployment.", + "id": "GoldengateMaintenanceWindow", "properties": { - "name": { - "description": "Output only. The name of the DbVersion resource in the following format: projects/{project}/locations/{region}/dbVersions/{db_version}", - "readOnly": true, + "day": { + "description": "Required. Days of the week.", + "enum": [ + "DAY_OF_WEEK_UNSPECIFIED", + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY", + "SUNDAY" + ], + "enumDescriptions": [ + "The day of the week is unspecified.", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], "type": "string" }, - "properties": { - "$ref": "DbVersionProperties", - "description": "Output only. The properties of the DbVersion.", - "readOnly": true + "startHour": { + "description": "Required. Start hour for maintenance period. Hour is in UTC.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "DbVersionProperties": { - "description": "The properties of a DbVersion.", - "id": "DbVersionProperties", + "GoldengateMicrosoftFabricConnectionProperties": { + "description": "The properties of GoldengateMicrosoftFabricConnection.", + "id": "GoldengateMicrosoftFabricConnectionProperties", "properties": { - "isLatestForMajorVersion": { - "description": "Output only. True if this version of the Oracle Database software is the latest version for a release.", - "readOnly": true, - "type": "boolean" + "clientId": { + "description": "Optional. Azure client ID of the application.", + "type": "string" }, - "isPreviewDbVersion": { - "description": "Output only. True if this version of the Oracle Database software is the preview version.", - "readOnly": true, - "type": "boolean" + "clientSecret": { + "description": "Optional. Client secret associated with the client id.", + "type": "string" }, - "isUpgradeSupported": { - "description": "Output only. True if this version of the Oracle Database software is supported for Upgrade.", - "readOnly": true, - "type": "boolean" + "endpoint": { + "description": "Optional. Optional Microsoft Fabric service endpoint. Default value: https://onelake.dfs.fabric.microsoft.com", + "type": "string" }, - "supportsPdb": { - "description": "Output only. True if this version of the Oracle Database software supports pluggable databases.", - "readOnly": true, - "type": "boolean" + "technologyType": { + "description": "Optional. The technology type of MicrosoftFabricConnection.", + "type": "string" }, - "version": { - "description": "Output only. A valid Oracle Database version.", - "readOnly": true, + "tenantId": { + "description": "Optional. Azure tenant ID of the application.", "type": "string" } }, "type": "object" }, - "DefinedTagValue": { - "description": "Wrapper message for the value of a defined tag.", - "id": "DefinedTagValue", + "GoldengateMicrosoftSqlserverConnectionProperties": { + "description": "The properties of GoldengateMicrosoftSqlserverConnection.", + "id": "GoldengateMicrosoftSqlserverConnectionProperties", "properties": { - "tags": { - "additionalProperties": { - "type": "string" + "additionalAttributes": { + "description": "Optional. An array of name-value pair attribute entries. Used as additional parameters in connection string.", + "items": { + "$ref": "NameValuePair" }, - "description": "The tags within the namespace.", - "type": "object" - } - }, - "type": "object" - }, - "Empty": { - "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", - "id": "Empty", - "properties": {}, - "type": "object" - }, - "EncryptionKey": { - "description": "The encryption key used to encrypt the Autonomous Database.", - "id": "EncryptionKey", - "properties": { - "kmsKey": { - "description": "Optional. The KMS key used to encrypt the Autonomous Database. This field is required if the provider is GOOGLE_MANAGED. The name of the KMS key resource in the following format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.", + "type": "array" + }, + "database": { + "description": "Optional. The name of the database.", "type": "string" }, - "provider": { - "description": "Optional. The provider of the encryption key.", + "host": { + "description": "Optional. The name or address of a host.", + "type": "string" + }, + "password": { + "description": "Optional. Input only. The password Oracle Goldengate uses for Microsoft SQL Server connection in plain text.", + "type": "string" + }, + "passwordSecretVersion": { + "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses for Microsoft SQL Server connection. Format: projects/{project}/secrets/{secret}/versions/{version}.", + "type": "string" + }, + "port": { + "description": "Optional. The port of an endpoint usually specified for a connection.", + "format": "int32", + "type": "integer" + }, + "securityProtocol": { + "description": "Optional. Security Type for Microsoft SQL Server.", "enum": [ - "PROVIDER_UNSPECIFIED", - "GOOGLE_MANAGED", - "ORACLE_MANAGED" + "MICROSOFT_SQLSERVER_SECURITY_PROTOCOL_UNSPECIFIED", + "PLAIN", + "TLS" ], "enumDescriptions": [ - "Default unspecified value.", - "Google Managed KMS key, if selected, please provide the KMS key name.", - "Oracle Managed." + "Security type not specified.", + "Plain text communication.", + "Transport Layer Security." ], "type": "string" - } - }, - "type": "object" - }, - "EncryptionKeyHistoryEntry": { - "description": "The history of the encryption keys used to encrypt the Autonomous Database.", - "id": "EncryptionKeyHistoryEntry", - "properties": { - "activationTime": { - "description": "Output only. The date and time when the encryption key was activated on the Autonomous Database..", - "format": "google-datetime", - "readOnly": true, + }, + "serverCertificateValidationRequired": { + "description": "Optional. If set to true, the driver validates the certificate that is sent by the database server.", + "type": "boolean" + }, + "sslCaFile": { + "description": "Optional. Database Certificate - The content of a .pem or .crt file containing the server public key (for 1-way SSL).", "type": "string" }, - "encryptionKey": { - "$ref": "EncryptionKey", - "description": "Output only. The encryption key used to encrypt the Autonomous Database.", - "readOnly": true + "technologyType": { + "description": "Optional. The technology type of MicrosoftSqlserverConnection.", + "type": "string" + }, + "username": { + "description": "Optional. The username Oracle Goldengate uses to connect to the Microsoft SQL Server.", + "type": "string" } }, "type": "object" }, - "Entitlement": { - "description": "Details of the Entitlement resource.", - "id": "Entitlement", + "GoldengateMongodbConnectionProperties": { + "description": "The properties of GoldengateMongodbConnection.", + "id": "GoldengateMongodbConnectionProperties", "properties": { - "cloudAccountDetails": { - "$ref": "CloudAccountDetails", - "description": "Details of the OCI Cloud Account." + "connectionString": { + "description": "Optional. MongoDB connection string. e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords'", + "type": "string" }, - "entitlementId": { - "description": "Output only. Google Cloud Marketplace order ID (aka entitlement ID)", - "readOnly": true, + "databaseId": { + "description": "Optional. The OCID of the Oracle Autonomous Json Database.", "type": "string" }, - "name": { - "description": "Identifier. The name of the Entitlement resource with the format: projects/{project}/locations/{region}/entitlements/{entitlement}", + "password": { + "description": "Optional. Input only. The password Oracle Goldengate uses to connect the Mongodb connection in plain text.", "type": "string" }, - "state": { - "description": "Output only. Entitlement State.", + "passwordSecretVersion": { + "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses to connect the Mongodb connection. Format: projects/{project}/secrets/{secret}/versions/{version}.", + "type": "string" + }, + "securityProtocol": { + "description": "Optional. Security Type for MongoDB.", "enum": [ - "STATE_UNSPECIFIED", - "ACCOUNT_NOT_LINKED", - "ACCOUNT_NOT_ACTIVE", - "ACTIVE", - "ACCOUNT_SUSPENDED", - "NOT_APPROVED_IN_PRIVATE_MARKETPLACE" + "MONGODB_SECURITY_PROTOCOL_UNSPECIFIED", + "PLAIN", + "TLS", + "MTLS" ], "enumDescriptions": [ - "Default unspecified value.", - "Account not linked.", - "Account is linked but not active.", - "Entitlement and Account are active.", - "Account is suspended.", - "Entitlement is not approved in private marketplace." + "Security type not specified.", + "Plain text communication.", + "Transport Layer Security.", + "Mutual Transport Layer Security." ], - "readOnly": true, + "type": "string" + }, + "technologyType": { + "description": "Optional. The technology type of MongodbConnection.", + "type": "string" + }, + "tlsCaFile": { + "description": "Optional. Database Certificate - The content of a .pem file, containing the server public key (for 1 and 2-way SSL).", + "type": "string" + }, + "tlsCertificateKeyFile": { + "description": "Optional. Client Certificate - The content of a .pem file, containing the client public key (for 2-way SSL).", + "type": "string" + }, + "tlsCertificateKeyFilePassword": { + "description": "Optional. Input only. The Client Certificate key file password in plain text.", + "type": "string" + }, + "tlsCertificateKeyFilePasswordSecretVersion": { + "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the Client Certificate key file password in Secret Manager. Format: projects/{project}/secrets/{secret}/versions/{version}.", + "type": "string" + }, + "username": { + "description": "Optional. The username Oracle Goldengate uses to connect to the database.", "type": "string" } }, "type": "object" }, - "ExadbVmCluster": { - "description": "ExadbVmCluster represents a cluster of VMs that are used to run Exadata workloads. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/ExadbVmCluster/", - "id": "ExadbVmCluster", + "GoldengateMysqlConnectionProperties": { + "description": "Properties of GoldengateMysqlConnection.", + "id": "GoldengateMysqlConnectionProperties", "properties": { - "backupOdbSubnet": { - "description": "Required. Immutable. The name of the backup OdbSubnet associated with the ExadbVmCluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", + "additionalAttributes": { + "description": "Optional. An array of name-value pair attribute entries. Used as additional parameters in connection string.", + "items": { + "$ref": "NameValuePair" + }, + "type": "array" + }, + "database": { + "description": "Optional. The name of the database.", "type": "string" }, - "createTime": { - "description": "Output only. The date and time that the ExadbVmCluster was created.", - "format": "google-datetime", - "readOnly": true, + "dbSystemId": { + "description": "Optional. The OCID of the database system being referenced.", "type": "string" }, - "displayName": { - "description": "Required. Immutable. The display name for the ExadbVmCluster. The name does not have to be unique within your project. The name must be 1-255 characters long and can only contain alphanumeric characters.", + "host": { + "description": "Optional. The name or address of a host.", "type": "string" }, - "entitlementId": { - "description": "Output only. The ID of the subscription entitlement associated with the ExadbVmCluster.", - "readOnly": true, + "password": { + "description": "Optional. Input only. The password Oracle Goldengate uses to connect to MySQL in plain text.", "type": "string" }, - "gcpOracleZone": { - "description": "Output only. Immutable. The GCP Oracle zone where Oracle ExadbVmCluster is hosted. Example: us-east4-b-r2. During creation, the system will pick the zone assigned to the ExascaleDbStorageVault.", - "readOnly": true, + "passwordSecretVersion": { + "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses to connect to MySQL. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. The labels or tags associated with the ExadbVmCluster.", - "type": "object" + "port": { + "description": "Optional. The port of an endpoint usually specified for a connection.", + "format": "int32", + "type": "integer" }, - "name": { - "description": "Identifier. The name of the ExadbVmCluster resource in the following format: projects/{project}/locations/{region}/exadbVmClusters/{exadb_vm_cluster}", + "securityProtocol": { + "description": "Optional. Security Type for MySQL.", + "enum": [ + "MYSQL_SECURITY_PROTOCOL_UNSPECIFIED", + "PLAIN", + "TLS", + "MTLS" + ], + "enumDescriptions": [ + "Security type not specified.", + "Plain text communication.", + "Transport Layer Security.", + "Mutual Transport Layer Security." + ], "type": "string" }, - "odbNetwork": { - "description": "Optional. Immutable. The name of the OdbNetwork associated with the ExadbVmCluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.", + "sslCaFile": { + "description": "Optional. Database Certificate - The content of a .pem or .crt file containing the server public key (for 1 and 2-way SSL).", "type": "string" }, - "odbSubnet": { - "description": "Required. Immutable. The name of the OdbSubnet associated with the ExadbVmCluster for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", + "sslCertFile": { + "description": "Optional. Client Certificate - The content of a .pem or .crt file containing the client public key (for 2-way SSL).", "type": "string" }, - "properties": { - "$ref": "ExadbVmClusterProperties", - "description": "Required. The properties of the ExadbVmCluster." + "sslCrlFile": { + "description": "Optional. The list of certificates revoked by the trusted certificate authorities (Trusted CA).", + "type": "string" + }, + "sslKeyFile": { + "description": "Optional. Client Key - The content of a .pem or .crt file containing the client private key (for 2-way SSL).", + "type": "string" + }, + "sslMode": { + "description": "Optional. SSL modes for MySQL.", + "enum": [ + "SSL_MODE_UNSPECIFIED", + "DISABLED", + "PREFERRED", + "REQUIRED", + "VERIFY_CA", + "VERIFY_IDENTITY" + ], + "enumDescriptions": [ + "SSL mode not specified.", + "SSL is disabled.", + "SSL is preferred.", + "SSL is required.", + "SSL is required and certificate is verified.", + "SSL is required and certificate and hostname are verified." + ], + "type": "string" + }, + "technologyType": { + "description": "Optional. The technology type of MysqlConnection.", + "type": "string" + }, + "username": { + "description": "Optional. The username Oracle Goldengate uses to connect the associated system of the given technology.", + "type": "string" } }, "type": "object" }, - "ExadbVmClusterProperties": { - "description": "The properties of an ExadbVmCluster.", - "id": "ExadbVmClusterProperties", + "GoldengateOciObjectStorageConnectionProperties": { + "description": "The properties of GoldengateOciObjectStorageConnection.", + "id": "GoldengateOciObjectStorageConnectionProperties", "properties": { - "additionalEcpuCountPerNode": { - "description": "Optional. Immutable. The number of additional ECPUs per node for an Exadata VM cluster on exascale infrastructure.", - "format": "int32", - "type": "integer" + "privateKeyFile": { + "description": "Optional. The content of the private key file (PEM file) corresponding to the API key of the fingerprint.", + "type": "string" }, - "clusterName": { - "description": "Optional. Immutable. The cluster name for Exascale vm cluster. The cluster name must begin with an alphabetic character and may contain hyphens(-) but can not contain underscores(_). It should be not more than 11 characters and is not case sensitive. OCI Cluster name.", + "privateKeyPassphraseSecret": { + "description": "Optional. The passphrase of the private key.", "type": "string" }, - "dataCollectionOptions": { - "$ref": "DataCollectionOptionsCommon", - "description": "Optional. Immutable. Indicates user preference for data collection options." + "publicKeyFingerprint": { + "description": "Optional. The fingerprint of the API Key of the user specified by the userId.", + "type": "string" }, - "enabledEcpuCountPerNode": { - "description": "Required. Immutable. The number of ECPUs enabled per node for an exadata vm cluster on exascale infrastructure.", - "format": "int32", - "type": "integer" + "region": { + "description": "Optional. The name of the region of OCI Object Storage. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.", + "type": "string" }, - "exascaleDbStorageVault": { - "description": "Required. Immutable. The name of ExascaleDbStorageVault associated with the ExadbVmCluster. It can refer to an existing ExascaleDbStorageVault. Or a new one can be created during the ExadbVmCluster creation (requires storage_vault_properties to be set). Format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}", + "technologyType": { + "description": "Optional. The technology type of OciObjectStorageConnection.", "type": "string" }, - "giVersion": { - "description": "Output only. The Oracle Grid Infrastructure (GI) software version.", - "readOnly": true, + "tenancyId": { + "description": "Optional. The OCID of the related OCI tenancy.", "type": "string" }, - "gridImageId": { - "description": "Required. Immutable. Grid Infrastructure Version.", + "useResourcePrincipal": { + "description": "Optional. Specifies that the user intends to authenticate to the instance using a resource principal.", + "type": "boolean" + }, + "userId": { + "description": "Optional. The OCID of the OCI user who will access the Object Storage. The user must have write access to the bucket they want to connect to.", + "type": "string" + } + }, + "type": "object" + }, + "GoldengateOggDeployment": { + "description": "The Ogg data of the GoldengateDeployment.", + "id": "GoldengateOggDeployment", + "properties": { + "adminPassword": { + "description": "Optional. The Goldengate deployment console password in plain text.", "type": "string" }, - "hostname": { - "description": "Output only. The hostname of the ExadbVmCluster.", - "readOnly": true, + "adminPasswordSecretVersion": { + "description": "Optional. Input only. The Goldengate deployment console password secret version.", "type": "string" }, - "hostnamePrefix": { - "description": "Required. Immutable. Prefix for VM cluster host names.", + "adminUsername": { + "description": "Required. The Goldengate deployment console username.", "type": "string" }, - "licenseModel": { - "description": "Optional. Immutable. The license type of the ExadbVmCluster.", + "certificate": { + "description": "Output only. The certificate of the GoldengateDeployment.", + "readOnly": true, + "type": "string" + }, + "credentialStore": { + "description": "Output only. The credential store of the GoldengateDeployment.", "enum": [ - "LICENSE_MODEL_UNSPECIFIED", - "LICENSE_INCLUDED", - "BRING_YOUR_OWN_LICENSE" + "CREDENTIAL_STORE_UNSPECIFIED", + "GOLDENGATE", + "IAM" ], "enumDescriptions": [ - "Unspecified.", - "Default is license included.", - "Bring your own license." + "The credential store is unspecified.", + "The credential store is Goldengate.", + "The credential store is IAM." ], + "readOnly": true, "type": "string" }, - "lifecycleState": { - "description": "Output only. State of the cluster.", + "deployment": { + "description": "Required. The name given to the Goldengate service deployment. The name must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter.", + "type": "string" + }, + "groupRolesMapping": { + "$ref": "GoldengateGroupToRolesMapping", + "description": "Output only. The group to roles mapping of the GoldengateDeployment.", + "readOnly": true + }, + "identityDomainId": { + "description": "Output only. The identity domain id of the GoldengateDeployment.", + "readOnly": true, + "type": "string" + }, + "oggVersion": { + "description": "Optional. Version of OGG", + "type": "string" + }, + "passwordSecretId": { + "description": "Output only. The password secret id of the GoldengateDeployment.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoldengateOracleAIDataPlatformConnectionProperties": { + "description": "The properties of GoldengateOracleAIDataPlatformConnection.", + "id": "GoldengateOracleAIDataPlatformConnectionProperties", + "properties": { + "connectionUrl": { + "description": "Optional. Connection URL. It must start with 'jdbc:spark://'", + "type": "string" + }, + "privateKeyFile": { + "description": "Optional. The content of the private key file (PEM file) corresponding to the API key of the fingerprint.", + "type": "string" + }, + "privateKeyPassphraseSecret": { + "description": "Optional. The passphrase of the private key.", + "type": "string" + }, + "publicKeyFingerprint": { + "description": "Optional. The fingerprint of the API Key of the user specified by the user_id.", + "type": "string" + }, + "region": { + "description": "Optional. The name of the region. e.g.: us-ashburn-1", + "type": "string" + }, + "technologyType": { + "description": "Optional. The technology type of OracleAiDataPlatformConnection.", + "type": "string" + }, + "tenancyId": { + "description": "Optional. The OCID of the related OCI tenancy.", + "type": "string" + }, + "useResourcePrincipal": { + "description": "Optional. Specifies that the user intends to authenticate to the instance using a resource principal.", + "type": "boolean" + }, + "userId": { + "description": "Optional. The OCID of the OCI user who will access.", + "type": "string" + } + }, + "type": "object" + }, + "GoldengateOracleConnectionProperties": { + "description": "The properties of Goldengate Oracle Database Connection.", + "id": "GoldengateOracleConnectionProperties", + "properties": { + "authenticationMode": { + "description": "Optional. Authentication mode.", "enum": [ - "EXADB_VM_CLUSTER_LIFECYCLE_STATE_UNSPECIFIED", - "PROVISIONING", - "AVAILABLE", - "UPDATING", - "TERMINATING", - "TERMINATED", - "FAILED", - "MAINTENANCE_IN_PROGRESS" + "ORACLE_AUTHENTICATION_MODE_UNSPECIFIED", + "TLS", + "MTLS" ], "enumDescriptions": [ - "Default unspecified value.", - "Indicates that the resource is in provisioning state.", - "Indicates that the resource is in available state.", - "Indicates that the resource is in updating state.", - "Indicates that the resource is in terminating state.", - "Indicates that the resource is in terminated state.", - "Indicates that the resource is in failed state.", - "Indicates that the resource is in maintenance in progress state." + "Authentication mode not specified.", + "TLS authentication mode.", + "MTLS authentication mode." ], - "readOnly": true, "type": "string" }, - "memorySizeGb": { - "description": "Output only. Memory per VM (GB) (Read-only): Shows the amount of memory allocated to each VM. Memory is calculated based on 2.75 GB per Total ECPUs.", - "format": "int32", - "readOnly": true, - "type": "integer" + "connectionString": { + "description": "Optional. Connect descriptor or Easy Connect Naming method used to connect to a database.", + "type": "string" }, - "nodeCount": { - "description": "Required. The number of nodes/VMs in the ExadbVmCluster.", - "format": "int32", - "type": "integer" + "gcpOracleDatabaseId": { + "description": "Optional. Database instance id of database in Oracle Database @ Google Cloud. If gcp_oracle_database_id is provided, connection_string must be empty.", + "type": "string" }, - "ociUri": { - "description": "Output only. Deep link to the OCI console to view this resource.", - "readOnly": true, + "password": { + "description": "Optional. Input only. The password Oracle Goldengate uses in plain text.", "type": "string" }, - "scanListenerPortTcp": { - "description": "Optional. Immutable. SCAN listener port - TCP", - "format": "int32", - "type": "integer" + "passwordSecretVersion": { + "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses. Format: projects/{project}/secrets/{secret}/versions/{version}.", + "type": "string" }, - "shapeAttribute": { - "description": "Required. Immutable. The shape attribute of the VM cluster. The type of Exascale storage used for Exadata VM cluster. The default is SMART_STORAGE which supports Oracle Database 23ai and later", + "sessionMode": { + "description": "Optional. The mode of the database connection session to be established by the data client.", "enum": [ - "SHAPE_ATTRIBUTE_UNSPECIFIED", - "SMART_STORAGE", - "BLOCK_STORAGE" + "SESSION_MODE_UNSPECIFIED", + "DIRECT", + "REDIRECT" ], "enumDescriptions": [ "Default unspecified value.", - "Indicates that the resource is in smart storage.", - "Indicates that the resource is in block storage." + "Indicates that the resource is using direct session mode.", + "Indicates that the resource is using redirect session mode." ], "type": "string" }, - "sshPublicKeys": { - "description": "Required. Immutable. The SSH public keys for the ExadbVmCluster.", - "items": { - "type": "string" - }, - "type": "array" + "technologyType": { + "description": "Optional. The technology type.", + "type": "string" }, - "timeZone": { - "$ref": "TimeZone", - "description": "Optional. Immutable. The time zone of the ExadbVmCluster." + "username": { + "description": "Optional. The username Oracle Goldengate uses to connect.", + "type": "string" }, - "vmFileSystemStorage": { - "$ref": "ExadbVmClusterStorageDetails", - "description": "Required. Immutable. Total storage details for the ExadbVmCluster." + "walletFile": { + "description": "Optional. The wallet contents Oracle Goldengate uses to make connections to a database.", + "type": "string" } }, "type": "object" }, - "ExadbVmClusterStorageDetails": { - "description": "The storage allocation for the exadbvmcluster, in gigabytes (GB).", - "id": "ExadbVmClusterStorageDetails", + "GoldengateOracleNosqlConnectionProperties": { + "description": "The properties of GoldengateOracleNosqlConnection.", + "id": "GoldengateOracleNosqlConnectionProperties", "properties": { - "sizeInGbsPerNode": { - "description": "Required. The storage allocation for the exadbvmcluster per node, in gigabytes (GB). This field is used to calculate the total storage allocation for the exadbvmcluster.", - "format": "int32", - "type": "integer" + "privateKeyFile": { + "description": "Optional. The content of the private key file (PEM file) corresponding to the API key of the fingerprint.", + "type": "string" + }, + "privateKeyPassphraseSecret": { + "description": "Optional. The passphrase of the private key.", + "type": "string" + }, + "publicKeyFingerprint": { + "description": "Optional. The fingerprint of the API Key of the user specified by the userId.", + "type": "string" + }, + "region": { + "description": "Optional. The name of the region. e.g.: us-ashburn-1", + "type": "string" + }, + "technologyType": { + "description": "Optional. The technology type of OracleNosqlConnection.", + "type": "string" + }, + "tenancyId": { + "description": "Optional. The OCID of the OCI tenancy.", + "type": "string" + }, + "useResourcePrincipal": { + "description": "Optional. Specifies that the user intends to authenticate to the instance using a resource principal.", + "type": "boolean" + }, + "userId": { + "description": "Optional. The OCID of the OCI user who will access the Oracle NoSQL database.", + "type": "string" } }, "type": "object" }, - "ExascaleDbStorageDetails": { - "description": "The storage details of the ExascaleDbStorageVault.", - "id": "ExascaleDbStorageDetails", + "GoldengatePlacement": { + "description": "The placement of the GoldengateDeployment.", + "id": "GoldengatePlacement", "properties": { - "availableSizeGbs": { - "description": "Output only. The available storage capacity for the ExascaleDbStorageVault, in gigabytes (GB).", - "format": "int32", + "availabilityDomain": { + "description": "Output only. The availability domain.", "readOnly": true, - "type": "integer" + "type": "string" }, - "totalSizeGbs": { - "description": "Required. The total storage allocation for the ExascaleDbStorageVault, in gigabytes (GB).", - "format": "int32", - "type": "integer" + "faultDomain": { + "description": "Output only. The fault domain.", + "readOnly": true, + "type": "string" } }, "type": "object" }, - "ExascaleDbStorageVault": { - "description": "ExascaleDbStorageVault represents a storage vault exadb vm cluster resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/ExascaleDbStorageVault/", - "id": "ExascaleDbStorageVault", + "GoldengatePostgresqlConnectionProperties": { + "description": "The properties of GoldengatePostgresqlConnection.", + "id": "GoldengatePostgresqlConnectionProperties", "properties": { - "createTime": { - "description": "Output only. The date and time when the ExascaleDbStorageVault was created.", - "format": "google-datetime", - "readOnly": true, + "additionalAttributes": { + "description": "Optional. An array of name-value pair attribute entries. Used as additional parameters in connection string.", + "items": { + "$ref": "NameValuePair" + }, + "type": "array" + }, + "database": { + "description": "Optional. The name of the database.", "type": "string" }, - "displayName": { - "description": "Required. The display name for the ExascaleDbStorageVault. The name does not have to be unique within your project. The name must be 1-255 characters long and can only contain alphanumeric characters.", + "dbSystemId": { + "description": "Optional. The OCID of the database system being referenced.", "type": "string" }, - "entitlementId": { - "description": "Output only. The ID of the subscription entitlement associated with the ExascaleDbStorageVault.", - "readOnly": true, + "host": { + "description": "Optional. The name or address of a host.", "type": "string" }, - "gcpOracleZone": { - "description": "Optional. The GCP Oracle zone where Oracle ExascaleDbStorageVault is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.", + "password": { + "description": "Optional. Input only. The password Oracle Goldengate uses for PostgreSQL connection in plain text.", "type": "string" }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. The labels or tags associated with the ExascaleDbStorageVault.", - "type": "object" + "passwordSecretVersion": { + "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses for PostgreSQL connection. Format: projects/{project}/secrets/{secret}/versions/{version}.", + "type": "string" }, - "name": { - "description": "Identifier. The resource name of the ExascaleDbStorageVault. Format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}", + "port": { + "description": "Optional. The port of an endpoint usually specified for a connection.", + "format": "int32", + "type": "integer" + }, + "securityProtocol": { + "description": "Optional. Security protocol for PostgreSQL.", + "enum": [ + "POSTGRESQL_SECURITY_PROTOCOL_UNSPECIFIED", + "PLAIN", + "TLS", + "MTLS" + ], + "enumDescriptions": [ + "Security protocol not specified.", + "Plain text communication.", + "Transport Layer Security.", + "Mutual Transport Layer Security." + ], "type": "string" }, - "properties": { - "$ref": "ExascaleDbStorageVaultProperties", - "description": "Required. The properties of the ExascaleDbStorageVault." + "sslCaFile": { + "description": "Optional. The certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL.", + "type": "string" + }, + "sslCertFile": { + "description": "Optional. The certificate of the PostgreSQL server.", + "type": "string" + }, + "sslCrlFile": { + "description": "Optional. The list of certificates revoked by the trusted certificate authorities (Trusted CA).", + "type": "string" + }, + "sslKeyFile": { + "description": "Optional. The private key of the PostgreSQL server.", + "type": "string" + }, + "sslMode": { + "description": "Optional. SSL modes for PostgreSQL.", + "enum": [ + "POSTGRESQL_SSL_MODE_UNSPECIFIED", + "PREFER", + "REQUIRE", + "VERIFY_CA", + "VERIFY_FULL" + ], + "enumDescriptions": [ + "SSL mode not specified.", + "Prefer SSL.", + "Require SSL.", + "Verify Certificate Authority.", + "Verify Full." + ], + "type": "string" + }, + "technologyType": { + "description": "Optional. The technology type of PostgresqlConnection.", + "type": "string" + }, + "username": { + "description": "Optional. The username Oracle Goldengate uses to connect the associated system of the given technology.", + "type": "string" } }, "type": "object" }, - "ExascaleDbStorageVaultProperties": { - "description": "The properties of the ExascaleDbStorageVault. next ID: 12", - "id": "ExascaleDbStorageVaultProperties", + "GoldengateRedisConnectionProperties": { + "description": "The properties of GoldengateRedisConnection.", + "id": "GoldengateRedisConnectionProperties", "properties": { - "additionalFlashCachePercent": { - "description": "Optional. The size of additional flash cache in percentage of high capacity database storage.", - "format": "int32", - "type": "integer" + "authenticationType": { + "description": "Optional. Authentication type for Redis.", + "enum": [ + "REDIS_AUTHENTICATION_TYPE_UNSPECIFIED", + "NONE", + "BASIC" + ], + "enumDescriptions": [ + "Authentication type not specified.", + "No authentication.", + "Basic authentication." + ], + "type": "string" }, - "attachedShapeAttributes": { - "description": "Output only. The shape attributes of the VM clusters attached to the ExascaleDbStorageVault.", - "items": { - "enum": [ - "SHAPE_ATTRIBUTE_UNSPECIFIED", - "SMART_STORAGE", - "BLOCK_STORAGE" - ], - "enumDescriptions": [ - "Default unspecified value.", - "Indicates that the resource is in smart storage.", - "Indicates that the resource is in block storage." - ], - "type": "string" - }, - "readOnly": true, - "type": "array" + "keyStoreFile": { + "description": "Optional. The content of the KeyStore file.", + "type": "string" }, - "availableShapeAttributes": { - "description": "Output only. The shape attributes available for the VM clusters to be attached to the ExascaleDbStorageVault.", - "items": { - "enum": [ - "SHAPE_ATTRIBUTE_UNSPECIFIED", - "SMART_STORAGE", - "BLOCK_STORAGE" - ], - "enumDescriptions": [ - "Default unspecified value.", - "Indicates that the resource is in smart storage.", - "Indicates that the resource is in block storage." - ], - "type": "string" - }, - "readOnly": true, - "type": "array" + "keyStorePassword": { + "description": "Optional. Input only. The KeyStore password in plain text.", + "type": "string" }, - "description": { - "description": "Optional. The description of the ExascaleDbStorageVault.", + "keyStorePasswordSecretVersion": { + "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the KeyStore password. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, - "exascaleDbStorageDetails": { - "$ref": "ExascaleDbStorageDetails", - "description": "Required. The storage details of the ExascaleDbStorageVault." + "password": { + "description": "Optional. Input only. The password Oracle Goldengate uses for Redis connection in plain text.", + "type": "string" }, - "ociUri": { - "description": "Output only. Deep link to the OCI console to view this resource.", - "readOnly": true, + "passwordSecretVersion": { + "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses for Redis connection. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, - "ocid": { - "description": "Output only. The OCID for the ExascaleDbStorageVault.", - "readOnly": true, + "redisClusterId": { + "description": "Optional. The OCID of the Redis cluster.", "type": "string" }, - "state": { - "description": "Output only. The state of the ExascaleDbStorageVault.", + "securityProtocol": { + "description": "Optional. Security protocol for Redis.", "enum": [ - "STATE_UNSPECIFIED", - "PROVISIONING", - "AVAILABLE", - "UPDATING", - "TERMINATING", - "TERMINATED", - "FAILED" + "REDIS_SECURITY_PROTOCOL_UNSPECIFIED", + "PLAIN", + "TLS", + "MTLS" ], "enumDescriptions": [ - "The state of the ExascaleDbStorageVault is unspecified.", - "The ExascaleDbStorageVault is being provisioned.", - "The ExascaleDbStorageVault is available.", - "The ExascaleDbStorageVault is being updated.", - "The ExascaleDbStorageVault is being deleted.", - "The ExascaleDbStorageVault has been deleted.", - "The ExascaleDbStorageVault has failed." + "Security protocol not specified.", + "Plain text communication.", + "Transport Layer Security.", + "Mutual Transport Layer Security." ], - "readOnly": true, "type": "string" }, - "timeZone": { - "$ref": "TimeZone", - "description": "Output only. The time zone of the ExascaleDbStorageVault.", - "readOnly": true + "servers": { + "description": "Optional. Comma separated list of Redis server addresses, specified as host:port entries, where :port is optional. If port is not specified, it defaults to 6379. Example: \"server1.example.com:6379,server2.example.com:6379\"", + "type": "string" }, - "vmClusterCount": { - "description": "Output only. The number of VM clusters associated with the ExascaleDbStorageVault.", - "format": "int32", - "readOnly": true, - "type": "integer" + "technologyType": { + "description": "Optional. The technology type of RedisConnection.", + "type": "string" }, - "vmClusterIds": { - "description": "Output only. The list of VM cluster OCIDs associated with the ExascaleDbStorageVault.", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" - } - }, - "type": "object" - }, - "FailoverAutonomousDatabaseRequest": { - "description": "The request for `OracleDatabase.FailoverAutonomousDatabase`.", - "id": "FailoverAutonomousDatabaseRequest", - "properties": { - "peerAutonomousDatabase": { - "description": "Optional. The peer database name to fail over to. Required for cross-region standby, and must be omitted for in-region Data Guard.", + "trustStoreFile": { + "description": "Optional. The content of the TrustStore file.", + "type": "string" + }, + "trustStorePassword": { + "description": "Optional. Input only. The TrustStore password in plain text.", + "type": "string" + }, + "trustStorePasswordSecretVersion": { + "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the TrustStore password. Format: projects/{project}/secrets/{secret}/versions/{version}.", + "type": "string" + }, + "username": { + "description": "Optional. The username Oracle Goldengate uses to connect the associated system of the given technology.", "type": "string" } }, "type": "object" }, - "GenerateAutonomousDatabaseWalletRequest": { - "description": "The request for `AutonomousDatabase.GenerateWallet`.", - "id": "GenerateAutonomousDatabaseWalletRequest", + "GoldengateSnowflakeConnectionProperties": { + "description": "The properties of GoldengateSnowflakeConnection.", + "id": "GoldengateSnowflakeConnectionProperties", "properties": { - "isRegional": { - "description": "Optional. True when requesting regional connection strings in PDB connect info, applicable to cross-region Data Guard only.", - "type": "boolean" - }, - "password": { - "description": "Required. The password used to encrypt the keys inside the wallet. The password must be a minimum of 8 characters.", - "type": "string" - }, - "type": { - "description": "Optional. The type of wallet generation for the Autonomous Database. The default value is SINGLE.", + "authenticationType": { + "description": "Optional. Used authentication mechanism to access Snowflake.", "enum": [ - "GENERATE_TYPE_UNSPECIFIED", - "ALL", - "SINGLE" + "AUTHENTICATION_TYPE_UNSPECIFIED", + "BASIC", + "KEY_PAIR" ], "enumDescriptions": [ - "Default unspecified value.", - "Used to generate wallet for all databases in the region.", - "Used to generate wallet for a single database." + "Authentication type not specified.", + "Basic authentication.", + "Key pair authentication." ], "type": "string" + }, + "connectionUrl": { + "description": "Optional. JDBC connection URL. e.g.: 'jdbc:snowflake://.snowflakecomputing.com/?warehouse=&db='", + "type": "string" + }, + "password": { + "description": "Optional. Input only. The password Oracle Goldengate uses to connect to Snowflake platform in plain text.", + "type": "string" + }, + "passwordSecretVersion": { + "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses to connect to Snowflake platform. Format: projects/{project}/secrets/{secret}/versions/{version}.", + "type": "string" + }, + "privateKeyFile": { + "description": "Optional. The content of private key file in PEM format.", + "type": "string" + }, + "privateKeyPassphraseSecret": { + "description": "Optional. Password if the private key file is encrypted.", + "type": "string" + }, + "technologyType": { + "description": "Optional. The technology type of SnowflakeConnection.", + "type": "string" + }, + "username": { + "description": "Optional. The username Oracle Goldengate uses to connect to Snowflake.", + "type": "string" } }, "type": "object" }, - "GenerateAutonomousDatabaseWalletResponse": { - "description": "The response for `AutonomousDatabase.GenerateWallet`.", - "id": "GenerateAutonomousDatabaseWalletResponse", + "GoogleCloudStorageIcebergStorage": { + "description": "The Google Cloud Storage Iceberg storage.", + "id": "GoogleCloudStorageIcebergStorage", "properties": { - "archiveContent": { - "description": "Output only. The base64 encoded wallet files.", - "format": "byte", - "readOnly": true, + "bucket": { + "description": "Required. The bucket of Google Cloud Storage.", + "type": "string" + }, + "projectId": { + "description": "Required. The project ID of Google Cloud Storage.", + "type": "string" + }, + "serviceAccountKeyFile": { + "description": "Optional. The service account key file of Google Cloud Storage.", "type": "string" } }, "type": "object" }, - "GiVersion": { - "description": "Details of the Oracle Grid Infrastructure (GI) version resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/GiVersionSummary/", - "id": "GiVersion", + "IcebergCatalog": { + "description": "The Iceberg catalog details.", + "id": "IcebergCatalog", "properties": { - "name": { - "description": "Identifier. The name of the Oracle Grid Infrastructure (GI) version resource with the format: projects/{project}/locations/{region}/giVersions/{gi_versions}", + "catalogType": { + "description": "Required. The type of Iceberg catalog.", + "enum": [ + "CATALOG_TYPE_UNSPECIFIED", + "GLUE", + "HADOOP", + "NESSIE", + "POLARIS", + "REST" + ], + "enumDescriptions": [ + "Catalog type not specified.", + "Glue catalog.", + "Hadoop catalog.", + "Nessie catalog.", + "Polaris catalog.", + "REST catalog." + ], "type": "string" }, - "version": { - "description": "Optional. version", + "glueIcebergCatalog": { + "$ref": "GlueIcebergCatalog", + "description": "The Glue Iceberg catalog." + }, + "nessieIcebergCatalog": { + "$ref": "NessieIcebergCatalog", + "description": "The Nessie Iceberg catalog." + }, + "polarisIcebergCatalog": { + "$ref": "PolarisIcebergCatalog", + "description": "The Polaris Iceberg catalog." + }, + "restIcebergCatalog": { + "$ref": "RestIcebergCatalog", + "description": "The REST Iceberg catalog." + } + }, + "type": "object" + }, + "IcebergStorage": { + "description": "The Iceberg storage details.", + "id": "IcebergStorage", + "properties": { + "amazonS3IcebergStorage": { + "$ref": "AmazonS3IcebergStorage", + "description": "The Amazon S3 Iceberg storage." + }, + "azureDataLakeStorageIcebergStorage": { + "$ref": "AzureDataLakeStorageIcebergStorage", + "description": "The Azure Data Lake Storage Iceberg storage." + }, + "googleCloudStorageIcebergStorage": { + "$ref": "GoogleCloudStorageIcebergStorage", + "description": "The Google Cloud Storage Iceberg storage." + }, + "storageType": { + "description": "Required. The type of Iceberg storage.", + "enum": [ + "STORAGE_TYPE_UNSPECIFIED", + "AMAZON_S3", + "GOOGLE_CLOUD_STORAGE", + "AZURE_DATA_LAKE_STORAGE" + ], + "enumDescriptions": [ + "Storage type not specified.", + "Amazon S3 storage.", + "Google Cloud Storage storage.", + "Azure Data Lake Storage storage." + ], "type": "string" } }, @@ -5938,6 +9803,38 @@ }, "type": "object" }, + "IngressIp": { + "description": "The ingress IPs of the GoldengateDeployment.", + "id": "IngressIp", + "properties": { + "ingressIpAddress": { + "description": "Output only. The ingress IP.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "KafkaBootstrapServer": { + "description": "Represents a Kafka bootstrap server with host name, optional port defaults to 9092, and an optional private ip.", + "id": "KafkaBootstrapServer", + "properties": { + "host": { + "description": "Required. The name or address of a host.", + "type": "string" + }, + "port": { + "description": "Optional. The port of an endpoint usually specified for a connection.", + "format": "int32", + "type": "integer" + }, + "privateIpAddress": { + "description": "Optional. The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.", + "type": "string" + } + }, + "type": "object" + }, "ListAutonomousDatabaseBackupsResponse": { "description": "The response for `AutonomousDatabaseBackup.List`.", "id": "ListAutonomousDatabaseBackupsResponse", @@ -6304,6 +10201,181 @@ }, "type": "object" }, + "ListGoldengateConnectionAssignmentsResponse": { + "description": "Response message for listing GoldengateConnectionAssignments.", + "id": "ListGoldengateConnectionAssignmentsResponse", + "properties": { + "goldengateConnectionAssignments": { + "description": "The list of GoldengateConnectionAssignments.", + "items": { + "$ref": "GoldengateConnectionAssignment" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "unreachable": { + "description": "Unreachable locations when listing resources across all locations using wildcard location '-'.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListGoldengateConnectionTypesResponse": { + "description": "Message for response to listing GoldengateConnectionTypes", + "id": "ListGoldengateConnectionTypesResponse", + "properties": { + "goldengateConnectionTypes": { + "description": "The list of GoldengateConnectionType", + "items": { + "$ref": "GoldengateConnectionType" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "unreachable": { + "description": "Unordered list. Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListGoldengateConnectionsResponse": { + "description": "The response for `GoldengateConnection.List`.", + "id": "ListGoldengateConnectionsResponse", + "properties": { + "goldengateConnections": { + "description": "The list of GoldengateConnections.", + "items": { + "$ref": "GoldengateConnection" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + }, + "unreachable": { + "description": "Optional. Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListGoldengateDeploymentEnvironmentsResponse": { + "description": "Message for response to listing GoldengateDeploymentEnvironments", + "id": "ListGoldengateDeploymentEnvironmentsResponse", + "properties": { + "goldengateDeploymentEnvironments": { + "description": "The list of GoldengateDeploymentEnvironment", + "items": { + "$ref": "GoldengateDeploymentEnvironment" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results the server should return. If this field is empty, there are no subsequent pages.", + "type": "string" + }, + "unreachable": { + "description": "Unordered list. Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListGoldengateDeploymentTypesResponse": { + "description": "Message for response to listing GoldengateDeploymentTypes", + "id": "ListGoldengateDeploymentTypesResponse", + "properties": { + "goldengateDeploymentTypes": { + "description": "The list of GoldengateDeploymentType", + "items": { + "$ref": "GoldengateDeploymentType" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "unreachable": { + "description": "Unordered list. The resource names of locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListGoldengateDeploymentVersionsResponse": { + "description": "Message for response to listing GoldengateDeploymentVersions", + "id": "ListGoldengateDeploymentVersionsResponse", + "properties": { + "goldengateDeploymentVersions": { + "description": "The list of GoldengateDeploymentVersion", + "items": { + "$ref": "GoldengateDeploymentVersion" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "unreachable": { + "description": "Unordered list. Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListGoldengateDeploymentsResponse": { + "description": "The response for `GoldengateDeployment.List`.", + "id": "ListGoldengateDeploymentsResponse", + "properties": { + "goldengateDeployments": { + "description": "The list of GoldengateDeployments.", + "items": { + "$ref": "GoldengateDeployment" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + }, + "unreachable": { + "description": "Optional. Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "id": "ListLocationsResponse", @@ -6630,6 +10702,36 @@ }, "type": "object" }, + "NameValuePair": { + "description": "A name-value pair representing an attribute entry usable in a list of attributes.", + "id": "NameValuePair", + "properties": { + "key": { + "description": "Required. The name of the property entry.", + "type": "string" + }, + "value": { + "description": "Required. The value of the property entry.", + "type": "string" + } + }, + "type": "object" + }, + "NessieIcebergCatalog": { + "description": "The Nessie Iceberg catalog.", + "id": "NessieIcebergCatalog", + "properties": { + "branch": { + "description": "Required. The Nessie branch.", + "type": "string" + }, + "uri": { + "description": "Required. The Nessie uri.", + "type": "string" + } + }, + "type": "object" + }, "OdbNetwork": { "description": "Represents OdbNetwork resource.", "id": "OdbNetwork", @@ -7036,6 +11138,33 @@ }, "type": "object" }, + "PolarisIcebergCatalog": { + "description": "The Polaris Iceberg catalog.", + "id": "PolarisIcebergCatalog", + "properties": { + "clientId": { + "description": "Required. The Polaris client ID.", + "type": "string" + }, + "clientSecret": { + "description": "Optional. The Polaris client secret.", + "type": "string" + }, + "polarisCatalog": { + "description": "Required. The catalog name within Polaris.", + "type": "string" + }, + "principalRole": { + "description": "Required. The Polaris principal role.", + "type": "string" + }, + "uri": { + "description": "Required. The Polaris uri.", + "type": "string" + } + }, + "type": "object" + }, "RemoveVirtualMachineExadbVmClusterRequest": { "description": "The request for `ExadbVmCluster.RemoveVirtualMachine`.", "id": "RemoveVirtualMachineExadbVmClusterRequest", @@ -7054,6 +11183,21 @@ }, "type": "object" }, + "RestIcebergCatalog": { + "description": "The REST Iceberg catalog.", + "id": "RestIcebergCatalog", + "properties": { + "properties": { + "description": "Optional. The content of the configuration file containing additional properties for the REST catalog.", + "type": "string" + }, + "uri": { + "description": "Required. The REST uri.", + "type": "string" + } + }, + "type": "object" + }, "RestartAutonomousDatabaseRequest": { "description": "The request for `AutonomousDatabase.Restart`.", "id": "RestartAutonomousDatabaseRequest", @@ -7135,6 +11279,12 @@ "properties": {}, "type": "object" }, + "StartGoldengateDeploymentRequest": { + "description": "The request for `GoldengateDeployment.Start`.", + "id": "StartGoldengateDeploymentRequest", + "properties": {}, + "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", @@ -7168,6 +11318,12 @@ "properties": {}, "type": "object" }, + "StopGoldengateDeploymentRequest": { + "description": "The request for `GoldengateDeployment.Stop`.", + "id": "StopGoldengateDeploymentRequest", + "properties": {}, + "type": "object" + }, "StorageSizeDetails": { "description": "The initial storage size, in gigabytes, that is applicable for virtual machine DBSystem.", "id": "StorageSizeDetails", @@ -7198,6 +11354,82 @@ }, "type": "object" }, + "TestConnectionAssignmentError": { + "description": "Error details for TestGoldengateConnectionAssignment.", + "id": "TestConnectionAssignmentError", + "properties": { + "action": { + "description": "The text describing the action required to fix the issue.", + "type": "string" + }, + "code": { + "description": "A short error code that defines the error, meant for programmatic parsing.", + "type": "string" + }, + "issue": { + "description": "The text describing the root cause of the reported issue.", + "type": "string" + }, + "message": { + "description": "A human-readable error message.", + "type": "string" + } + }, + "type": "object" + }, + "TestGoldengateConnectionAssignmentRequest": { + "description": "Request message for TestGoldengateConnectionAssignment.", + "id": "TestGoldengateConnectionAssignmentRequest", + "properties": { + "type": { + "description": "Optional. The type of the test of the assigned connection. The only type actually supported is DEFAULT.", + "enum": [ + "TEST_TYPE_UNSPECIFIED", + "DEFAULT" + ], + "enumDescriptions": [ + "The default value. This value is unused.", + "The default connection test." + ], + "type": "string" + } + }, + "type": "object" + }, + "TestGoldengateConnectionAssignmentResponse": { + "description": "The result of the connectivity test performed between the Goldengate deployment and the associated database / service.", + "id": "TestGoldengateConnectionAssignmentResponse", + "properties": { + "error": { + "$ref": "TestConnectionAssignmentError", + "description": "Error details if test connection failed." + }, + "errors": { + "description": "List of test connection assignment error objects.", + "items": { + "$ref": "TestConnectionAssignmentError" + }, + "type": "array" + }, + "resultType": { + "description": "Type of the result i.e. Success, Failure or Timeout.", + "enum": [ + "RESULT_TYPE_UNSPECIFIED", + "SUCCEEDED", + "FAILED", + "TIMED_OUT" + ], + "enumDescriptions": [ + "Result type is unspecified.", + "Test connection succeeded.", + "Test connection failed.", + "Test connection timed out." + ], + "type": "string" + } + }, + "type": "object" + }, "TimeOfDay": { "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", "id": "TimeOfDay", diff --git a/discovery/osconfig-v1.json b/discovery/osconfig-v1.json index 07924530678..34579072907 100644 --- a/discovery/osconfig-v1.json +++ b/discovery/osconfig-v1.json @@ -15,6 +15,13 @@ "description": "OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/compute/docs/osconfig/rest", + "endpoints": [ + { + "description": "Regional Endpoint", + "endpointUrl": "https://osconfig.us-east7.rep.googleapis.com/", + "location": "us-east7" + } + ], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -1083,7 +1090,7 @@ } } }, - "revision": "20260423", + "revision": "20260507", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "AptSettings": { diff --git a/discovery/osconfig-v1alpha.json b/discovery/osconfig-v1alpha.json index bd33b2e15de..3de02750f0f 100644 --- a/discovery/osconfig-v1alpha.json +++ b/discovery/osconfig-v1alpha.json @@ -15,6 +15,13 @@ "description": "OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/compute/docs/osconfig/rest", + "endpoints": [ + { + "description": "Regional Endpoint", + "endpointUrl": "https://osconfig.us-east7.rep.googleapis.com/", + "location": "us-east7" + } + ], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -707,7 +714,7 @@ } } }, - "revision": "20260423", + "revision": "20260507", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "CVSSv3": { diff --git a/discovery/osconfig-v1beta.json b/discovery/osconfig-v1beta.json index e905f26f8db..89db86a6c2b 100644 --- a/discovery/osconfig-v1beta.json +++ b/discovery/osconfig-v1beta.json @@ -15,6 +15,13 @@ "description": "OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/compute/docs/osconfig/rest", + "endpoints": [ + { + "description": "Regional Endpoint", + "endpointUrl": "https://osconfig.us-east7.rep.googleapis.com/", + "location": "us-east7" + } + ], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -689,7 +696,7 @@ } } }, - "revision": "20260423", + "revision": "20260507", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "AptRepository": { diff --git a/discovery/osconfig-v2.json b/discovery/osconfig-v2.json index 12d9a3df3b4..de96aede93d 100644 --- a/discovery/osconfig-v2.json +++ b/discovery/osconfig-v2.json @@ -15,6 +15,13 @@ "description": "OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/compute/docs/osconfig/rest", + "endpoints": [ + { + "description": "Regional Endpoint", + "endpointUrl": "https://osconfig.us-east7.rep.googleapis.com/", + "location": "us-east7" + } + ], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -1072,7 +1079,7 @@ } } }, - "revision": "20260423", + "revision": "20260507", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/discovery/osconfig-v2beta.json b/discovery/osconfig-v2beta.json index 38c5db28082..d0267a7fbae 100644 --- a/discovery/osconfig-v2beta.json +++ b/discovery/osconfig-v2beta.json @@ -15,6 +15,13 @@ "description": "OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/compute/docs/osconfig/rest", + "endpoints": [ + { + "description": "Regional Endpoint", + "endpointUrl": "https://osconfig.us-east7.rep.googleapis.com/", + "location": "us-east7" + } + ], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -1072,7 +1079,7 @@ } } }, - "revision": "20260423", + "revision": "20260507", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/discovery/recaptchaenterprise-v1.json b/discovery/recaptchaenterprise-v1.json index a146540fdc8..725b494bf68 100644 --- a/discovery/recaptchaenterprise-v1.json +++ b/discovery/recaptchaenterprise-v1.json @@ -786,7 +786,7 @@ } } }, - "revision": "20260426", + "revision": "20260505", "rootUrl": "https://recaptchaenterprise.googleapis.com/", "schemas": { "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": { @@ -1203,7 +1203,7 @@ "type": "string" }, "name": { - "description": "Optional. Enumerated string value that indicates the identity of the bot, formatted in kebab-case.", + "description": "Optional. Enumerated string value that indicates the identity of the bot, formatted in kebab-case. Current example values include the following: * google-agent * browser-base * chat-gpt * aws-bedrock * cybaa-bot * cloudflare * payhawk Ensure that your applications can handle identifier values not explicitly listed here. Deprecated values might take some time to stop showing up in responses. New values can be pushed so this list should be taken as non exhaustive.", "type": "string" } }, diff --git a/discovery/retail-v2.json b/discovery/retail-v2.json index 6bf97bd066e..5b077506698 100644 --- a/discovery/retail-v2.json +++ b/discovery/retail-v2.json @@ -384,7 +384,7 @@ "type": "string" }, "updateMask": { - "description": "Indicates which fields in the provided Catalog to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.", + "description": "Optional. Indicates which fields in the provided Catalog to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -446,7 +446,7 @@ "type": "string" }, "updateMask": { - "description": "Indicates which fields in the provided AttributesConfig to update. The following is the only supported field: * AttributesConfig.catalog_attributes If not set, all supported fields are updated.", + "description": "Optional. Indicates which fields in the provided AttributesConfig to update. The following is the only supported field: * AttributesConfig.catalog_attributes If not set, all supported fields are updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -480,7 +480,7 @@ "type": "string" }, "updateMask": { - "description": "Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.auto_learning If not set, all supported fields are updated.", + "description": "Optional. Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.auto_learning If not set, all supported fields are updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -2353,7 +2353,7 @@ } } }, - "revision": "20260423", + "revision": "20260507", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -5403,7 +5403,7 @@ "description": "Required. The updated CatalogAttribute." }, "updateMask": { - "description": "Indicates which fields in the provided CatalogAttribute to update. The following are NOT supported: * CatalogAttribute.key If not set, all supported fields are updated.", + "description": "Optional. Indicates which fields in the provided CatalogAttribute to update. The following are NOT supported: * CatalogAttribute.key If not set, all supported fields are updated.", "format": "google-fieldmask", "type": "string" } diff --git a/discovery/retail-v2alpha.json b/discovery/retail-v2alpha.json index 41fe295ca7c..f8e84fbc36b 100644 --- a/discovery/retail-v2alpha.json +++ b/discovery/retail-v2alpha.json @@ -582,7 +582,7 @@ "type": "string" }, "updateMask": { - "description": "Indicates which fields in the provided Catalog to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.", + "description": "Optional. Indicates which fields in the provided Catalog to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -644,7 +644,7 @@ "type": "string" }, "updateMask": { - "description": "Indicates which fields in the provided AttributesConfig to update. The following is the only supported field: * AttributesConfig.catalog_attributes If not set, all supported fields are updated.", + "description": "Optional. Indicates which fields in the provided AttributesConfig to update. The following is the only supported field: * AttributesConfig.catalog_attributes If not set, all supported fields are updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -678,7 +678,7 @@ "type": "string" }, "updateMask": { - "description": "Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.auto_learning If not set, all supported fields are updated.", + "description": "Optional. Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.auto_learning If not set, all supported fields are updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -2874,7 +2874,7 @@ } } }, - "revision": "20260423", + "revision": "20260507", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -7283,7 +7283,7 @@ "description": "Required. The updated CatalogAttribute." }, "updateMask": { - "description": "Indicates which fields in the provided CatalogAttribute to update. The following are NOT supported: * CatalogAttribute.key If not set, all supported fields are updated.", + "description": "Optional. Indicates which fields in the provided CatalogAttribute to update. The following are NOT supported: * CatalogAttribute.key If not set, all supported fields are updated.", "format": "google-fieldmask", "type": "string" } diff --git a/discovery/retail-v2beta.json b/discovery/retail-v2beta.json index 71df9a58b8b..f35d7887f4c 100644 --- a/discovery/retail-v2beta.json +++ b/discovery/retail-v2beta.json @@ -445,7 +445,7 @@ "type": "string" }, "updateMask": { - "description": "Indicates which fields in the provided Catalog to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.", + "description": "Optional. Indicates which fields in the provided Catalog to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -507,7 +507,7 @@ "type": "string" }, "updateMask": { - "description": "Indicates which fields in the provided AttributesConfig to update. The following is the only supported field: * AttributesConfig.catalog_attributes If not set, all supported fields are updated.", + "description": "Optional. Indicates which fields in the provided AttributesConfig to update. The following is the only supported field: * AttributesConfig.catalog_attributes If not set, all supported fields are updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -541,7 +541,7 @@ "type": "string" }, "updateMask": { - "description": "Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.auto_learning If not set, all supported fields are updated.", + "description": "Optional. Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.auto_learning If not set, all supported fields are updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -2498,7 +2498,7 @@ } } }, - "revision": "20260423", + "revision": "20260507", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -7213,7 +7213,7 @@ "description": "Required. The updated CatalogAttribute." }, "updateMask": { - "description": "Indicates which fields in the provided CatalogAttribute to update. The following are NOT supported: * CatalogAttribute.key If not set, all supported fields are updated.", + "description": "Optional. Indicates which fields in the provided CatalogAttribute to update. The following are NOT supported: * CatalogAttribute.key If not set, all supported fields are updated.", "format": "google-fieldmask", "type": "string" } diff --git a/discovery/run-v1.json b/discovery/run-v1.json index 5176728ec58..0e05a88e38a 100644 --- a/discovery/run-v1.json +++ b/discovery/run-v1.json @@ -3612,7 +3612,7 @@ } } }, - "revision": "20260501", + "revision": "20260512", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -5066,11 +5066,10 @@ "readOnly": true }, "results": { - "description": "Output only. Declaration of results for this build step.", + "description": "Declaration of results for this build step.", "items": { "$ref": "GoogleDevtoolsCloudbuildV1StepResult" }, - "readOnly": true, "type": "array" }, "script": { @@ -6923,7 +6922,7 @@ "additionalProperties": { "type": "string" }, - "description": "Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution.", + "description": "Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution . * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution . * `run.googleapis.com/execution-environment`: Revision, Execution . * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution . * `run.googleapis.com/vpc-access-egress`: Revision, Execution.", "type": "object" }, "clusterName": { diff --git a/discovery/run-v2.json b/discovery/run-v2.json index e33e30b71f0..570121424e4 100644 --- a/discovery/run-v2.json +++ b/discovery/run-v2.json @@ -2610,7 +2610,7 @@ } } }, - "revision": "20260501", + "revision": "20260512", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -6702,11 +6702,10 @@ "readOnly": true }, "results": { - "description": "Output only. Declaration of results for this build step.", + "description": "Declaration of results for this build step.", "items": { "$ref": "GoogleDevtoolsCloudbuildV1StepResult" }, - "readOnly": true, "type": "array" }, "script": { diff --git a/discovery/servicemanagement-v1.json b/discovery/servicemanagement-v1.json index 4b7c1bf2c7a..6dbbb74803f 100644 --- a/discovery/servicemanagement-v1.json +++ b/discovery/servicemanagement-v1.json @@ -835,7 +835,7 @@ } } }, - "revision": "20260406", + "revision": "20260430", "rootUrl": "https://servicemanagement.googleapis.com/", "schemas": { "Advice": { @@ -3178,7 +3178,8 @@ "STREET_VIEW", "SHOPPING", "GEO", - "GENERATIVE_AI" + "GENERATIVE_AI", + "HEALTH" ], "enumDescriptions": [ "Not useful.", @@ -3188,7 +3189,8 @@ "Street View Org.", "Shopping Org.", "Geo Org.", - "Generative AI - https://developers.generativeai.google" + "Generative AI - https://developers.generativeai.google", + "Health Org." ], "type": "string" }, diff --git a/discovery/sqladmin-v1.json b/discovery/sqladmin-v1.json index 447f9a51118..335b192b88c 100644 --- a/discovery/sqladmin-v1.json +++ b/discovery/sqladmin-v1.json @@ -3022,7 +3022,7 @@ } } }, - "revision": "20260424", + "revision": "20260510", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -8106,16 +8106,18 @@ "type": "array" }, "edition": { - "description": "Optional. The edition of the instance.", + "description": "Optional. The edition type of the Cloud SQL instance.", "enum": [ "EDITION_UNSPECIFIED", "ENTERPRISE", - "ENTERPRISE_PLUS" + "ENTERPRISE_PLUS", + "DEVELOPER" ], "enumDescriptions": [ "The instance did not specify the edition.", "The instance is an enterprise edition.", - "The instance is an Enterprise Plus edition." + "The instance is an Enterprise Plus edition.", + "This instance is a Cloud SQL developer edition instance." ], "type": "string" }, diff --git a/discovery/tagmanager-v2.json b/discovery/tagmanager-v2.json index 896b04404fe..7d77edd8cdf 100644 --- a/discovery/tagmanager-v2.json +++ b/discovery/tagmanager-v2.json @@ -3986,7 +3986,7 @@ } } }, - "revision": "20260304", + "revision": "20260511", "rootUrl": "https://tagmanager.googleapis.com/", "schemas": { "Account": { @@ -4405,6 +4405,116 @@ }, "type": "object" }, + "CompilerErrorLite": { + "id": "CompilerErrorLite", + "properties": { + "errorMessage": { + "type": "string" + }, + "errorType": { + "enum": [ + "unknownErrorType", + "duplicateAutoEventName", + "duplicateConditionId", + "duplicateDefaultMacro", + "duplicateTagName", + "internalCompilerError", + "invalidMacroKey", + "invalidNumberPredicateArgs", + "invalidMacroFormat", + "invalidMacroNameReference", + "invalidMacroParameter", + "invalidUsageContext", + "invalidRegex", + "macroCycle", + "unknownConditionId", + "unknownMacroInstance", + "invalidManualEscaping", + "invalidHtmlCssJs", + "macroInCommentsError", + "jsCompilerError", + "jsonError", + "invalidTagParameter", + "javascriptTooLong", + "unknownTagInstance", + "invalidTagReference", + "unknownTriggerId", + "customTriggerMissingEventFilter", + "duplicateTriggerId", + "unsupportedTriggerType", + "invalidTriggerParameter", + "duplicateExperimentId", + "pixieCompilerError", + "macroNotServerSideResolvable", + "invalidBlockingTrigger", + "lineTooLong", + "invalidTypeInSelect", + "gaExperimentMacroIsDeprecated", + "unsafeHtmlContent", + "unsafeHtmlAttributeValue", + "unsafeCssContent", + "parameterReferenceNotFound", + "invalidCustomTemplateRuntimeCode", + "conflictingDestinationRouting", + "missingRequiredActivity", + "unresolvableDestinationTag", + "invalidDestinationTag", + "tosRequiredForThirdPartyTags" + ], + "enumDescriptions": [ + "Unknown error type. Place holder for the enum's default value; not valid.", + "There are multiple auto-event instances with the same name. parent - N EntityKeys each with their auto_event_key populated.", + "There are multiple conditions with the same id. parent - N EntityKeys each with their condition_key populated.", + "There are multiple default macros with the same name. parent - N EntityKeys each with their macro_key populated. context - The macro name.", + "There are multiple tag instances with the same name. parent - N EntityKeys each with their tag_key populated.", + "An internal compiler invariant was broken. parent - 1 EntityKey which may have macro_key, condition_key, or tag_key populated. It's also possible that no keys are populated. context - An internal string (shouldn't be shown to the user) describing the problem.", + "An macro instance key was invalid e.g. foo#bar parent - 1 EntityKey with one of the following populated: macro_key, condition_key, tag_key. context - The string of the invalid name.", + "Wrong number of args passed to a predicate. parent - 1 EntityKey with its condition_key populated.", + "Macro format was invalid e.g. foo#bar parent - 1 EntityKey with one of the following populated: condition_key, tag_key. context - The full string of the invalid macro and surrounding literals.", + "A macro name was referenced instead of a macro key. parent - 1 EntityKey with one of the following populated: condition_key, tag_key. context - The name of the invalid macro name.", + "Macro had an invalid parameter. This could be anything from a parameter being a complex type or a macro parameter containing a macro reference. parent - 1 EntityKey with its macro_key populated. context - The value of the offending parameter if it is string-able.", + "Usage context of a container was invalid. Currently, this error can occur when a container context specifies both web and mobile. The UI shouldn't allowed creating such a mixed container. parent - not set context - The description of the context", + "Contents of an Regex predicate had an invalid pattern. parent - 1 EntityKey with one of the following populated: condition_key. context - The offending pattern.", + "There was a macro whose resolution would depend on itself. parent - N EntityKeys each with their macro_key, trigger_key, or condition_key populated. This represents the macro cycle. context - Empty.", + "A condition id was used which doesn't exist in the conditions list. parent - 1 EntityKey with its tag_key populated. context - The integer id of the missing conditional.", + "A macro name was used which doesn't exist in the macro list. parent - 1 EntityKey with one of the following populated: condition_key, tag_key. context - The name of the missing macro instance.", + "User-provided escaping inappropriate for the context in which it is used. parent - 1 EntityKey with one of the following populated: macro_key, condition_key, tag_key. context - Empty.", + "Auto-escaped content is not valid HTML, CSS or JavaScript. parent - 1 EntityKey with one of the following populated: tag_key. context - Empty.", + "Macro reference found inside an HTML, CSS or JavaScript comment. parent - 1 EntityKey with one of the following populated: tag_key. context - Empty.", + "Contents of an HTML script tag could not be compiled by JsCompiler. parent - 1 EntityKey with one of the following populated: tag_key. context - Empty.", + "Contents of a ConfigurationValue script tag could not be parsed by the JSON parser. parent - 1 EntityKey with one of the following populated: tag_key. context - Empty.", + "Tag had an invalid parameter. This could be anything from a parameter being a complex type or a macro parameter containing a macro reference. parent - 1 EntityKey with its tag_key populated. context - The value of the offending parameter if it is string-able.", + "An arbitrary HTML tag contains a piece of javascript with too many contiguous non-whitespace characters (e.g. a long array with no spaces between elements or an extremely long variable name).", + "A tag name was used which doesn't exist in the input tag list. parent - 1 EntityKey with tag_key populated. context - The name of the missing tag instance.", + "A tag name was used which doesn't exist in the compiled tag list. This happens if a tag is dependent on another tag, but the other tag has no rules attached to it and is pruned in the compiler. parent - 1 EntityKey with tag_key populated. context - The name of the missing tag instance.", + "A trigger id was used which doesn't exist in the triggers list. parent - 1 EntityKey parent of the unknown trigger. context - The id of the missing trigger instance.", + "A trigger of type custom trigger was created that doesn't include a custom event filter. parent - 1 EntityKey with its trigger_key populated. context - Empty.", + "There are multiple triggers with the same id. parent - N EntityKeys each with their trigger_key populated. context - Empty.", + "There is an unknown or unsupported trigger type. parent - 1 EntityKey with its trigger_key populated. context - The trigger type.", + "A trigger has an invalid parameter. parent - 1 EntityKey with its trigger_key populated. context - The invalid field.", + "There are multiple experiments with the same id. parent - N EntityKeys each with their experiment_key populated. context - Empty.", + "Contents of a pixie tag/macro could not be compiled by Pixie Parser. parent - 1 EntityKey with one of the following populated: tag_key, macro_key. context - Empty.", + "The macro cannot be resolved at server side. parent - 1 EntityKey indicating the entity in which this macro is used. context - The macro name.", + "The trigger cannot be used in blocking predicates (i.e. only All/Some pages triggers work for AMP, NS etc.) parent - 1 EntityKey indicating the tag in which this trigger is used. context - The trigger name.", + "A line in the input text is too long.", + "The value of a SELECT parameter in a vendor template instance does not point to an allowed vendor template instance. For details, see the documentation of the typesInSelect property in a vendor template. parent - 1 EntityKey indicating the tag/macro with this parameter. context - The parameter name.", + "The input container version contains a deprecated GA content experiment macro that needs to be removed.", + "Reminder: new error types will be treated as internal errors and trigger alerts unless they are handled in j/c/g/analytics/containertag/compiler/ErrorReporter.java&l=104 Please also remember to add new error types to CTUI at j/c/g/analytics/containertag/ui/app/components/container/compilererror/ HTML is not sanitized and contains unsafe content.", + "HTML attribute is not sanitized and the value is unsafe.", + "CSS is not sanitized and contains unsafe content.", + "The specified parameter was not found in the referenced entity. parent - 1 EntityKey with tag_key populated. context - The missing parameter in the form of \".\".", + "The custom template has invalid runtime code. parent - Entity key for the custom template. context - The error message.", + "The container version contains a Google tag tag and a destination tag that use the same destination ID. parent - Entity key for the conflicting Google tag. context - The Google tag tag name.", + "The container version has routing destinations, but is missing required activity instances. parent - Empty. context - Empty. proposed_change - The proposed change to add the missing activities.", + "The container version contains a product destination tag with a destination ID value that cannot be resolved statically. parent - Entity key of the destination tag. context - The name of the variable that could not be resolved. If the destination ID was a template value, then this will be the serialized value.", + "The container version contains a product destination tag with a destination ID value that is in an invalid format. parent - Entity key of the destination tag. context - The invalid destination ID.", + "GTM ToS is required for publishing versions with 3P tags. parent - not set context - Empty." + ], + "type": "string" + } + }, + "type": "object" + }, "Condition": { "description": "Represents a predicate.", "id": "Condition", @@ -4851,6 +4961,13 @@ "description": "Compiler errors or not.", "type": "boolean" }, + "compilerErrors": { + "description": "Compiler error details.", + "items": { + "$ref": "CompilerErrorLite" + }, + "type": "array" + }, "containerVersion": { "$ref": "ContainerVersion", "description": "The container version created." @@ -5685,6 +5802,13 @@ "description": "Compiler errors or not.", "type": "boolean" }, + "compilerErrors": { + "description": "Compiler error details.", + "items": { + "$ref": "CompilerErrorLite" + }, + "type": "array" + }, "containerVersion": { "$ref": "ContainerVersion", "description": "The container version created." @@ -5700,6 +5824,13 @@ "description": "Were there compiler errors or not.", "type": "boolean" }, + "compilerErrors": { + "description": "Compiler error details.", + "items": { + "$ref": "CompilerErrorLite" + }, + "type": "array" + }, "containerVersion": { "$ref": "ContainerVersion", "description": "The quick previewed container version." diff --git a/discovery/threatintelligence-v1beta.json b/discovery/threatintelligence-v1beta.json index c861e8773b1..6f485b85a30 100644 --- a/discovery/threatintelligence-v1beta.json +++ b/discovery/threatintelligence-v1beta.json @@ -20,6 +20,21 @@ "description": "Regional Endpoint", "endpointUrl": "https://threatintelligence.us-central1.rep.googleapis.com/", "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://threatintelligence.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://threatintelligence.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://threatintelligence.us.rep.googleapis.com/", + "location": "us" } ], "fullyEncodeReservedExpansion": true, @@ -817,7 +832,7 @@ } } }, - "revision": "20260428", + "revision": "20260513", "rootUrl": "https://threatintelligence.googleapis.com/", "schemas": { "Alert": { @@ -825,7 +840,7 @@ "id": "Alert", "properties": { "aiSummary": { - "description": "Optional. AI summary of the finding.", + "description": "Optional. AI summary of the alert.", "type": "string" }, "audit": { @@ -969,7 +984,7 @@ "id": "AlertDocument", "properties": { "aiSummary": { - "description": "Output only. AI summary of the finding.", + "description": "Output only. AI summary of the document.", "readOnly": true, "type": "string" }, diff --git a/discovery/walletobjects-v1.json b/discovery/walletobjects-v1.json index 1f9fa102115..c9b89304ad0 100644 --- a/discovery/walletobjects-v1.json +++ b/discovery/walletobjects-v1.json @@ -2713,7 +2713,7 @@ } } }, - "revision": "20260508", + "revision": "20260511", "rootUrl": "https://walletobjects.googleapis.com/", "schemas": { "ActivationOptions": { @@ -7314,6 +7314,11 @@ "format": "byte", "type": "string" }, + "sha512Hash": { + "description": "Scotty-provided SHA512 hash for an upload.", + "format": "byte", + "type": "string" + }, "timestamp": { "description": "Time at which the media data was last updated, in milliseconds since UNIX epoch", "format": "uint64", diff --git a/discovery/workspaceevents-v1.json b/discovery/workspaceevents-v1.json index a88adb44e53..85881e5d34d 100644 --- a/discovery/workspaceevents-v1.json +++ b/discovery/workspaceevents-v1.json @@ -765,7 +765,7 @@ } } }, - "revision": "20260422", + "revision": "20260510", "rootUrl": "https://workspaceevents.googleapis.com/", "schemas": { "Artifact": { @@ -851,6 +851,17 @@ }, "type": "object" }, + "DriveOptions": { + "description": "Additional supported options for serving Drive events.", + "id": "DriveOptions", + "properties": { + "includeDescendants": { + "description": "Optional. Immutable. For subscriptions to Google Drive events, whether to receive events about Drive files that are children of the target folder or shared drive. * If `false`, the subscription only receives events about changes to the folder or shared drive that's specified as the `targetResource`. * If `true`, the `mimeType` field of the `file` resource must be set to `application/vnd.google-apps.folder`. For details, see [Google Drive event types](https://developers.google.com/workspace/events/guides/events-drive#event-types).", + "type": "boolean" + } + }, + "type": "object" + }, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", @@ -1197,6 +1208,10 @@ "readOnly": true, "type": "string" }, + "driveOptions": { + "$ref": "DriveOptions", + "description": "Optional. Features that are supported only for subscriptions on Drive resources." + }, "etag": { "description": "Optional. This checksum is computed by the server based on the value of other fields, and might be sent on update requests to ensure the client has an up-to-date value before proceeding.", "type": "string" diff --git a/discovery/workstations-v1beta.json b/discovery/workstations-v1beta.json index 07287cac834..907094212fa 100644 --- a/discovery/workstations-v1beta.json +++ b/discovery/workstations-v1beta.json @@ -1175,7 +1175,7 @@ } } }, - "revision": "20260413", + "revision": "20260506", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -2355,6 +2355,13 @@ "description": "Identifier. Full name of this workstation.", "type": "string" }, + "persistentDirectories": { + "description": "Optional. Directories to persist across workstation sessions.", + "items": { + "$ref": "WorkstationPersistentDirectory" + }, + "type": "array" + }, "reconciling": { "description": "Output only. Indicates whether this workstation is currently being updated to match its intended state.", "readOnly": true, @@ -2724,6 +2731,43 @@ } }, "type": "object" + }, + "WorkstationGceRegionalPersistentDisk": { + "description": "A Persistent Directory backed by a Compute Engine regional persistent disk within the workstation.", + "id": "WorkstationGceRegionalPersistentDisk", + "properties": { + "name": { + "description": "The name of the persistent directory.", + "type": "string" + }, + "sizeGb": { + "description": "Required. The desired size of the persistent directory in GB.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "WorkstationPersistentDirectory": { + "description": "A directory to persist across workstation sessions. Updates to this field will only take effect on this workstation after it is restarted.", + "id": "WorkstationPersistentDirectory", + "properties": { + "gcePd": { + "$ref": "WorkstationGceRegionalPersistentDisk", + "deprecated": true, + "description": "A PersistentDirectory backed by a Compute Engine persistent disk." + }, + "mountPath": { + "description": "Optional. The mount path of the persistent directory.", + "type": "string" + }, + "sizeGb": { + "description": "Optional. Size of the persistent directory in GB. If specified in an update request, this is the desired size of the directory.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/release-please-config.json b/release-please-config.json index 815e784d85c..79f1363c465 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -326,6 +326,7 @@ "src/apis/ces": {}, "src/apis/agentregistry": {}, "src/apis/developerknowledge": {}, - "src/apis/health": {} + "src/apis/health": {}, + "src/apis/cloudnumberregistry": {} } } \ No newline at end of file diff --git a/src/apis/aiplatform/v1.ts b/src/apis/aiplatform/v1.ts index 5a81f320ab6..5db1be6fc3f 100644 --- a/src/apis/aiplatform/v1.ts +++ b/src/apis/aiplatform/v1.ts @@ -207,6 +207,10 @@ export namespace aiplatform_v1 { * Experimental parameters for video generation. */ export interface Schema$CloudAiLargeModelsVisionGenerateVideoExperiments { + /** + * Optional. Video codec to use for output. + */ + codec?: string | null; /** * Conditioning frames for veo experimental models ONLY, not to be confused with keyframes (ID:31) in GenerateVideoRequest. */ @@ -900,11 +904,11 @@ export namespace aiplatform_v1 { */ export interface Schema$GoogleCloudAiplatformV1AsyncQueryReasoningEngineRequest { /** - * Optional. Input Cloud Storage URI for the Async query. + * Optional. Input Cloud Storage URI for the Async query. If you are not bringing your own container (BYOC), the content of the file should be a JSON object with an `input` field matching the `input` field of `QueryReasoningEngineRequest` (e.g. `{ "input": { "user_id": "hello", "message":"$QUERY"\} \}`). For BYOC, the content of the file depends on the the agent application. */ inputGcsUri?: string | null; /** - * Optional. Output Cloud Storage URI for the Async query. + * Optional. Output Cloud Storage URI for the Async query. This contains the final response of the query. */ outputGcsUri?: string | null; } @@ -1858,6 +1862,15 @@ export namespace aiplatform_v1 { */ videoDurationSeconds?: number | null; } + /** + * Request message for ReasoningEngineExecutionService.CancelAsyncQueryReasoningEngine. + */ + export interface Schema$GoogleCloudAiplatformV1CancelAsyncQueryReasoningEngineRequest { + /** + * Required. The name of the longrunning operation returned from AsyncQueryReasoningEngine. Format: `projects/{project\}/locations/{location\}/operations/{operation\}` + */ + operationName?: string | null; + } /** * Response message for ReasoningEngineExecutionService.CancelAsyncQueryReasoningEngine. */ @@ -5286,7 +5299,7 @@ export namespace aiplatform_v1 { */ datasetCustomMetrics?: Schema$GoogleCloudAiplatformV1DatasetCustomMetric[]; /** - * Required. The metrics to be calculated in the evaluation run. + * Optional. The metrics to be calculated in the evaluation run. Required when analysis_configs is not set. */ metrics?: Schema$GoogleCloudAiplatformV1EvaluationRunMetric[]; /** @@ -7776,6 +7789,10 @@ export namespace aiplatform_v1 { * Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. */ export interface Schema$GoogleCloudAiplatformV1FunctionDeclaration { + /** + * Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + */ + behavior?: string | null; /** * Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. */ @@ -16991,7 +17008,7 @@ export namespace aiplatform_v1 { */ sandboxEnvironmentSnapshot?: string | null; /** - * Optional. The name of the SandboxEnvironmentTemplate specified in the parent Agent Engine resource that this SandboxEnvironment is created from. Only one of `sandbox_environment_template` and `spec` should be set. + * Optional. The name of the SandboxEnvironmentTemplate specified in the parent Agent Engine resource that this SandboxEnvironment is created from. */ sandboxEnvironmentTemplate?: string | null; /** @@ -136083,8 +136100,14 @@ export namespace aiplatform_v1 { * await aiplatform.projects.locations.reasoningEngines.cancelAsyncQuery({ * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', - * // Required. The name of the longrunning operation returned from AsyncQueryReasoningEngine. Format: `projects/{project\}/locations/{location\}/operations/{operation\}` - * operationName: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "operationName": "my_operationName" + * // } + * }, * }); * console.log(res.data); * @@ -137903,10 +137926,11 @@ export namespace aiplatform_v1 { * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` */ name?: string; + /** - * Required. The name of the longrunning operation returned from AsyncQueryReasoningEngine. Format: `projects/{project\}/locations/{location\}/operations/{operation\}` + * Request body metadata */ - operationName?: string; + requestBody?: Schema$GoogleCloudAiplatformV1CancelAsyncQueryReasoningEngineRequest; } export interface Params$Resource$Projects$Locations$Reasoningengines$Create extends StandardParameters { /** @@ -171703,8 +171727,14 @@ export namespace aiplatform_v1 { * const res = await aiplatform.reasoningEngines.cancelAsyncQuery({ * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` * name: 'reasoningEngines/my-reasoningEngine', - * // Required. The name of the longrunning operation returned from AsyncQueryReasoningEngine. Format: `projects/{project\}/locations/{location\}/operations/{operation\}` - * operationName: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "operationName": "my_operationName" + * // } + * }, * }); * console.log(res.data); * @@ -173064,10 +173094,11 @@ export namespace aiplatform_v1 { * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` */ name?: string; + /** - * Required. The name of the longrunning operation returned from AsyncQueryReasoningEngine. Format: `projects/{project\}/locations/{location\}/operations/{operation\}` + * Request body metadata */ - operationName?: string; + requestBody?: Schema$GoogleCloudAiplatformV1CancelAsyncQueryReasoningEngineRequest; } export interface Params$Resource$Reasoningengines$Create extends StandardParameters { /** diff --git a/src/apis/alloydb/v1.ts b/src/apis/alloydb/v1.ts index 77c57b6e94c..14fcf0e5720 100644 --- a/src/apis/alloydb/v1.ts +++ b/src/apis/alloydb/v1.ts @@ -615,6 +615,10 @@ export namespace alloydb_v1 { * Configuration for Managed Connection Pool (MCP). */ export interface Schema$ConnectionPoolConfig { + /** + * Output only. The number of running AuthProxy poolers per instance. + */ + authproxyPoolerCount?: number | null; /** * Optional. Whether to enable Managed Connection Pool (MCP). */ diff --git a/src/apis/alloydb/v1alpha.ts b/src/apis/alloydb/v1alpha.ts index 3d633ddf113..f2b5c3c038c 100644 --- a/src/apis/alloydb/v1alpha.ts +++ b/src/apis/alloydb/v1alpha.ts @@ -656,6 +656,10 @@ export namespace alloydb_v1alpha { * Configuration for Managed Connection Pool (MCP). */ export interface Schema$ConnectionPoolConfig { + /** + * Output only. The number of running AuthProxy poolers per instance. + */ + authproxyPoolerCount?: number | null; /** * Optional. Whether to enable Managed Connection Pool (MCP). */ diff --git a/src/apis/alloydb/v1beta.ts b/src/apis/alloydb/v1beta.ts index ed197395a32..4a2e0bab0c7 100644 --- a/src/apis/alloydb/v1beta.ts +++ b/src/apis/alloydb/v1beta.ts @@ -644,6 +644,10 @@ export namespace alloydb_v1beta { * Configuration for Managed Connection Pool (MCP). */ export interface Schema$ConnectionPoolConfig { + /** + * Output only. The number of running AuthProxy poolers per instance. + */ + authproxyPoolerCount?: number | null; /** * Optional. Whether to enable Managed Connection Pool (MCP). */ diff --git a/src/apis/androidpublisher/v3.ts b/src/apis/androidpublisher/v3.ts index 21084a30289..432ddf25f52 100644 --- a/src/apis/androidpublisher/v3.ts +++ b/src/apis/androidpublisher/v3.ts @@ -621,7 +621,7 @@ export namespace androidpublisher_v3 { */ priceStepUpConsentDetails?: Schema$PriceStepUpConsentDetails; /** - * The current recurring price of the auto renewing plan. Note that the price does not take into account discounts and does not include taxes for tax-exclusive pricing, please call orders.get API instead if transaction details are needed. + * The current recurring price of the auto renewing plan. Note that the price does not take into account discounts and does not include taxes. For tax-exclusive pricing, please call orders.get API instead if transaction details are needed. */ recurringPrice?: Schema$Money; } diff --git a/src/apis/backupdr/v1.ts b/src/apis/backupdr/v1.ts index e1bda850682..e955b0b65bf 100644 --- a/src/apis/backupdr/v1.ts +++ b/src/apis/backupdr/v1.ts @@ -775,7 +775,7 @@ export namespace backupdr_v1 { */ backupVaultServiceAccount?: string | null; /** - * Optional. Defines optional properties specific to backups of disk-based resources, such as Compute Engine. This includes settings like whether to perform a guest flush. + * Optional. Defines optional properties specific to backups of compute instance-based resources, such as Compute Engine. This includes settings like whether to perform a guest flush. */ computeInstanceBackupPlanProperties?: Schema$ComputeInstanceBackupPlanProperties; /** @@ -1139,7 +1139,7 @@ export namespace backupdr_v1 { edition?: string | null; } /** - * --- ComputeInstanceBackupPlanProperties Message --- + * Properties for a compute instance backup plan. */ export interface Schema$ComputeInstanceBackupPlanProperties { /** @@ -1592,7 +1592,7 @@ export namespace backupdr_v1 { totalStoredBytes?: string | null; } /** - * --- DiskBackupPlanProperties Message --- + * Properties for a disk backup plan. */ export interface Schema$DiskBackupPlanProperties { /** diff --git a/src/apis/ces/v1.ts b/src/apis/ces/v1.ts index adf47eff1ac..67403aeb005 100644 --- a/src/apis/ces/v1.ts +++ b/src/apis/ces/v1.ts @@ -2630,148 +2630,6 @@ export namespace ces_v1 { */ tokenEndpoint?: string | null; } - /** - * Represents an Omnichannel resource. - */ - export interface Schema$Omnichannel { - /** - * Output only. Timestamp when the omnichannel resource was created. - */ - createTime?: string | null; - /** - * Optional. Human-readable description of the omnichannel resource. - */ - description?: string | null; - /** - * Required. Display name of the omnichannel resource. - */ - displayName?: string | null; - /** - * Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. - */ - etag?: string | null; - /** - * Optional. The integration config for the omnichannel resource. - */ - integrationConfig?: Schema$OmnichannelIntegrationConfig; - /** - * Identifier. The unique identifier of the omnichannel resource. Format: `projects/{project\}/locations/{location\}/omnichannels/{omnichannel\}` - */ - name?: string | null; - /** - * Output only. Timestamp when the omnichannel resource was last updated. - */ - updateTime?: string | null; - } - /** - * OmnichannelIntegrationConfig contains all App integration configs. - */ - export interface Schema$OmnichannelIntegrationConfig { - /** - * Optional. Various of configuration for handling App events. - */ - channelConfigs?: { - [key: string]: Schema$OmnichannelIntegrationConfigChannelConfig; - } | null; - /** - * Optional. The key of routing_configs is a key of `app_configs`, value is a `RoutingConfig`, which contains subscriber's key. - */ - routingConfigs?: { - [key: string]: Schema$OmnichannelIntegrationConfigRoutingConfig; - } | null; - /** - * Optional. Various of subscribers configs. - */ - subscriberConfigs?: { - [key: string]: Schema$OmnichannelIntegrationConfigSubscriberConfig; - } | null; - } - /** - * Configs for CES app. - */ - export interface Schema$OmnichannelIntegrationConfigCesAppConfig { - /** - * The unique identifier of the CES app. Format: `projects/{project\}/locations/{location\}/apps/{app\}` - */ - app?: string | null; - } - /** - * ChannelConfig contains config for various of app integration. - */ - export interface Schema$OmnichannelIntegrationConfigChannelConfig { - /** - * WhatsApp config. - */ - whatsappConfig?: Schema$OmnichannelIntegrationConfigWhatsappConfig; - } - /** - * Routing config specify how/who to route app events to a subscriber. - */ - export interface Schema$OmnichannelIntegrationConfigRoutingConfig { - /** - * The key of the subscriber. - */ - subscriberKey?: string | null; - } - /** - * Configs of subscribers. - */ - export interface Schema$OmnichannelIntegrationConfigSubscriberConfig { - /** - * Ces app config. - */ - cesAppConfig?: Schema$OmnichannelIntegrationConfigCesAppConfig; - } - /** - * How Omnichannel should receive/reply events from WhatsApp. - */ - export interface Schema$OmnichannelIntegrationConfigWhatsappConfig { - /** - * The Meta Business Portfolio (MBP) ID. https://www.facebook.com/business/help/1710077379203657 - */ - metaBusinessPortfolioId?: string | null; - /** - * The phone number used for sending/receiving messages. - */ - phoneNumber?: string | null; - /** - * The Phone Number ID associated with the WhatsApp Business Account. - */ - phoneNumberId?: string | null; - /** - * The verify token configured in the Meta App Dashboard for webhook verification. - */ - webhookVerifyToken?: string | null; - /** - * The customer's WhatsApp Business Account (WABA) ID. - */ - whatsappBusinessAccountId?: string | null; - /** - * The access token for authenticating API calls to the WhatsApp Cloud API. https://developers.facebook.com/docs/whatsapp/business-management-api/get-started/#business-integration-system-user-access-tokens - */ - whatsappBusinessToken?: string | null; - } - /** - * Represents the metadata of the long-running operation. - */ - export interface Schema$OmnichannelOperationMetadata { - /** - * Output only. The time the operation was created. - */ - createTime?: string | null; - /** - * Output only. The time the operation finished running. - */ - endTime?: string | null; - /** - * Output only. Identifies whether the user has requested cancellation of the operation. - */ - requestedCancellation?: boolean | null; - /** - * Output only. Human-readable status of the operation, if any. - */ - statusMessage?: string | null; - } /** * A remote API tool defined by an OpenAPI schema. */ diff --git a/src/apis/ces/v1beta.ts b/src/apis/ces/v1beta.ts index 8bd0bdfc0ba..6ae5213323a 100644 --- a/src/apis/ces/v1beta.ts +++ b/src/apis/ces/v1beta.ts @@ -1794,6 +1794,14 @@ export namespace ces_v1beta { * Output only. List of evaluation datasets the evaluation belongs to. Format: `projects/{project\}/locations/{location\}/apps/{app\}/evaluationDatasets/{evaluationDataset\}` */ evaluationDatasets?: string[] | null; + /** + * Optional. Overrides metrics config for this specific evaluation. + */ + evaluationMetricsConfigOverride?: Schema$EvaluationMetricsConfig; + /** + * Optional. Overrides metrics thresholds for this specific evaluation. + */ + evaluationMetricsThresholdOverride?: Schema$EvaluationMetricsThresholds; /** * Output only. The EvaluationRuns that this Evaluation is associated with. */ @@ -1977,10 +1985,22 @@ export namespace ces_v1beta { * Optional. Check that the agent responded with the correct response. The role "agent" is implied. */ agentResponse?: Schema$Message; + /** + * Optional. Overrides for agent_response hallucination metrics. + */ + agentResponseHallucinationMetricsConfigOverride?: Schema$EvaluationMetricsConfigHallucinationMetricsConfig; + /** + * Optional. Overrides for agent_response semantic similarity metrics. + */ + agentResponseSemanticSimilarityMetricsConfigOverride?: Schema$EvaluationMetricsConfigSemanticSimilarityMetricsConfig; /** * Optional. Check that the agent transferred the conversation to a different agent. */ agentTransfer?: Schema$AgentTransfer; + /** + * Optional. Overrides metrics at the step level. + */ + expectationLevelMetricsThresholdsOverride?: Schema$EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsExpectationLevelMetricsThresholds; /** * Optional. The tool response to mock, with the parameters of interest specified. Any parameters not specified will be hallucinated by the LLM. */ @@ -1989,6 +2009,10 @@ export namespace ces_v1beta { * Optional. A note for this requirement, useful in reporting when specific checks fail. E.g., "Check_Payment_Tool_Called". */ note?: string | null; + /** + * Optional. If set to true, this specific expectation will not be evaluated. + */ + skipEvaluation?: boolean | null; /** * Optional. Check that a specific tool was called with the parameters. */ @@ -2007,13 +2031,109 @@ export namespace ces_v1beta { */ export interface Schema$EvaluationGoldenTurn { /** - * Optional. The root span of the golden turn for processing and maintaining audio information. + * Optional. Override for turn-level hallucination metric behavior. + */ + hallucinationMetricBehaviorOverride?: string | null; + /** + * Optional. The root span of the golden turn for processing and maintaining audio information. The uri for the audio must contain audio saved in 16Khz sample rate. */ rootSpan?: Schema$Span; /** * Required. The steps required to replay a golden conversation. */ steps?: Schema$EvaluationStep[]; + /** + * Optional. Overrides for turn-level metric thresholds. + */ + turnLevelMetricsThresholdsOverride?: Schema$EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsTurnLevelMetricsThresholds; + } + /** + * Configures the metrics for an evaluation. + */ + export interface Schema$EvaluationMetricsConfig { + /** + * Optional. Configuration for the golden metrics for the evaluation. + */ + goldenMetricsConfig?: Schema$EvaluationMetricsConfigGoldenMetricsConfig; + /** + * Optional. Configuration for the scenario metrics for the evaluation. + */ + scenarioMetricsConfig?: Schema$EvaluationMetricsConfigScenarioMetricsConfig; + } + /** + * Configuration for the expectation level metrics for the evaluation. To disable the metric, set the message but do not set the `enable_expectations_met_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely. + */ + export interface Schema$EvaluationMetricsConfigExpectationsMetMetricsConfig { + /** + * Optional. Whether to calculate the expectation level metrics for the evaluation. + */ + enableExpectationsMetMetrics?: boolean | null; + } + /** + * Configuration for the golden metrics for the evaluation. + */ + export interface Schema$EvaluationMetricsConfigGoldenMetricsConfig { + /** + * Optional. Global configuration for semantic similarity metrics. + */ + semanticSimilarityMetricsConfig?: Schema$EvaluationMetricsConfigSemanticSimilarityMetricsConfig; + /** + * Optional. Configuration for step level tool correctness metrics. + */ + stepToolCorrectnessMetricsConfig?: Schema$EvaluationMetricsConfigToolCorrectnessMetricsConfig; + /** + * Optional. Configuration for turn level tool correctness metrics. + */ + toolCorrectnessMetricsConfig?: Schema$EvaluationMetricsConfigToolCorrectnessMetricsConfig; + } + /** + * Configuration for the hallucination metrics for the evaluation. To disable the metric, set the message but do not set the `enable_hallucination_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely. + */ + export interface Schema$EvaluationMetricsConfigHallucinationMetricsConfig { + /** + * Optional. Whether to calculate hallucination metrics for the evaluation. + */ + enableHallucinationMetrics?: boolean | null; + } + /** + * Configuration for the scenario metrics for the evaluation. + */ + export interface Schema$EvaluationMetricsConfigScenarioMetricsConfig { + /** + * Optional. Configuration for expectation level metrics. + */ + expectationsMetMetricsConfig?: Schema$EvaluationMetricsConfigExpectationsMetMetricsConfig; + /** + * Optional. Configuration for user goal met metrics. + */ + userGoalMetMetricsConfig?: Schema$EvaluationMetricsConfigUserGoalMetMetricsConfig; + } + /** + * Configuration for similarity metrics for the evaluation. To disable the metric, set the message but do not set the `enable_semantic_similarity_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely. + */ + export interface Schema$EvaluationMetricsConfigSemanticSimilarityMetricsConfig { + /** + * Optional. Whether to calculate semantic similarity metrics for the evaluation. + */ + enableSemanticSimilarityMetrics?: boolean | null; + } + /** + * Configuration for correctness metrics for the evaluation. To disable the metric, set the message but do not set the `enable_tool_correctness_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely. + */ + export interface Schema$EvaluationMetricsConfigToolCorrectnessMetricsConfig { + /** + * Optional. Whether to calculate tool correctness metrics for the evaluation. + */ + enableToolCorrectnessMetrics?: boolean | null; + } + /** + * Configuration for the user goal met metrics for the evaluation. To disable the metric, set the message but do not set the `enable_user_goal_met_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely. + */ + export interface Schema$EvaluationMetricsConfigUserGoalMetMetricsConfig { + /** + * Optional. Whether to calculate the user goal met metrics for the evaluation. + */ + enableUserGoalMetMetrics?: boolean | null; } /** * Threshold settings for metrics in an Evaluation. @@ -2848,6 +2968,10 @@ export namespace ces_v1beta { * Optional. The default method used to run golden evaluations. This will be used if no golden_run_method is specified in the RunEvaluationRequest. */ goldenRunMethod?: string | null; + /** + * Optional. Configures the default metrics for evaluations. + */ + metricsConfig?: Schema$EvaluationMetricsConfig; /** * Optional. Who starts the conversation in a scenario evaluation. */ @@ -4503,148 +4627,6 @@ export namespace ces_v1beta { */ tokenEndpoint?: string | null; } - /** - * Represents an Omnichannel resource. - */ - export interface Schema$Omnichannel { - /** - * Output only. Timestamp when the omnichannel resource was created. - */ - createTime?: string | null; - /** - * Optional. Human-readable description of the omnichannel resource. - */ - description?: string | null; - /** - * Required. Display name of the omnichannel resource. - */ - displayName?: string | null; - /** - * Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. - */ - etag?: string | null; - /** - * Optional. The integration config for the omnichannel resource. - */ - integrationConfig?: Schema$OmnichannelIntegrationConfig; - /** - * Identifier. The unique identifier of the omnichannel resource. Format: `projects/{project\}/locations/{location\}/omnichannels/{omnichannel\}` - */ - name?: string | null; - /** - * Output only. Timestamp when the omnichannel resource was last updated. - */ - updateTime?: string | null; - } - /** - * OmnichannelIntegrationConfig contains all App integration configs. - */ - export interface Schema$OmnichannelIntegrationConfig { - /** - * Optional. Various of configuration for handling App events. - */ - channelConfigs?: { - [key: string]: Schema$OmnichannelIntegrationConfigChannelConfig; - } | null; - /** - * Optional. The key of routing_configs is a key of `app_configs`, value is a `RoutingConfig`, which contains subscriber's key. - */ - routingConfigs?: { - [key: string]: Schema$OmnichannelIntegrationConfigRoutingConfig; - } | null; - /** - * Optional. Various of subscribers configs. - */ - subscriberConfigs?: { - [key: string]: Schema$OmnichannelIntegrationConfigSubscriberConfig; - } | null; - } - /** - * Configs for CES app. - */ - export interface Schema$OmnichannelIntegrationConfigCesAppConfig { - /** - * The unique identifier of the CES app. Format: `projects/{project\}/locations/{location\}/apps/{app\}` - */ - app?: string | null; - } - /** - * ChannelConfig contains config for various of app integration. - */ - export interface Schema$OmnichannelIntegrationConfigChannelConfig { - /** - * WhatsApp config. - */ - whatsappConfig?: Schema$OmnichannelIntegrationConfigWhatsappConfig; - } - /** - * Routing config specify how/who to route app events to a subscriber. - */ - export interface Schema$OmnichannelIntegrationConfigRoutingConfig { - /** - * The key of the subscriber. - */ - subscriberKey?: string | null; - } - /** - * Configs of subscribers. - */ - export interface Schema$OmnichannelIntegrationConfigSubscriberConfig { - /** - * Ces app config. - */ - cesAppConfig?: Schema$OmnichannelIntegrationConfigCesAppConfig; - } - /** - * How Omnichannel should receive/reply events from WhatsApp. - */ - export interface Schema$OmnichannelIntegrationConfigWhatsappConfig { - /** - * The Meta Business Portfolio (MBP) ID. https://www.facebook.com/business/help/1710077379203657 - */ - metaBusinessPortfolioId?: string | null; - /** - * The phone number used for sending/receiving messages. - */ - phoneNumber?: string | null; - /** - * The Phone Number ID associated with the WhatsApp Business Account. - */ - phoneNumberId?: string | null; - /** - * The verify token configured in the Meta App Dashboard for webhook verification. - */ - webhookVerifyToken?: string | null; - /** - * The customer's WhatsApp Business Account (WABA) ID. - */ - whatsappBusinessAccountId?: string | null; - /** - * The access token for authenticating API calls to the WhatsApp Cloud API. https://developers.facebook.com/docs/whatsapp/business-management-api/get-started/#business-integration-system-user-access-tokens - */ - whatsappBusinessToken?: string | null; - } - /** - * Represents the metadata of the long-running operation. - */ - export interface Schema$OmnichannelOperationMetadata { - /** - * Output only. The time the operation was created. - */ - createTime?: string | null; - /** - * Output only. The time the operation finished running. - */ - endTime?: string | null; - /** - * Output only. Identifies whether the user has requested cancellation of the operation. - */ - requestedCancellation?: boolean | null; - /** - * Output only. Human-readable status of the operation, if any. - */ - statusMessage?: string | null; - } /** * A remote API tool defined by an OpenAPI schema. */ @@ -14322,6 +14304,8 @@ export namespace ces_v1beta { * // "displayName": "my_displayName", * // "etag": "my_etag", * // "evaluationDatasets": [], + * // "evaluationMetricsConfigOverride": {}, + * // "evaluationMetricsThresholdOverride": {}, * // "evaluationRuns": [], * // "golden": {}, * // "invalid": false, @@ -14346,6 +14330,8 @@ export namespace ces_v1beta { * // "displayName": "my_displayName", * // "etag": "my_etag", * // "evaluationDatasets": [], + * // "evaluationMetricsConfigOverride": {}, + * // "evaluationMetricsThresholdOverride": {}, * // "evaluationRuns": [], * // "golden": {}, * // "invalid": false, @@ -14799,6 +14785,8 @@ export namespace ces_v1beta { * // "displayName": "my_displayName", * // "etag": "my_etag", * // "evaluationDatasets": [], + * // "evaluationMetricsConfigOverride": {}, + * // "evaluationMetricsThresholdOverride": {}, * // "evaluationRuns": [], * // "golden": {}, * // "invalid": false, @@ -15111,6 +15099,8 @@ export namespace ces_v1beta { * // "displayName": "my_displayName", * // "etag": "my_etag", * // "evaluationDatasets": [], + * // "evaluationMetricsConfigOverride": {}, + * // "evaluationMetricsThresholdOverride": {}, * // "evaluationRuns": [], * // "golden": {}, * // "invalid": false, @@ -15135,6 +15125,8 @@ export namespace ces_v1beta { * // "displayName": "my_displayName", * // "etag": "my_etag", * // "evaluationDatasets": [], + * // "evaluationMetricsConfigOverride": {}, + * // "evaluationMetricsThresholdOverride": {}, * // "evaluationRuns": [], * // "golden": {}, * // "invalid": false, diff --git a/src/apis/chat/v1.ts b/src/apis/chat/v1.ts index 53dd3aa2f33..fce21a576a6 100644 --- a/src/apis/chat/v1.ts +++ b/src/apis/chat/v1.ts @@ -5468,7 +5468,7 @@ export namespace chat_v1 { * pageSize: 'placeholder-value', * // A token, received from the previous search spaces call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results. * pageToken: 'placeholder-value', - * // Required. A search query. You can search by using the following parameters: - `create_time` - `customer` - `display_name` - `external_user_allowed` - `last_active_time` - `space_history_state` - `space_type` `create_time` and `last_active_time` accept a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and the supported comparison operators are: `=`, `<`, `\>`, `<=`, `\>=`. `customer` is required and is used to indicate which customer to fetch spaces from. `customers/my_customer` is the only supported value. `display_name` only accepts the `HAS` (`:`) operator. The text to match is first tokenized into tokens and each token is prefix-matched case-insensitively and independently as a substring anywhere in the space's `display_name`. For example, `Fun Eve` matches `Fun event` or `The evening was fun`, but not `notFun event` or `even`. `external_user_allowed` accepts either `true` or `false`. `space_history_state` only accepts values from the [`historyState`] (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#Space.HistoryState) field of a `space` resource. `space_type` is required and the only valid value is `SPACE`. Across different fields, only `AND` operators are supported. A valid example is `space_type = "SPACE" AND display_name:"Hello"` and an invalid example is `space_type = "SPACE" OR display_name:"Hello"`. Among the same field, `space_type` doesn't support `AND` or `OR` operators. `display_name`, 'space_history_state', and 'external_user_allowed' only support `OR` operators. `last_active_time` and `create_time` support both `AND` and `OR` operators. `AND` can only be used to represent an interval, such as `last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time \> "2023-01-01T00:00:00+00:00"`. The following example queries are valid: ``` customer = "customers/my_customer" AND space_type = "SPACE" customer = "customers/my_customer" AND space_type = "SPACE" AND display_name:"Hello World" customer = "customers/my_customer" AND space_type = "SPACE" AND (last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time \> "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (display_name:"Hello World" OR display_name:"Fun event") AND (last_active_time \> "2020-01-01T00:00:00+00:00" AND last_active_time < "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (create_time \> "2019-01-01T00:00:00+00:00" AND create_time < "2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND (space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF") ``` + * // Required. A search query. You can search by using the following parameters : - `create_time` - `customer` - `display_name` - `external_user_allowed` - `last_active_time` - `space_history_state` - `space_type` `create_time` and `last_active_time` accept a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and the supported comparison operators are: `=`, `<`, `\>`, `<=`, `\>=`. `customer` is required and is used to indicate which customer to fetch spaces from. `customers/my_customer` is the only supported value. `display_name` only accepts the `HAS` (`:`) operator. The text to match is first tokenized into tokens and each token is prefix-matched case-insensitively and independently as a substring anywhere in the space's `display_name`. For example, `Fun Eve` matches `Fun event` or `The evening was fun`, but not `notFun event` or `even`. `external_user_allowed` accepts either `true` or `false`. `space_history_state` only accepts values from the [`historyState`] (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#Space.HistoryState) field of a `space` resource. `space_type` is required and the only valid value is `SPACE`. Across different fields, only `AND` operators are supported. A valid example is `space_type = "SPACE" AND display_name:"Hello"` and an invalid example is `space_type = "SPACE" OR display_name:"Hello"`. Among the same field, `space_type` doesn't support `AND` or `OR` operators. `display_name`, 'space_history_state', and 'external_user_allowed' only support `OR` operators. `last_active_time` and `create_time` support both `AND` and `OR` operators. `AND` can only be used to represent an interval, such as `last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time \> "2023-01-01T00:00:00+00:00"`. The following example queries are valid: ``` customer = "customers/my_customer" AND space_type = "SPACE" customer = "customers/my_customer" AND space_type = "SPACE" AND display_name:"Hello World" customer = "customers/my_customer" AND space_type = "SPACE" AND (last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time \> "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (display_name:"Hello World" OR display_name:"Fun event") AND (last_active_time \> "2020-01-01T00:00:00+00:00" AND last_active_time < "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (create_time \> "2019-01-01T00:00:00+00:00" AND create_time < "2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND (space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF") ``` * query: 'placeholder-value', * // When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires either the `chat.admin.spaces.readonly` or `chat.admin.spaces` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). This method currently only supports admin access, thus only `true` is accepted for this field. * useAdminAccess: 'placeholder-value', @@ -5853,7 +5853,7 @@ export namespace chat_v1 { */ pageToken?: string; /** - * Required. A search query. You can search by using the following parameters: - `create_time` - `customer` - `display_name` - `external_user_allowed` - `last_active_time` - `space_history_state` - `space_type` `create_time` and `last_active_time` accept a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and the supported comparison operators are: `=`, `<`, `\>`, `<=`, `\>=`. `customer` is required and is used to indicate which customer to fetch spaces from. `customers/my_customer` is the only supported value. `display_name` only accepts the `HAS` (`:`) operator. The text to match is first tokenized into tokens and each token is prefix-matched case-insensitively and independently as a substring anywhere in the space's `display_name`. For example, `Fun Eve` matches `Fun event` or `The evening was fun`, but not `notFun event` or `even`. `external_user_allowed` accepts either `true` or `false`. `space_history_state` only accepts values from the [`historyState`] (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#Space.HistoryState) field of a `space` resource. `space_type` is required and the only valid value is `SPACE`. Across different fields, only `AND` operators are supported. A valid example is `space_type = "SPACE" AND display_name:"Hello"` and an invalid example is `space_type = "SPACE" OR display_name:"Hello"`. Among the same field, `space_type` doesn't support `AND` or `OR` operators. `display_name`, 'space_history_state', and 'external_user_allowed' only support `OR` operators. `last_active_time` and `create_time` support both `AND` and `OR` operators. `AND` can only be used to represent an interval, such as `last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time \> "2023-01-01T00:00:00+00:00"`. The following example queries are valid: ``` customer = "customers/my_customer" AND space_type = "SPACE" customer = "customers/my_customer" AND space_type = "SPACE" AND display_name:"Hello World" customer = "customers/my_customer" AND space_type = "SPACE" AND (last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time \> "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (display_name:"Hello World" OR display_name:"Fun event") AND (last_active_time \> "2020-01-01T00:00:00+00:00" AND last_active_time < "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (create_time \> "2019-01-01T00:00:00+00:00" AND create_time < "2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND (space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF") ``` + * Required. A search query. You can search by using the following parameters : - `create_time` - `customer` - `display_name` - `external_user_allowed` - `last_active_time` - `space_history_state` - `space_type` `create_time` and `last_active_time` accept a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and the supported comparison operators are: `=`, `<`, `\>`, `<=`, `\>=`. `customer` is required and is used to indicate which customer to fetch spaces from. `customers/my_customer` is the only supported value. `display_name` only accepts the `HAS` (`:`) operator. The text to match is first tokenized into tokens and each token is prefix-matched case-insensitively and independently as a substring anywhere in the space's `display_name`. For example, `Fun Eve` matches `Fun event` or `The evening was fun`, but not `notFun event` or `even`. `external_user_allowed` accepts either `true` or `false`. `space_history_state` only accepts values from the [`historyState`] (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#Space.HistoryState) field of a `space` resource. `space_type` is required and the only valid value is `SPACE`. Across different fields, only `AND` operators are supported. A valid example is `space_type = "SPACE" AND display_name:"Hello"` and an invalid example is `space_type = "SPACE" OR display_name:"Hello"`. Among the same field, `space_type` doesn't support `AND` or `OR` operators. `display_name`, 'space_history_state', and 'external_user_allowed' only support `OR` operators. `last_active_time` and `create_time` support both `AND` and `OR` operators. `AND` can only be used to represent an interval, such as `last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time \> "2023-01-01T00:00:00+00:00"`. The following example queries are valid: ``` customer = "customers/my_customer" AND space_type = "SPACE" customer = "customers/my_customer" AND space_type = "SPACE" AND display_name:"Hello World" customer = "customers/my_customer" AND space_type = "SPACE" AND (last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time \> "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (display_name:"Hello World" OR display_name:"Fun event") AND (last_active_time \> "2020-01-01T00:00:00+00:00" AND last_active_time < "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (create_time \> "2019-01-01T00:00:00+00:00" AND create_time < "2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND (space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF") ``` */ query?: string; /** diff --git a/src/apis/classroom/v1.ts b/src/apis/classroom/v1.ts index 555ead1bd31..158553baff6 100644 --- a/src/apis/classroom/v1.ts +++ b/src/apis/classroom/v1.ts @@ -187,6 +187,14 @@ export namespace classroom_v1 { * Payload for grade update requests. */ export interface Schema$AddOnAttachmentStudentSubmission { + /** + * Output only. Identifier of the course work submission under which this attachment submission was made. + */ + courseWorkSubmissionId?: string | null; + /** + * Output only. Classroom-assigned identifier for this student submission. This is unique among submissions for the relevant course work and add-on attachment combination. + */ + id?: string | null; /** * Student grade on this attachment. If unset, no grade was set. */ @@ -8214,6 +8222,8 @@ export namespace classroom_v1 { * * // Example response * // { + * // "courseWorkSubmissionId": "my_courseWorkSubmissionId", + * // "id": "my_id", * // "pointsEarned": {}, * // "postSubmissionState": "my_postSubmissionState", * // "userId": "my_userId" @@ -8376,6 +8386,8 @@ export namespace classroom_v1 { * requestBody: { * // request body parameters * // { + * // "courseWorkSubmissionId": "my_courseWorkSubmissionId", + * // "id": "my_id", * // "pointsEarned": {}, * // "postSubmissionState": "my_postSubmissionState", * // "userId": "my_userId" @@ -8387,6 +8399,8 @@ export namespace classroom_v1 { * * // Example response * // { + * // "courseWorkSubmissionId": "my_courseWorkSubmissionId", + * // "id": "my_id", * // "pointsEarned": {}, * // "postSubmissionState": "my_postSubmissionState", * // "userId": "my_userId" @@ -13847,6 +13861,8 @@ export namespace classroom_v1 { * * // Example response * // { + * // "courseWorkSubmissionId": "my_courseWorkSubmissionId", + * // "id": "my_id", * // "pointsEarned": {}, * // "postSubmissionState": "my_postSubmissionState", * // "userId": "my_userId" @@ -14008,6 +14024,8 @@ export namespace classroom_v1 { * requestBody: { * // request body parameters * // { + * // "courseWorkSubmissionId": "my_courseWorkSubmissionId", + * // "id": "my_id", * // "pointsEarned": {}, * // "postSubmissionState": "my_postSubmissionState", * // "userId": "my_userId" @@ -14018,6 +14036,8 @@ export namespace classroom_v1 { * * // Example response * // { + * // "courseWorkSubmissionId": "my_courseWorkSubmissionId", + * // "id": "my_id", * // "pointsEarned": {}, * // "postSubmissionState": "my_postSubmissionState", * // "userId": "my_userId" diff --git a/src/apis/cloudidentity/v1.ts b/src/apis/cloudidentity/v1.ts index 11cbbb780b9..34e5a74c556 100644 --- a/src/apis/cloudidentity/v1.ts +++ b/src/apis/cloudidentity/v1.ts @@ -11924,6 +11924,291 @@ export namespace cloudidentity_v1 { this.context = context; } + /** + * Create a policy. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudidentity.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudidentity = google.cloudidentity('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-identity.policies'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudidentity.policies.create({ + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "customer": "my_customer", + * // "name": "my_name", + * // "policyQuery": {}, + * // "setting": {}, + * // "type": "my_type" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Policies$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Policies$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Policies$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Policies$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Policies$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Policies$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Policies$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Policies$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudidentity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/policies').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Delete a policy. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudidentity.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudidentity = google.cloudidentity('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-identity.policies'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudidentity.policies.delete({ + * // Required. The name of the policy to delete. Format: `policies/{policy\}`. + * name: 'policies/my-policie', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Policies$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Policies$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Policies$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Policies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Policies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Policies$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Policies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Policies$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudidentity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/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); + } + } + /** * Get a policy. * @example @@ -12208,8 +12493,170 @@ export namespace cloudidentity_v1 { return createAPIRequest(parameters); } } + + /** + * Update a policy. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudidentity.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudidentity = google.cloudidentity('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-identity.policies'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudidentity.policies.patch({ + * // Output only. Identifier. The [resource name](https://cloud.google.com/apis/design/resource_names) of the Policy. Format: policies/{policy\}. + * name: 'policies/my-policie', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "customer": "my_customer", + * // "name": "my_name", + * // "policyQuery": {}, + * // "setting": {}, + * // "type": "my_type" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Policies$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Policies$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Policies$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Policies$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Policies$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Policies$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Policies$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Policies$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudidentity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } + export interface Params$Resource$Policies$Create extends StandardParameters { + /** + * Request body metadata + */ + requestBody?: Schema$Policy; + } + export interface Params$Resource$Policies$Delete extends StandardParameters { + /** + * Required. The name of the policy to delete. Format: `policies/{policy\}`. + */ + name?: string; + } export interface Params$Resource$Policies$Get extends StandardParameters { /** * Required. The name of the policy to retrieve. Format: `policies/{policy\}`. @@ -12230,4 +12677,15 @@ export namespace cloudidentity_v1 { */ pageToken?: string; } + export interface Params$Resource$Policies$Patch extends StandardParameters { + /** + * Output only. Identifier. The [resource name](https://cloud.google.com/apis/design/resource_names) of the Policy. Format: policies/{policy\}. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Policy; + } } diff --git a/src/apis/cloudnumberregistry/README.md b/src/apis/cloudnumberregistry/README.md new file mode 100644 index 00000000000..2659a2d9a9c --- /dev/null +++ b/src/apis/cloudnumberregistry/README.md @@ -0,0 +1,28 @@ +Google Inc. logo + +# cloudnumberregistry + +> + +## Installation + +```sh +$ npm install @googleapis/cloudnumberregistry +``` + +## Usage +All documentation and usage information can be found on [GitHub](https://github.com/googleapis/google-api-nodejs-client). +Information on classes can be found in [Googleapis Documentation](https://googleapis.dev/nodejs/googleapis/latest/cloudnumberregistry/classes/Cloudnumberregistry.html). + +## License +This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/googleapis/google-api-nodejs-client/blob/main/LICENSE). + +## Contributing +We love contributions! Before submitting a Pull Request, it's always good to start with a new issue first. To learn more, see [CONTRIBUTING](https://github.com/google/google-api-nodejs-client/blob/main/.github/CONTRIBUTING.md). + +## Questions/problems? +* Ask your development related questions on [StackOverflow](http://stackoverflow.com/questions/tagged/google-api-nodejs-client). +* If you've found an bug/issue, please [file it on GitHub](https://github.com/googleapis/google-api-nodejs-client/issues). + + +*Crafted with ❤️ by the Google Node.js team* diff --git a/src/apis/cloudnumberregistry/index.ts b/src/apis/cloudnumberregistry/index.ts new file mode 100644 index 00000000000..d91fd9ab05d --- /dev/null +++ b/src/apis/cloudnumberregistry/index.ts @@ -0,0 +1,49 @@ +// Copyright 2020 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/*! THIS FILE IS AUTO-GENERATED */ + +import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import {cloudnumberregistry_v1alpha} from './v1alpha'; + +export const VERSIONS = { + v1alpha: cloudnumberregistry_v1alpha.Cloudnumberregistry, +}; + +export function cloudnumberregistry( + version: 'v1alpha' +): cloudnumberregistry_v1alpha.Cloudnumberregistry; +export function cloudnumberregistry( + options: cloudnumberregistry_v1alpha.Options +): cloudnumberregistry_v1alpha.Cloudnumberregistry; +export function cloudnumberregistry< + T = cloudnumberregistry_v1alpha.Cloudnumberregistry, +>( + this: GoogleConfigurable, + versionOrOptions: 'v1alpha' | cloudnumberregistry_v1alpha.Options +) { + return getAPI('cloudnumberregistry', versionOrOptions, VERSIONS, this); +} + +const auth = new AuthPlus(); +export {auth}; +export {cloudnumberregistry_v1alpha}; +export { + AuthPlus, + GlobalOptions, + APIRequestContext, + GoogleConfigurable, + StreamMethodOptions, + MethodOptions, + BodyResponseCallback, +} from 'googleapis-common'; diff --git a/src/apis/cloudnumberregistry/package.json b/src/apis/cloudnumberregistry/package.json new file mode 100644 index 00000000000..ce470697fec --- /dev/null +++ b/src/apis/cloudnumberregistry/package.json @@ -0,0 +1,43 @@ +{ + "name": "@googleapis/cloudnumberregistry", + "version": "0.1.0", + "description": "cloudnumberregistry", + "main": "build/index.js", + "types": "build/index.d.ts", + "keywords": [ + "google" + ], + "author": "Google LLC", + "license": "Apache-2.0", + "homepage": "https://github.com/googleapis/google-api-nodejs-client", + "bugs": { + "url": "https://github.com/googleapis/google-api-nodejs-client/issues" + }, + "repository": { + "type": "git", + "url": "https://github.com/googleapis/google-api-nodejs-client.git" + }, + "engines": { + "node": ">=12.0.0" + }, + "scripts": { + "fix": "gts fix", + "lint": "gts check", + "compile": "tsc -p .", + "prepare": "npm run compile", + "webpack": "webpack" + }, + "dependencies": { + "googleapis-common": "^8.0.0" + }, + "devDependencies": { + "@microsoft/api-documenter": "^7.8.10", + "@microsoft/api-extractor": "^7.8.10", + "gts": "^6.0.0", + "null-loader": "^4.0.0", + "ts-loader": "^9.0.0", + "typescript": "5.7.3", + "webpack": "^5.0.0", + "webpack-cli": "^5.0.0" + } +} diff --git a/src/apis/cloudnumberregistry/tsconfig.json b/src/apis/cloudnumberregistry/tsconfig.json new file mode 100644 index 00000000000..e0810904968 --- /dev/null +++ b/src/apis/cloudnumberregistry/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "./node_modules/gts/tsconfig-google.json", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "*.ts", + ] +} diff --git a/src/apis/cloudnumberregistry/v1alpha.ts b/src/apis/cloudnumberregistry/v1alpha.ts new file mode 100644 index 00000000000..ad673790393 --- /dev/null +++ b/src/apis/cloudnumberregistry/v1alpha.ts @@ -0,0 +1,6880 @@ +// Copyright 2020 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/* eslint-disable @typescript-eslint/no-explicit-any */ +/* eslint-disable @typescript-eslint/no-unused-vars */ +/* eslint-disable @typescript-eslint/no-empty-interface */ +/* eslint-disable @typescript-eslint/no-namespace */ +/* eslint-disable no-irregular-whitespace */ + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, + BaseExternalAccountClient, + GaxiosResponseWithHTTP2, + GoogleConfigurable, + createAPIRequest, + MethodOptions, + StreamMethodOptions, + GlobalOptions, + GoogleAuth, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {Readable} from 'stream'; + +export namespace cloudnumberregistry_v1alpha { + export interface Options extends GlobalOptions { + version: 'v1alpha'; + } + + interface StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: + | string + | OAuth2Client + | JWT + | Compute + | UserRefreshClient + | BaseExternalAccountClient + | GoogleAuth; + + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * Cloud Number Registry API + * + * + * + * @example + * ```js + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * ``` + */ + export class Cloudnumberregistry { + context: APIRequestContext; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.projects = new Resource$Projects(this.context); + } + } + + /** + * Aggregated data for the RegistryBook. + */ + export interface Schema$AggregatedData { + /** + * Output only. Number of custom ranges in the RegistryBook. + */ + customRangesCount?: number | null; + /** + * Output only. Number of custom realms in the RegistryBook. + */ + customRealmsCount?: number | null; + /** + * Output only. Number of discovered ranges in the RegistryBook. + */ + discoveredRangesCount?: number | null; + /** + * Output only. Number of discovered realms in the RegistryBook. + */ + discoveredRealmsCount?: number | null; + /** + * Output only. Number of scopes unique to the RegistryBook. + */ + uniqueScopesCount?: number | null; + } + /** + * Message describing Attribute object + */ + export interface Schema$Attribute { + /** + * Required. Key of attribute + */ + key?: string | null; + /** + * Required. Value of attribute + */ + value?: string | null; + } + /** + * The request message for Operations.CancelOperation. + */ + export interface Schema$CancelOperationRequest {} + /** + * Message for response to checking the availability of IpamAdminScopes + */ + export interface Schema$CheckAvailabilityIpamAdminScopesResponse { + /** + * The details of the requested scopes. + */ + scopeAvailabilities?: Schema$IpamAdminScopeAvailability[]; + } + /** + * Message for cleaning up a IpamAdminScope + */ + export interface Schema$CleanupIpamAdminScopeRequest { + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string | null; + } + /** + * Message describing CustomRange object + */ + export interface Schema$CustomRange { + /** + * Optional. The attributes of the CustomRange. + */ + attributes?: Schema$Attribute[]; + /** + * Optional. Description of the CustomRange. + */ + description?: string | null; + /** + * Optional. The IPv4 CIDR range of the CustomRange. + */ + ipv4CidrRange?: string | null; + /** + * Optional. The IPv6 CIDR range of the CustomRange. + */ + ipv6CidrRange?: string | null; + /** + * Optional. Labels as key value pairs + */ + labels?: {[key: string]: string} | null; + /** + * Required. Identifier. name of resource + */ + name?: string | null; + /** + * Optional. The parent range of the CustomRange. Do not allow setting parent range if realm is specified. Format must follow this pattern: projects/{project\}/locations/{location\}/customRanges/{custom_range\} + */ + parentRange?: string | null; + /** + * Optional. The realm of the CustomRange. The realm must be in the same project as the custom range. Do not allow setting realm if parent range is specified, since the realm should be inherited from the parent range. Format must follow this pattern: projects/{project\}/locations/{location\}/realms/{realm\} + */ + realm?: string | null; + /** + * Output only. The registry book of the CustomRange. This field is inherited from the realm or parent range depending on which one is specified. + */ + registryBook?: string | null; + } + /** + * Message for disabling a IpamAdminScope + */ + export interface Schema$DisableIpamAdminScopeRequest { + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string | null; + } + /** + * Message describing DiscoveredRange object + */ + export interface Schema$DiscoveredRange { + /** + * Optional. The attributes of the DiscoveredRange. + */ + attributes?: Schema$Attribute[]; + /** + * Output only. If true, allow child ranges of this range to overlap with each other. + */ + childCidrOverlapAllowed?: boolean | null; + /** + * Output only. [Output only] Create time stamp + */ + createTime?: string | null; + /** + * Optional. Description of the DiscoveredRange. + */ + description?: string | null; + /** + * Output only. Owner metadata for this DiscoveredRange. A unique set of metadata is associated with each DiscoveredRange. If an IP range is shared by multiple resources (e.g., an Address resource and an Instance resource, or multiple ForwardingRules),separate DiscoveredRanges are created, each with a distinct owner. This ensures each DiscoveredRange has its own unique set of attributes, labels, create time and update time. + */ + discoveryMetadata?: Schema$DiscoveryMetadata; + /** + * Optional. The IPv4 CIDR range of the DiscoveredRange. + */ + ipv4CidrRange?: string | null; + /** + * Optional. The IPv6 CIDR range of the DiscoveredRange. + */ + ipv6CidrRange?: string | null; + /** + * Optional. Labels as key value pairs + */ + labels?: {[key: string]: string} | null; + /** + * Required. Identifier. Name of the DiscoveredRange. + */ + name?: string | null; + /** + * Optional. The parent range of the DiscoveredRange. + */ + parentRange?: string | null; + /** + * Optional. The realm of the DiscoveredRange. + */ + realm?: string | null; + /** + * Output only. The registry book of the DiscoveredRange. + */ + registryBook?: string | null; + /** + * Output only. [Output only] Update time stamp + */ + updateTime?: string | null; + } + /** + * Discovery metadata of the discovered resource. + */ + export interface Schema$DiscoveryMetadata { + /** + * Output only. The time when the resource was created. + */ + createTime?: string | null; + /** + * Output only. The time when the event happened. + */ + eventTime?: string | null; + /** + * Output only. The resource name of the discovered resource, should be API-agnostic. Example: "projects/{project_number\}/networks/{network_id\}". + */ + resource?: string | null; + /** + * Output only. The resource uri of the discovered resource. + */ + resourceUri?: string | null; + /** + * Output only. The canonical google.aip.dev/122 name of the source resource. + */ + sourceId?: string | null; + /** + * Output only. A single source resource can be the source of multiple CNR resources. This sub_id is used to distinguish between the different CNR resources derived from the same upstream resource. For example, a single subnetwork can be the source of multiple ranges, one for each protocol. In this case, the sub_id could be "private-ipv4" or "private-ipv6". + */ + sourceSubId?: string | null; + /** + * Output only. The state of the resource. + */ + state?: string | null; + /** + * Output only. The time when the resource was last modified. + */ + updateTime?: string | null; + } + /** + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} + */ + export interface Schema$Empty {} + /** + * Message for the response to finding free IP ranges. + */ + export interface Schema$FindCustomRangeFreeIpRangesResponse { + /** + * Output only. Free IP CIDR ranges found in the CustomRange. + */ + freeIpCidrRanges?: string[] | null; + } + /** + * Message for the response to finding free IP ranges. + */ + export interface Schema$FindDiscoveredRangeFreeIpRangesResponse { + /** + * Output only. Free IP CIDR ranges found in the DiscoveredRange. + */ + freeIpCidrRanges?: string[] | null; + } + /** + * Message describing IpamAdminScope object + */ + export interface Schema$IpamAdminScope { + /** + * Output only. [Output only] Create time stamp + */ + createTime?: string | null; + /** + * Required. Addon platforms that are enabled for this IPAM admin scope. Cloud Number Registry only discovers the IP addresses from the enabled platforms. + */ + enabledAddonPlatforms?: string[] | null; + /** + * Optional. Labels as key value pairs + */ + labels?: {[key: string]: string} | null; + /** + * Required. Identifier. name of resource + */ + name?: string | null; + /** + * Required. Administrative scopes enabled for IP address discovery and management. For example, "organizations/1234567890". Minimum of 1 scope is required. In preview, only one organization scope is allowed. + */ + scopes?: string[] | null; + /** + * Output only. State of resource discovery pipeline. + */ + state?: string | null; + /** + * Output only. [Output only] Update time stamp + */ + updateTime?: string | null; + } + /** + * Message for the availability of an IpamAdminScope + */ + export interface Schema$IpamAdminScopeAvailability { + /** + * The admin project of the IpamAdminScope if it exists. + */ + adminProject?: string | null; + /** + * The availability of the scope. + */ + availability?: string | null; + /** + * The scope of the IpamAdminScope. + */ + scope?: string | null; + } + /** + * Message for response to listing CustomRanges + */ + export interface Schema$ListCustomRangesResponse { + /** + * The list of CustomRange + */ + customRanges?: Schema$CustomRange[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Message for response to listing DiscoveredRanges + */ + export interface Schema$ListDiscoveredRangesResponse { + /** + * The list of DiscoveredRange + */ + discoveredRanges?: Schema$DiscoveredRange[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Message for response to listing ipamAdminScopes + */ + export interface Schema$ListIpamAdminScopesResponse { + /** + * The list of IpamAdminScope + */ + ipamAdminScopes?: Schema$IpamAdminScope[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * The response message for Locations.ListLocations. + */ + export interface Schema$ListLocationsResponse { + /** + * A list of locations that matches the specified filter in the request. + */ + locations?: Schema$Location[]; + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + } + /** + * The response message for Operations.ListOperations. + */ + export interface Schema$ListOperationsResponse { + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + /** + * A list of operations that matches the specified filter in the request. + */ + operations?: Schema$Operation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; + } + /** + * Message for response to listing Realms + */ + export interface Schema$ListRealmsResponse { + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * The list of Realm + */ + realms?: Schema$Realm[]; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Message for response to listing RegistryBooks + */ + export interface Schema$ListRegistryBooksResponse { + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * The list of RegistryBook + */ + registryBooks?: Schema$RegistryBook[]; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * A resource that represents a Google Cloud location. + */ + export interface Schema$Location { + /** + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". + */ + displayName?: string | null; + /** + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\} + */ + labels?: {[key: string]: string} | null; + /** + * The canonical id for this location. For example: `"us-east1"`. + */ + locationId?: string | null; + /** + * Service-specific metadata. For example the available capacity at the given location. + */ + metadata?: {[key: string]: any} | null; + /** + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` + */ + name?: string | null; + } + /** + * This resource represents a long-running operation that is the result of a network API call. + */ + export interface Schema$Operation { + /** + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. + */ + done?: boolean | null; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$Status; + /** + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + */ + metadata?: {[key: string]: any} | null; + /** + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id\}`. + */ + name?: string | null; + /** + * The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + */ + response?: {[key: string]: any} | null; + } + /** + * Represents the metadata of the long-running operation. + */ + export interface Schema$OperationMetadata { + /** + * Output only. API version used to start the operation. + */ + apiVersion?: string | null; + /** + * Output only. The time the operation was created. + */ + createTime?: string | null; + /** + * Output only. The time the operation finished running. + */ + endTime?: string | null; + /** + * Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + */ + requestedCancellation?: boolean | null; + /** + * Output only. Human-readable status of the operation, if any. + */ + statusMessage?: string | null; + /** + * Output only. Server-defined resource path for the target of the operation. + */ + target?: string | null; + /** + * Output only. Name of the verb executed by the operation. + */ + verb?: string | null; + } + /** + * Message describing either a CustomRange or a DiscoveredRange. + */ + export interface Schema$Range { + /** + * A custom range. + */ + customRange?: Schema$CustomRange; + /** + * A discovered range. + */ + discoveredRange?: Schema$DiscoveredRange; + /** + * The utilization of the range. + */ + utilization?: Schema$RangeUtilization; + } + /** + * Message for the utilization of an IP range + */ + export interface Schema$RangeUtilization { + /** + * Output only. The total number of IP addresses consumed in the range. + */ + totalConsumed?: string | null; + /** + * Output only. The total number of IP addresses produced in the range. + */ + totalProduced?: string | null; + /** + * Output only. The usage of the range as a percentage. This is marked as optional so that we have presence tracking and API responses show 0.0 instead of NULL. + */ + usage?: number | null; + } + /** + * Message describing Realm object + */ + export interface Schema$Realm { + /** + * Output only. Aggregated data for the Realm. Populated only when the view is AGGREGATE. + */ + aggregatedData?: Schema$RealmAggregatedData; + /** + * Output only. [Output only] Create time stamp + */ + createTime?: string | null; + /** + * Output only. Discovery metadata of the realm. + */ + discoveryMetadata?: Schema$DiscoveryMetadata; + /** + * Optional. IP version of the realm. + */ + ipVersion?: string | null; + /** + * Optional. Labels as key value pairs + */ + labels?: {[key: string]: string} | null; + /** + * Required. Management type of realm. + */ + managementType?: string | null; + /** + * Required. Identifier. Unique name/ID of the realm + */ + name?: string | null; + /** + * Required. URI of the registry book that claims the realm. + */ + registryBook?: string | null; + /** + * Required. Traffic type of realm. + */ + trafficType?: string | null; + /** + * Output only. [Output only] Update time stamp + */ + updateTime?: string | null; + } + /** + * Aggregated data for the Realm. + */ + export interface Schema$RealmAggregatedData { + /** + * Output only. Number of custom ranges in the Realm. + */ + customRangesCount?: number | null; + /** + * Output only. Number of discovered ranges in the Realm. + */ + discoveredRangesCount?: number | null; + } + /** + * Message describing RegistryBook object + */ + export interface Schema$RegistryBook { + /** + * Output only. Aggregated data for the RegistryBook. Populated only when the view is AGGREGATE. + */ + aggregatedData?: Schema$AggregatedData; + /** + * Optional. List of scopes claimed by the RegistryBook. In Preview, Only project scope is supported. Each scope is in the format of projects/{project\}. Each scope can only be claimed once. + */ + claimedScopes?: string[] | null; + /** + * Output only. [Output only] Create time stamp + */ + createTime?: string | null; + /** + * Output only. Whether the RegistryBook is the default one. + */ + isDefault?: boolean | null; + /** + * Optional. Labels as key value pairs + */ + labels?: {[key: string]: string} | null; + /** + * Required. Identifier. name of resource + */ + name?: string | null; + /** + * Output only. [Output only] Update time stamp + */ + updateTime?: string | null; + } + /** + * Message for searching IP resources + */ + export interface Schema$SearchIpResourcesRequest { + /** + * Optional. Hint for how to order the results + */ + orderBy?: string | null; + /** + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + */ + pageSize?: number | null; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string | null; + /** + * Optional. Search query. This string filters resources in an AIP-160-like format. It has some limitations. You can only specify top level conjunctions or attribute level negations. Each restriction can only be used once except the attribute restriction. The available restrictions for ranges are: - `realm`: The realm name to search in. - `ip_address`: The IP address to search for within ranges. - `ip_version`: The IP version to filter by (e.g., "IPV4", "IPV6"). - `parent_range`: The parent range of the range to search for. - `attribute_text`: The attribute text to search for within ranges. - `attribute`: The attribute key and value to filter by. The available restrictions for realms are: - `ip_version`: The IP version to search for. Only one of attribute_text or multiple attribute filters can be specified. Examples: - `realm=test-realm` - `realm=test-realm AND ip_address=10.0.0.0` - `realm=test-realm AND ip_version=IPV6` - `realm=test-realm AND attribute_text=test` - `ip_address=10.0.0.0 AND attribute:(key1=value1) AND attribute:(key2=value2)` - `attribute_text=test AND parent_range=projects/123/locations/global/discoveredRanges/test-parent-range` + */ + query?: string | null; + /** + * Optional. The type of resources to search for. If not specified, the server will return ranges. + */ + searchResourceTypes?: string[] | null; + /** + * Optional. Whether to show the utilization of the ranges in the response. + */ + showUtilization?: boolean | null; + } + /** + * Message for response to searching IP resources + */ + export interface Schema$SearchIpResourcesResponse { + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Deprecated: Use results field instead. The list of ranges matching the search query. + */ + ranges?: Schema$Range[]; + /** + * The list of results matching the search query. + */ + results?: Schema$SearchIpResourcesResult[]; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * A result matching the search query, which can be either a range or a realm. + */ + export interface Schema$SearchIpResourcesResult { + /** + * A range matching the search query. + */ + range?: Schema$Range; + /** + * A realm matching the search query. + */ + realm?: Schema$Realm; + } + /** + * Message for the response to getting the utilization of a CustomRange + */ + export interface Schema$ShowCustomRangeUtilizationResponse { + /** + * The CustomRange resource. + */ + customRange?: Schema$CustomRange; + /** + * The utilization of the CustomRange. + */ + rangeUtilization?: Schema$RangeUtilization; + } + /** + * Message for the response to getting the utilization of a DiscoveredRange + */ + export interface Schema$ShowDiscoveredRangeUtilizationResponse { + /** + * The DiscoveredRange resource. + */ + discoveredRange?: Schema$DiscoveredRange; + /** + * The utilization of the DiscoveredRange. + */ + rangeUtilization?: Schema$RangeUtilization; + } + /** + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + */ + export interface Schema$Status { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number | null; + /** + * A list of messages that carry the error details. There is a common set of message types for APIs to use. + */ + details?: Array<{[key: string]: any}> | null; + /** + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + */ + message?: string | null; + } + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + } + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + customRanges: Resource$Projects$Locations$Customranges; + discoveredRanges: Resource$Projects$Locations$Discoveredranges; + ipamAdminScopes: Resource$Projects$Locations$Ipamadminscopes; + operations: Resource$Projects$Locations$Operations; + realms: Resource$Projects$Locations$Realms; + registryBooks: Resource$Projects$Locations$Registrybooks; + constructor(context: APIRequestContext) { + this.context = context; + this.customRanges = new Resource$Projects$Locations$Customranges( + this.context + ); + this.discoveredRanges = new Resource$Projects$Locations$Discoveredranges( + this.context + ); + this.ipamAdminScopes = new Resource$Projects$Locations$Ipamadminscopes( + this.context + ); + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + this.realms = new Resource$Projects$Locations$Realms(this.context); + this.registryBooks = new Resource$Projects$Locations$Registrybooks( + this.context + ); + } + + /** + * Gets information about a location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.get({ + * // Resource name for the location. + * name: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "displayName": "my_displayName", + * // "labels": {}, + * // "locationId": "my_locationId", + * // "metadata": {}, + * // "name": "my_name" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.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 information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.list({ + * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. + * extraLocationTypes: 'placeholder-value', + * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). + * filter: 'placeholder-value', + * // The resource that owns the locations collection, if applicable. + * name: 'projects/my-project', + * // The maximum number of results to return. If not set, the service selects a default. + * pageSize: 'placeholder-value', + * // A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + * pageToken: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "locations": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}/locations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Get extends StandardParameters { + /** + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. + */ + extraLocationTypes?: string[]; + /** + * A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Customranges { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new CustomRange in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.customRanges.create({ + * // Required. Id of the requesting object. + * customRangeId: 'placeholder-value', + * // Required. Value for parent. + * parent: 'projects/my-project/locations/my-location', + * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "attributes": [], + * // "description": "my_description", + * // "ipv4CidrRange": "my_ipv4CidrRange", + * // "ipv6CidrRange": "my_ipv6CidrRange", + * // "labels": {}, + * // "name": "my_name", + * // "parentRange": "my_parentRange", + * // "realm": "my_realm", + * // "registryBook": "my_registryBook" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Customranges$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Customranges$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Customranges$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Customranges$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Customranges$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Customranges$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Customranges$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Customranges$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/customRanges').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single CustomRange. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.customRanges.delete({ + * // Optional. If set to true, all associated resources will be deleted. + * force: 'placeholder-value', + * // Required. Name of the resource + * name: 'projects/my-project/locations/my-location/customRanges/my-customRange', + * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Customranges$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Customranges$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Customranges$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Customranges$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Customranges$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Customranges$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Customranges$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Customranges$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Finds free IP ranges in a single CustomRange. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await cloudnumberregistry.projects.locations.customRanges.findFreeIpRanges({ + * // Required. The prefix length of the free IP ranges to find. + * cidrPrefixLength: 'placeholder-value', + * // Required. Name of the CustomRange. + * name: 'projects/my-project/locations/my-location/customRanges/my-customRange', + * // Optional. The number of free IP ranges to find. + * rangeCount: 'placeholder-value', + * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "freeIpCidrRanges": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + findFreeIpRanges( + params: Params$Resource$Projects$Locations$Customranges$Findfreeipranges, + options: StreamMethodOptions + ): Promise>; + findFreeIpRanges( + params?: Params$Resource$Projects$Locations$Customranges$Findfreeipranges, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + findFreeIpRanges( + params: Params$Resource$Projects$Locations$Customranges$Findfreeipranges, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + findFreeIpRanges( + params: Params$Resource$Projects$Locations$Customranges$Findfreeipranges, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + findFreeIpRanges( + params: Params$Resource$Projects$Locations$Customranges$Findfreeipranges, + callback: BodyResponseCallback + ): void; + findFreeIpRanges( + callback: BodyResponseCallback + ): void; + findFreeIpRanges( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Customranges$Findfreeipranges + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Customranges$Findfreeipranges; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Customranges$Findfreeipranges; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:findFreeIpRanges').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 details of a single CustomRange. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.customRanges.get({ + * // Required. Name of the resource + * name: 'projects/my-project/locations/my-location/customRanges/my-customRange', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "attributes": [], + * // "description": "my_description", + * // "ipv4CidrRange": "my_ipv4CidrRange", + * // "ipv6CidrRange": "my_ipv6CidrRange", + * // "labels": {}, + * // "name": "my_name", + * // "parentRange": "my_parentRange", + * // "realm": "my_realm", + * // "registryBook": "my_registryBook" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Customranges$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Customranges$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Customranges$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Customranges$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Customranges$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Customranges$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Customranges$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Customranges$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.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 CustomRanges in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.customRanges.list({ + * // Optional. Filtering results. + * filter: 'placeholder-value', + * // Optional. Hint for how to order the results. + * orderBy: 'placeholder-value', + * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. Parent value for ListCustomRangesRequest + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "customRanges": [], + * // "nextPageToken": "my_nextPageToken", + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Customranges$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Customranges$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Customranges$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Customranges$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Customranges$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Customranges$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Customranges$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Customranges$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/customRanges').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the parameters of a single CustomRange. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.customRanges.patch({ + * // Required. Identifier. name of resource + * name: 'projects/my-project/locations/my-location/customRanges/my-customRange', + * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Optional. Field mask is used to specify the fields to be overwritten in the CustomRange resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "attributes": [], + * // "description": "my_description", + * // "ipv4CidrRange": "my_ipv4CidrRange", + * // "ipv6CidrRange": "my_ipv6CidrRange", + * // "labels": {}, + * // "name": "my_name", + * // "parentRange": "my_parentRange", + * // "realm": "my_realm", + * // "registryBook": "my_registryBook" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Customranges$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Customranges$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Customranges$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Customranges$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Customranges$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Customranges$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Customranges$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Customranges$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.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); + } + } + + /** + * Gets the details of a single CustomRange and its utilization. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await cloudnumberregistry.projects.locations.customRanges.showUtilization({ + * // Required. Name of the resource + * name: 'projects/my-project/locations/my-location/customRanges/my-customRange', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "customRange": {}, + * // "rangeUtilization": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + showUtilization( + params: Params$Resource$Projects$Locations$Customranges$Showutilization, + options: StreamMethodOptions + ): Promise>; + showUtilization( + params?: Params$Resource$Projects$Locations$Customranges$Showutilization, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + showUtilization( + params: Params$Resource$Projects$Locations$Customranges$Showutilization, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + showUtilization( + params: Params$Resource$Projects$Locations$Customranges$Showutilization, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + showUtilization( + params: Params$Resource$Projects$Locations$Customranges$Showutilization, + callback: BodyResponseCallback + ): void; + showUtilization( + callback: BodyResponseCallback + ): void; + showUtilization( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Customranges$Showutilization + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Customranges$Showutilization; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Customranges$Showutilization; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:showUtilization').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Customranges$Create extends StandardParameters { + /** + * Required. Id of the requesting object. + */ + customRangeId?: string; + /** + * Required. Value for parent. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CustomRange; + } + export interface Params$Resource$Projects$Locations$Customranges$Delete extends StandardParameters { + /** + * Optional. If set to true, all associated resources will be deleted. + */ + force?: boolean; + /** + * Required. Name of the resource + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Customranges$Findfreeipranges extends StandardParameters { + /** + * Required. The prefix length of the free IP ranges to find. + */ + cidrPrefixLength?: number; + /** + * Required. Name of the CustomRange. + */ + name?: string; + /** + * Optional. The number of free IP ranges to find. + */ + rangeCount?: number; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Customranges$Get extends StandardParameters { + /** + * Required. Name of the resource + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Customranges$List extends StandardParameters { + /** + * Optional. Filtering results. + */ + filter?: string; + /** + * Optional. Hint for how to order the results. + */ + orderBy?: string; + /** + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. Parent value for ListCustomRangesRequest + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Customranges$Patch extends StandardParameters { + /** + * Required. Identifier. name of resource + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the CustomRange resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CustomRange; + } + export interface Params$Resource$Projects$Locations$Customranges$Showutilization extends StandardParameters { + /** + * Required. Name of the resource + */ + name?: string; + } + + export class Resource$Projects$Locations$Discoveredranges { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Finds free IP ranges in a single DiscoveredRange. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await cloudnumberregistry.projects.locations.discoveredRanges.findFreeIpRanges( + * { + * // Required. The prefix length of the free IP ranges to find. + * cidrPrefixLength: 'placeholder-value', + * // Required. Name of the DiscoveredRange. + * name: 'projects/my-project/locations/my-location/discoveredRanges/my-discoveredRange', + * // Optional. The number of free IP ranges to find. + * rangeCount: 'placeholder-value', + * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "freeIpCidrRanges": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + findFreeIpRanges( + params: Params$Resource$Projects$Locations$Discoveredranges$Findfreeipranges, + options: StreamMethodOptions + ): Promise>; + findFreeIpRanges( + params?: Params$Resource$Projects$Locations$Discoveredranges$Findfreeipranges, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + findFreeIpRanges( + params: Params$Resource$Projects$Locations$Discoveredranges$Findfreeipranges, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + findFreeIpRanges( + params: Params$Resource$Projects$Locations$Discoveredranges$Findfreeipranges, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + findFreeIpRanges( + params: Params$Resource$Projects$Locations$Discoveredranges$Findfreeipranges, + callback: BodyResponseCallback + ): void; + findFreeIpRanges( + callback: BodyResponseCallback + ): void; + findFreeIpRanges( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Discoveredranges$Findfreeipranges + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Discoveredranges$Findfreeipranges; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Discoveredranges$Findfreeipranges; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:findFreeIpRanges').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 details of a single DiscoveredRange. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.discoveredRanges.get( + * { + * // Required. Name of the resource + * name: 'projects/my-project/locations/my-location/discoveredRanges/my-discoveredRange', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "attributes": [], + * // "childCidrOverlapAllowed": false, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "discoveryMetadata": {}, + * // "ipv4CidrRange": "my_ipv4CidrRange", + * // "ipv6CidrRange": "my_ipv6CidrRange", + * // "labels": {}, + * // "name": "my_name", + * // "parentRange": "my_parentRange", + * // "realm": "my_realm", + * // "registryBook": "my_registryBook", + * // "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$Discoveredranges$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Discoveredranges$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Discoveredranges$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Discoveredranges$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Discoveredranges$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Discoveredranges$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Discoveredranges$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Discoveredranges$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.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 DiscoveredRanges in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await cloudnumberregistry.projects.locations.discoveredRanges.list({ + * // Optional. Filtering results. + * filter: 'placeholder-value', + * // Optional. Hint for how to order the results. + * orderBy: 'placeholder-value', + * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. Parent value for ListDiscoveredRangesRequest + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "discoveredRanges": [], + * // "nextPageToken": "my_nextPageToken", + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Discoveredranges$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Discoveredranges$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Discoveredranges$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Discoveredranges$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Discoveredranges$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Discoveredranges$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Discoveredranges$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Discoveredranges$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/discoveredRanges').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets the details of a single DiscoveredRange and its utilization. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await cloudnumberregistry.projects.locations.discoveredRanges.showUtilization( + * { + * // Required. Name of the resource + * name: 'projects/my-project/locations/my-location/discoveredRanges/my-discoveredRange', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "discoveredRange": {}, + * // "rangeUtilization": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + showUtilization( + params: Params$Resource$Projects$Locations$Discoveredranges$Showutilization, + options: StreamMethodOptions + ): Promise>; + showUtilization( + params?: Params$Resource$Projects$Locations$Discoveredranges$Showutilization, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + showUtilization( + params: Params$Resource$Projects$Locations$Discoveredranges$Showutilization, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + showUtilization( + params: Params$Resource$Projects$Locations$Discoveredranges$Showutilization, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + showUtilization( + params: Params$Resource$Projects$Locations$Discoveredranges$Showutilization, + callback: BodyResponseCallback + ): void; + showUtilization( + callback: BodyResponseCallback + ): void; + showUtilization( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Discoveredranges$Showutilization + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Discoveredranges$Showutilization; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Discoveredranges$Showutilization; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:showUtilization').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Discoveredranges$Findfreeipranges extends StandardParameters { + /** + * Required. The prefix length of the free IP ranges to find. + */ + cidrPrefixLength?: number; + /** + * Required. Name of the DiscoveredRange. + */ + name?: string; + /** + * Optional. The number of free IP ranges to find. + */ + rangeCount?: number; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Discoveredranges$Get extends StandardParameters { + /** + * Required. Name of the resource + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Discoveredranges$List extends StandardParameters { + /** + * Optional. Filtering results. + */ + filter?: string; + /** + * Optional. Hint for how to order the results. + */ + orderBy?: string; + /** + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. Parent value for ListDiscoveredRangesRequest + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Discoveredranges$Showutilization extends StandardParameters { + /** + * Required. Name of the resource + */ + name?: string; + } + + export class Resource$Projects$Locations$Ipamadminscopes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Checks the availability of IPAM admin scopes in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await cloudnumberregistry.projects.locations.ipamAdminScopes.checkAvailability( + * { + * // Required. Parent value for the IpamAdminScopes. + * parent: 'projects/my-project/locations/my-location', + * // Required. The scopes of the IpamAdminScopes to look for. + * scopes: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "scopeAvailabilities": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + checkAvailability( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Checkavailability, + options: StreamMethodOptions + ): Promise>; + checkAvailability( + params?: Params$Resource$Projects$Locations$Ipamadminscopes$Checkavailability, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + checkAvailability( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Checkavailability, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + checkAvailability( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Checkavailability, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + checkAvailability( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Checkavailability, + callback: BodyResponseCallback + ): void; + checkAvailability( + callback: BodyResponseCallback + ): void; + checkAvailability( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ipamadminscopes$Checkavailability + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ipamadminscopes$Checkavailability; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Ipamadminscopes$Checkavailability; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1alpha/{+parent}/ipamAdminScopes:checkAvailability' + ).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 + ); + } + } + + /** + * Cleans up a single IpamAdminScope. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await cloudnumberregistry.projects.locations.ipamAdminScopes.cleanup({ + * // Required. Name of the resource + * name: 'projects/my-project/locations/my-location/ipamAdminScopes/my-ipamAdminScope', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "requestId": "my_requestId" + * // } + * }, + * }); + * 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. + */ + cleanup( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Cleanup, + options: StreamMethodOptions + ): Promise>; + cleanup( + params?: Params$Resource$Projects$Locations$Ipamadminscopes$Cleanup, + options?: MethodOptions + ): Promise>; + cleanup( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Cleanup, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cleanup( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Cleanup, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cleanup( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Cleanup, + callback: BodyResponseCallback + ): void; + cleanup(callback: BodyResponseCallback): void; + cleanup( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ipamadminscopes$Cleanup + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ipamadminscopes$Cleanup; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Ipamadminscopes$Cleanup; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:cleanup').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 IpamAdminScope in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await cloudnumberregistry.projects.locations.ipamAdminScopes.create({ + * // Required. Id of the requesting object. + * ipamAdminScopeId: 'placeholder-value', + * // Required. Value for parent. + * parent: 'projects/my-project/locations/my-location', + * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "enabledAddonPlatforms": [], + * // "labels": {}, + * // "name": "my_name", + * // "scopes": [], + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Ipamadminscopes$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ipamadminscopes$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ipamadminscopes$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Ipamadminscopes$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/ipamAdminScopes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single IpamAdminScope. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await cloudnumberregistry.projects.locations.ipamAdminScopes.delete({ + * // Optional. If set to true, all associated resources will be deleted. + * force: 'placeholder-value', + * // Required. Name of the resource + * name: 'projects/my-project/locations/my-location/ipamAdminScopes/my-ipamAdminScope', + * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Ipamadminscopes$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ipamadminscopes$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ipamadminscopes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Ipamadminscopes$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Disables a single IpamAdminScope. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await cloudnumberregistry.projects.locations.ipamAdminScopes.disable({ + * // Required. Name of the resource + * name: 'projects/my-project/locations/my-location/ipamAdminScopes/my-ipamAdminScope', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "requestId": "my_requestId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + disable( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Disable, + options: StreamMethodOptions + ): Promise>; + disable( + params?: Params$Resource$Projects$Locations$Ipamadminscopes$Disable, + options?: MethodOptions + ): Promise>; + disable( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Disable, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + disable( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Disable, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + disable( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Disable, + callback: BodyResponseCallback + ): void; + disable(callback: BodyResponseCallback): void; + disable( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ipamadminscopes$Disable + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ipamadminscopes$Disable; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Ipamadminscopes$Disable; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:disable').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single IpamAdminScope. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.ipamAdminScopes.get({ + * // Required. Name of the resource + * name: 'projects/my-project/locations/my-location/ipamAdminScopes/my-ipamAdminScope', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "enabledAddonPlatforms": [], + * // "labels": {}, + * // "name": "my_name", + * // "scopes": [], + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Ipamadminscopes$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ipamadminscopes$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ipamadminscopes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Ipamadminscopes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.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); + } + } + + /** + * List all IPAM admin scopes in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.ipamAdminScopes.list( + * { + * // Optional. Filtering results + * filter: 'placeholder-value', + * // Optional. Hint for how to order the results + * orderBy: 'placeholder-value', + * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. Parent value for ListIpamAdminScopesRequest + * parent: 'projects/my-project/locations/my-location', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "ipamAdminScopes": [], + * // "nextPageToken": "my_nextPageToken", + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Ipamadminscopes$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Ipamadminscopes$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Ipamadminscopes$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Ipamadminscopes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Ipamadminscopes$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ipamadminscopes$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ipamadminscopes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Ipamadminscopes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/ipamAdminScopes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the parameters of a single IpamAdminScope. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await cloudnumberregistry.projects.locations.ipamAdminScopes.patch({ + * // Required. Identifier. name of resource + * name: 'projects/my-project/locations/my-location/ipamAdminScopes/my-ipamAdminScope', + * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Optional. Field mask is used to specify the fields to be overwritten in the IpamAdminScope resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "enabledAddonPlatforms": [], + * // "labels": {}, + * // "name": "my_name", + * // "scopes": [], + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Ipamadminscopes$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Ipamadminscopes$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ipamadminscopes$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ipamadminscopes$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Ipamadminscopes$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Ipamadminscopes$Checkavailability extends StandardParameters { + /** + * Required. Parent value for the IpamAdminScopes. + */ + parent?: string; + /** + * Required. The scopes of the IpamAdminScopes to look for. + */ + scopes?: string[]; + } + export interface Params$Resource$Projects$Locations$Ipamadminscopes$Cleanup extends StandardParameters { + /** + * Required. Name of the resource + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CleanupIpamAdminScopeRequest; + } + export interface Params$Resource$Projects$Locations$Ipamadminscopes$Create extends StandardParameters { + /** + * Required. Id of the requesting object. + */ + ipamAdminScopeId?: string; + /** + * Required. Value for parent. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$IpamAdminScope; + } + export interface Params$Resource$Projects$Locations$Ipamadminscopes$Delete extends StandardParameters { + /** + * Optional. If set to true, all associated resources will be deleted. + */ + force?: boolean; + /** + * Required. Name of the resource + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Ipamadminscopes$Disable extends StandardParameters { + /** + * Required. Name of the resource + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DisableIpamAdminScopeRequest; + } + export interface Params$Resource$Projects$Locations$Ipamadminscopes$Get extends StandardParameters { + /** + * Required. Name of the resource + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Ipamadminscopes$List extends StandardParameters { + /** + * Optional. Filtering results + */ + filter?: string; + /** + * Optional. Hint for how to order the results + */ + orderBy?: string; + /** + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. Parent value for ListIpamAdminScopesRequest + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Ipamadminscopes$Patch extends StandardParameters { + /** + * Required. Identifier. name of resource + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the IpamAdminScope resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$IpamAdminScope; + } + + export class Resource$Projects$Locations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/operations/my-operation', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Operations$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+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/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest 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/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Operations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. 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$Operations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Operations$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Operations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Operations$Cancel extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelOperationRequest; + } + export interface Params$Resource$Projects$Locations$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$List extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. 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$Projects$Locations$Realms { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new Realm in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.realms.create({ + * // Required. Value for parent. + * parent: 'projects/my-project/locations/my-location', + * // Required. Id of the requesting object. + * realmId: 'placeholder-value', + * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "aggregatedData": {}, + * // "createTime": "my_createTime", + * // "discoveryMetadata": {}, + * // "ipVersion": "my_ipVersion", + * // "labels": {}, + * // "managementType": "my_managementType", + * // "name": "my_name", + * // "registryBook": "my_registryBook", + * // "trafficType": "my_trafficType", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Realms$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Realms$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Realms$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Realms$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Realms$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Realms$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Realms$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Realms$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/realms').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single Realm. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.realms.delete({ + * // Optional. If set to true, all associated resources will be deleted. + * force: 'placeholder-value', + * // Required. Name of the resource + * name: 'projects/my-project/locations/my-location/realms/my-realm', + * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. + * requestId: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Realms$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Realms$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Realms$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Realms$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Realms$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Realms$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Realms$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Realms$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single Realm. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.realms.get({ + * // Required. Name of the resource + * name: 'projects/my-project/locations/my-location/realms/my-realm', + * // Optional. The view of the Realm. + * view: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "aggregatedData": {}, + * // "createTime": "my_createTime", + * // "discoveryMetadata": {}, + * // "ipVersion": "my_ipVersion", + * // "labels": {}, + * // "managementType": "my_managementType", + * // "name": "my_name", + * // "registryBook": "my_registryBook", + * // "trafficType": "my_trafficType", + * // "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$Realms$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Realms$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Realms$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Realms$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Realms$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Realms$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Realms$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Realms$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.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 Realms in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.realms.list({ + * // Optional. Filtering results + * filter: 'placeholder-value', + * // Optional. Hint for how to order the results + * orderBy: 'placeholder-value', + * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. Parent value for ListRealmsRequest + * parent: 'projects/my-project/locations/my-location', + * // Optional. The view of the Realm. + * view: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "realms": [], + * // "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$Realms$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Realms$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Realms$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Realms$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Realms$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Realms$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Realms$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Realms$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/realms').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the parameters of a single Realm. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.realms.patch({ + * // Required. Identifier. Unique name/ID of the realm + * name: 'projects/my-project/locations/my-location/realms/my-realm', + * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. + * requestId: 'placeholder-value', + * // Optional. Field mask is used to specify the fields to be overwritten in the Realm resource by the update. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "aggregatedData": {}, + * // "createTime": "my_createTime", + * // "discoveryMetadata": {}, + * // "ipVersion": "my_ipVersion", + * // "labels": {}, + * // "managementType": "my_managementType", + * // "name": "my_name", + * // "registryBook": "my_registryBook", + * // "trafficType": "my_trafficType", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Realms$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Realms$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Realms$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Realms$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Realms$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Realms$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Realms$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Realms$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Realms$Create extends StandardParameters { + /** + * Required. Value for parent. + */ + parent?: string; + /** + * Required. Id of the requesting object. + */ + realmId?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Realm; + } + export interface Params$Resource$Projects$Locations$Realms$Delete extends StandardParameters { + /** + * Optional. If set to true, all associated resources will be deleted. + */ + force?: boolean; + /** + * Required. Name of the resource + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Realms$Get extends StandardParameters { + /** + * Required. Name of the resource + */ + name?: string; + /** + * Optional. The view of the Realm. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Realms$List extends StandardParameters { + /** + * Optional. Filtering results + */ + filter?: string; + /** + * Optional. Hint for how to order the results + */ + orderBy?: string; + /** + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. Parent value for ListRealmsRequest + */ + parent?: string; + /** + * Optional. The view of the Realm. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Realms$Patch extends StandardParameters { + /** + * Required. Identifier. Unique name/ID of the realm + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. + */ + requestId?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the Realm resource by the update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Realm; + } + + export class Resource$Projects$Locations$Registrybooks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new RegistryBook in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.registryBooks.create( + * { + * // Required. Value for parent. + * parent: 'projects/my-project/locations/my-location', + * // Required. Id of the requesting object. + * registryBookId: 'placeholder-value', + * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "aggregatedData": {}, + * // "claimedScopes": [], + * // "createTime": "my_createTime", + * // "isDefault": false, + * // "labels": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Registrybooks$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Registrybooks$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Registrybooks$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Registrybooks$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Registrybooks$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Registrybooks$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Registrybooks$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Registrybooks$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/registryBooks').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single RegistryBook. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.registryBooks.delete( + * { + * // Optional. If set to true, all associated resources will be deleted. + * force: 'placeholder-value', + * // Required. Name of the resource + * name: 'projects/my-project/locations/my-location/registryBooks/my-registryBook', + * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Registrybooks$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Registrybooks$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Registrybooks$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Registrybooks$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Registrybooks$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Registrybooks$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Registrybooks$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Registrybooks$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single RegistryBook. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.registryBooks.get({ + * // Required. Name of the resource + * name: 'projects/my-project/locations/my-location/registryBooks/my-registryBook', + * // Optional. The view of the RegistryBook. + * view: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "aggregatedData": {}, + * // "claimedScopes": [], + * // "createTime": "my_createTime", + * // "isDefault": false, + * // "labels": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Registrybooks$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Registrybooks$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Registrybooks$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Registrybooks$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Registrybooks$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Registrybooks$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Registrybooks$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Registrybooks$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.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 RegistryBooks in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.registryBooks.list({ + * // Optional. Filtering results + * filter: 'placeholder-value', + * // Optional. Hint for how to order the results + * orderBy: 'placeholder-value', + * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. Parent value for ListRegistryBooksRequest + * parent: 'projects/my-project/locations/my-location', + * // Optional. The view of the RegistryBook. + * view: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "registryBooks": [], + * // "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$Registrybooks$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Registrybooks$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Registrybooks$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Registrybooks$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Registrybooks$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Registrybooks$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Registrybooks$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Registrybooks$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/registryBooks').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the parameters of a single RegistryBook. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.projects.locations.registryBooks.patch({ + * // Required. Identifier. name of resource + * name: 'projects/my-project/locations/my-location/registryBooks/my-registryBook', + * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Optional. Field mask is used to specify the fields to be overwritten in the RegistryBook resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "aggregatedData": {}, + * // "claimedScopes": [], + * // "createTime": "my_createTime", + * // "isDefault": false, + * // "labels": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Registrybooks$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Registrybooks$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Registrybooks$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Registrybooks$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Registrybooks$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Registrybooks$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Registrybooks$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Registrybooks$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.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); + } + } + + /** + * Searches IP resources in a given RegistryBook. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await cloudnumberregistry.projects.locations.registryBooks.searchIpResources( + * { + * // Required. The name of the RegistryBook to search in. + * name: 'projects/my-project/locations/my-location/registryBooks/my-registryBook', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "orderBy": "my_orderBy", + * // "pageSize": 0, + * // "pageToken": "my_pageToken", + * // "query": "my_query", + * // "searchResourceTypes": [], + * // "showUtilization": false + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "ranges": [], + * // "results": [], + * // "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. + */ + searchIpResources( + params: Params$Resource$Projects$Locations$Registrybooks$Searchipresources, + options: StreamMethodOptions + ): Promise>; + searchIpResources( + params?: Params$Resource$Projects$Locations$Registrybooks$Searchipresources, + options?: MethodOptions + ): Promise>; + searchIpResources( + params: Params$Resource$Projects$Locations$Registrybooks$Searchipresources, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchIpResources( + params: Params$Resource$Projects$Locations$Registrybooks$Searchipresources, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchIpResources( + params: Params$Resource$Projects$Locations$Registrybooks$Searchipresources, + callback: BodyResponseCallback + ): void; + searchIpResources( + callback: BodyResponseCallback + ): void; + searchIpResources( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Registrybooks$Searchipresources + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Registrybooks$Searchipresources; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Registrybooks$Searchipresources; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:searchIpResources').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$Registrybooks$Create extends StandardParameters { + /** + * Required. Value for parent. + */ + parent?: string; + /** + * Required. Id of the requesting object. + */ + registryBookId?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegistryBook; + } + export interface Params$Resource$Projects$Locations$Registrybooks$Delete extends StandardParameters { + /** + * Optional. If set to true, all associated resources will be deleted. + */ + force?: boolean; + /** + * Required. Name of the resource + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Registrybooks$Get extends StandardParameters { + /** + * Required. Name of the resource + */ + name?: string; + /** + * Optional. The view of the RegistryBook. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Registrybooks$List extends StandardParameters { + /** + * Optional. Filtering results + */ + filter?: string; + /** + * Optional. Hint for how to order the results + */ + orderBy?: string; + /** + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. Parent value for ListRegistryBooksRequest + */ + parent?: string; + /** + * Optional. The view of the RegistryBook. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Registrybooks$Patch extends StandardParameters { + /** + * Required. Identifier. name of resource + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the RegistryBook resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegistryBook; + } + export interface Params$Resource$Projects$Locations$Registrybooks$Searchipresources extends StandardParameters { + /** + * Required. The name of the RegistryBook to search in. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SearchIpResourcesRequest; + } +} diff --git a/src/apis/cloudnumberregistry/webpack.config.js b/src/apis/cloudnumberregistry/webpack.config.js new file mode 100644 index 00000000000..dc6b76aa210 --- /dev/null +++ b/src/apis/cloudnumberregistry/webpack.config.js @@ -0,0 +1,79 @@ +// Copyright 2019 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Use `npm run webpack` to produce Webpack bundle for this library. + +const path = require('path'); + +module.exports = { + entry: './index.ts', + resolve: { + extensions: ['.ts', '.js', '.json'], + fallback: { + crypto: false, + child_process: false, + fs: false, + http2: false, + buffer: 'browserify', + process: false, + os: false, + querystring: false, + path: false, + stream: 'stream-browserify', + url: false, + util: false, + zlib: false, + }, + }, + output: { + library: 'Cloudnumberregistry', + filename: 'cloudnumberregistry.min.js', + path: path.resolve(__dirname, 'dist'), + }, + module: { + rules: [ + { + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]https-proxy-agent[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gcp-metadata[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gtoken[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]pkginfo[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]semver[\\/]/, + use: 'null-loader', + }, + { + test: /\.ts$/, + use: 'ts-loader', + exclude: /node_modules/, + }, + ], + }, + mode: 'production', + plugins: [], +}; diff --git a/src/apis/compute/alpha.ts b/src/apis/compute/alpha.ts index 784fe6156bd..913e6b74aaf 100644 --- a/src/apis/compute/alpha.ts +++ b/src/apis/compute/alpha.ts @@ -1523,29 +1523,6 @@ export namespace compute_alpha { * is 500 GB. */ diskSizeGb?: string | null; - /** - * Specifies the disk type to use to create the instance. If not specified, - * the default is pd-standard, specified using the full URL. - * For example: - * - * https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard - * - * - * For a full list of acceptable values, seePersistent disk - * types. If you specify this field when creating a VM, you can provide - * either the full or partial URL. For example, the following values are - * valid: - * - * - * - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType - * - projects/project/zones/zone/diskTypes/diskType - * - zones/zone/diskTypes/diskType - * - * - * If you specify this field when creating or updating an instance template - * or all-instances configuration, specify the type of the disk, not the - * URL. For example: pd-standard. - */ diskType?: string | null; /** * Whether this disk is using confidential compute mode. @@ -23163,7 +23140,11 @@ export namespace compute_alpha { name?: string | null; /** * The URL of the network to which all network endpoints in the NEG belong. - * Uses default project network if unspecified. + * For networkEndpointType GCE_VM_IP_PORT,GCE_VM_IP_PORTMAP or NON_GCP_PRIVATE_IP_PORT, + * if this field is not specified, a default network will be used. + * This field cannot be set for NEGs with networkEndpointType set toSERVERLESS or PRIVATE_SERVICE_CONNECT and for + * global NEGs. + * For all other network endpoint types, this field is required. */ network?: string | null; /** @@ -23390,8 +23371,12 @@ export namespace compute_alpha { defaultPort?: number | null; /** * The URL of the network to which all network endpoints in the NEG belong. - * Uses default project network if unspecified. - * [Deprecated] This field is deprecated. + * For networkEndpointType GCE_VM_IP_PORT,GCE_VM_IP_PORTMAP or NON_GCP_PRIVATE_IP_PORT, + * if this field is not specified, a default network will be used. + * This field cannot be set for NEGs with networkEndpointType set toSERVERLESS or PRIVATE_SERVICE_CONNECT and for + * global NEGs. + * For all other network endpoint types, this field is required. + * [Deprecated] This field is deprecated. */ network?: string | null; /** diff --git a/src/apis/compute/beta.ts b/src/apis/compute/beta.ts index 4f86b04d051..52a8c662223 100644 --- a/src/apis/compute/beta.ts +++ b/src/apis/compute/beta.ts @@ -1441,29 +1441,6 @@ export namespace compute_beta { * is 500 GB. */ diskSizeGb?: string | null; - /** - * Specifies the disk type to use to create the instance. If not specified, - * the default is pd-standard, specified using the full URL. - * For example: - * - * https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard - * - * - * For a full list of acceptable values, seePersistent disk - * types. If you specify this field when creating a VM, you can provide - * either the full or partial URL. For example, the following values are - * valid: - * - * - * - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType - * - projects/project/zones/zone/diskTypes/diskType - * - zones/zone/diskTypes/diskType - * - * - * If you specify this field when creating or updating an instance template - * or all-instances configuration, specify the type of the disk, not the - * URL. For example: pd-standard. - */ diskType?: string | null; /** * Whether this disk is using confidential compute mode. @@ -6882,6 +6859,37 @@ export namespace compute_beta { * version of the instant snapshot that was used. */ sourceInstantSnapshotId?: string | null; + /** + * The machine image to create the disk from. You can provide this as a + * partial or full URL to the resource. For example, the following are valid + * values: + * + * + * - https://www.googleapis.com/compute/v1/projects/project/global/machineImages/machineImage + * - projects/project/global/machineImages/machineImage + * - global/machineImages/machineImage + */ + sourceMachineImage?: string | null; + /** + * The device name of a disk within a given machine image. The + * source_machine_image must be specified. + */ + sourceMachineImageDiskDeviceName?: string | null; + /** + * Thecustomer-supplied + * encryption key of the source machine image. Required if the source + * machine image is protected by a customer-supplied encryption key. + */ + sourceMachineImageEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * Output only. [Output Only] The unique ID of the machine image used to create this disk. + * This value identifies the exact machine image that was used to create this + * persistent disk. For example, if you created the persistent disk from a + * machine image that was later deleted and recreated under the same name, the + * source machine image ID would identify the exact version of the machine + * image that was used. + */ + sourceMachineImageId?: string | null; /** * The source snapshot used to create this disk. You can provide this as a * partial or full URL to the resource. For example, the following are valid @@ -16348,6 +16356,12 @@ export namespace compute_beta { * create the resource. */ description?: string | null; + /** + * Output only. [Output Only] URL of the InterconnectLocation object that represents where + * this connection is to be provisioned. By default it will be the same as the + * location field. + */ + effectiveLocation?: string | null; /** * Output only. [Output Only] A list of outages expected for this Interconnect. */ @@ -19412,6 +19426,16 @@ export namespace compute_beta { * Machine Image parameters */ export interface Schema$MachineImageParams { + /** + * Input only. [Input Only] Specifies the list of disk device names that must be + * excluded from the new machine image. + */ + excludedDisks?: string[] | null; + /** + * Input only. [Input Only] Specifies the list of disk device names that must be + * included with the new machine image. + */ + includedDisks?: string[] | null; /** * Input only. Resource manager tags to be bound to the machine image. Tag keys and values * have the same definition as resource @@ -20814,7 +20838,11 @@ export namespace compute_beta { name?: string | null; /** * The URL of the network to which all network endpoints in the NEG belong. - * Uses default project network if unspecified. + * For networkEndpointType GCE_VM_IP_PORT,GCE_VM_IP_PORTMAP or NON_GCP_PRIVATE_IP_PORT, + * if this field is not specified, a default network will be used. + * This field cannot be set for NEGs with networkEndpointType set toSERVERLESS or PRIVATE_SERVICE_CONNECT and for + * global NEGs. + * For all other network endpoint types, this field is required. */ network?: string | null; /** @@ -21033,8 +21061,12 @@ export namespace compute_beta { defaultPort?: number | null; /** * The URL of the network to which all network endpoints in the NEG belong. - * Uses default project network if unspecified. - * [Deprecated] This field is deprecated. + * For networkEndpointType GCE_VM_IP_PORT,GCE_VM_IP_PORTMAP or NON_GCP_PRIVATE_IP_PORT, + * if this field is not specified, a default network will be used. + * This field cannot be set for NEGs with networkEndpointType set toSERVERLESS or PRIVATE_SERVICE_CONNECT and for + * global NEGs. + * For all other network endpoint types, this field is required. + * [Deprecated] This field is deprecated. */ network?: string | null; /** @@ -53277,6 +53309,10 @@ export namespace compute_beta { * // "sourceImageId": "my_sourceImageId", * // "sourceInstantSnapshot": "my_sourceInstantSnapshot", * // "sourceInstantSnapshotId": "my_sourceInstantSnapshotId", + * // "sourceMachineImage": "my_sourceMachineImage", + * // "sourceMachineImageDiskDeviceName": "my_sourceMachineImageDiskDeviceName", + * // "sourceMachineImageEncryptionKey": {}, + * // "sourceMachineImageId": "my_sourceMachineImageId", * // "sourceSnapshot": "my_sourceSnapshot", * // "sourceSnapshotEncryptionKey": {}, * // "sourceSnapshotId": "my_sourceSnapshotId", @@ -53645,6 +53681,10 @@ export namespace compute_beta { * // "sourceImageId": "my_sourceImageId", * // "sourceInstantSnapshot": "my_sourceInstantSnapshot", * // "sourceInstantSnapshotId": "my_sourceInstantSnapshotId", + * // "sourceMachineImage": "my_sourceMachineImage", + * // "sourceMachineImageDiskDeviceName": "my_sourceMachineImageDiskDeviceName", + * // "sourceMachineImageEncryptionKey": {}, + * // "sourceMachineImageId": "my_sourceMachineImageId", * // "sourceSnapshot": "my_sourceSnapshot", * // "sourceSnapshotEncryptionKey": {}, * // "sourceSnapshotId": "my_sourceSnapshotId", @@ -55610,6 +55650,10 @@ export namespace compute_beta { * // "sourceImageId": "my_sourceImageId", * // "sourceInstantSnapshot": "my_sourceInstantSnapshot", * // "sourceInstantSnapshotId": "my_sourceInstantSnapshotId", + * // "sourceMachineImage": "my_sourceMachineImage", + * // "sourceMachineImageDiskDeviceName": "my_sourceMachineImageDiskDeviceName", + * // "sourceMachineImageEncryptionKey": {}, + * // "sourceMachineImageId": "my_sourceMachineImageId", * // "sourceSnapshot": "my_sourceSnapshot", * // "sourceSnapshotEncryptionKey": {}, * // "sourceSnapshotId": "my_sourceSnapshotId", @@ -125314,6 +125358,7 @@ export namespace compute_beta { * // "creationTimestamp": "my_creationTimestamp", * // "customerName": "my_customerName", * // "description": "my_description", + * // "effectiveLocation": "my_effectiveLocation", * // "expectedOutages": [], * // "googleIpAddress": "my_googleIpAddress", * // "googleReferenceId": "my_googleReferenceId", @@ -125824,6 +125869,7 @@ export namespace compute_beta { * // "creationTimestamp": "my_creationTimestamp", * // "customerName": "my_customerName", * // "description": "my_description", + * // "effectiveLocation": "my_effectiveLocation", * // "expectedOutages": [], * // "googleIpAddress": "my_googleIpAddress", * // "googleReferenceId": "my_googleReferenceId", @@ -126286,6 +126332,7 @@ export namespace compute_beta { * // "creationTimestamp": "my_creationTimestamp", * // "customerName": "my_customerName", * // "description": "my_description", + * // "effectiveLocation": "my_effectiveLocation", * // "expectedOutages": [], * // "googleIpAddress": "my_googleIpAddress", * // "googleReferenceId": "my_googleReferenceId", @@ -177378,6 +177425,10 @@ export namespace compute_beta { * // "sourceImageId": "my_sourceImageId", * // "sourceInstantSnapshot": "my_sourceInstantSnapshot", * // "sourceInstantSnapshotId": "my_sourceInstantSnapshotId", + * // "sourceMachineImage": "my_sourceMachineImage", + * // "sourceMachineImageDiskDeviceName": "my_sourceMachineImageDiskDeviceName", + * // "sourceMachineImageEncryptionKey": {}, + * // "sourceMachineImageId": "my_sourceMachineImageId", * // "sourceSnapshot": "my_sourceSnapshot", * // "sourceSnapshotEncryptionKey": {}, * // "sourceSnapshotId": "my_sourceSnapshotId", @@ -177743,6 +177794,10 @@ export namespace compute_beta { * // "sourceImageId": "my_sourceImageId", * // "sourceInstantSnapshot": "my_sourceInstantSnapshot", * // "sourceInstantSnapshotId": "my_sourceInstantSnapshotId", + * // "sourceMachineImage": "my_sourceMachineImage", + * // "sourceMachineImageDiskDeviceName": "my_sourceMachineImageDiskDeviceName", + * // "sourceMachineImageEncryptionKey": {}, + * // "sourceMachineImageId": "my_sourceMachineImageId", * // "sourceSnapshot": "my_sourceSnapshot", * // "sourceSnapshotEncryptionKey": {}, * // "sourceSnapshotId": "my_sourceSnapshotId", @@ -179710,6 +179765,10 @@ export namespace compute_beta { * // "sourceImageId": "my_sourceImageId", * // "sourceInstantSnapshot": "my_sourceInstantSnapshot", * // "sourceInstantSnapshotId": "my_sourceInstantSnapshotId", + * // "sourceMachineImage": "my_sourceMachineImage", + * // "sourceMachineImageDiskDeviceName": "my_sourceMachineImageDiskDeviceName", + * // "sourceMachineImageEncryptionKey": {}, + * // "sourceMachineImageId": "my_sourceMachineImageId", * // "sourceSnapshot": "my_sourceSnapshot", * // "sourceSnapshotEncryptionKey": {}, * // "sourceSnapshotId": "my_sourceSnapshotId", @@ -240631,6 +240690,190 @@ export namespace compute_beta { this.context = context; } + /** + * Advances a Rollout to the next wave, or completes it if no waves remain. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const compute = google.compute('beta'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await compute.rollouts.advance({ + * // Required. Wave number of the current wave. + * currentWaveNumber: 'placeholder-value', + * // Required. Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so + * // that if you must retry your request, the server will know to ignore the + * // request if it has already been completed. + * // + * // For example, consider a situation where you make an initial request and + * // the request times out. If you make the request again with the same + * // request ID, the server can check if original operation with the same + * // request ID was received, and if so, will ignore the second request. This + * // prevents clients from accidentally creating duplicate commitments. + * // + * // The request ID must be + * // a valid UUID with the exception that zero UUID is not supported + * // (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Required. Name of the Rollout resource to advance. + * rollout: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "getVersionOperationMetadata": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + advance( + params: Params$Resource$Rollouts$Advance, + options: StreamMethodOptions + ): Promise>; + advance( + params?: Params$Resource$Rollouts$Advance, + options?: MethodOptions + ): Promise>; + advance( + params: Params$Resource$Rollouts$Advance, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + advance( + params: Params$Resource$Rollouts$Advance, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + advance( + params: Params$Resource$Rollouts$Advance, + callback: BodyResponseCallback + ): void; + advance(callback: BodyResponseCallback): void; + advance( + paramsOrCallback?: + | Params$Resource$Rollouts$Advance + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Rollouts$Advance; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Rollouts$Advance; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/global/rollouts/{rollout}/advance' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'rollout'], + pathParams: ['project', 'rollout'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Cancels a Rollout. * @example @@ -241392,8 +241635,410 @@ export namespace compute_beta { return createAPIRequest(parameters); } } + + /** + * Pauses a Rollout. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const compute = google.compute('beta'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await compute.rollouts.pause({ + * // The etag of the Rollout. + * // If this is provided, the request will only succeed if the etag matches + * // the current etag of the Rollout. + * etag: 'placeholder-value', + * // Required. Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so + * // that if you must retry your request, the server will know to ignore the + * // request if it has already been completed. + * // + * // For example, consider a situation where you make an initial request and + * // the request times out. If you make the request again with the same + * // request ID, the server can check if original operation with the same + * // request ID was received, and if so, will ignore the second request. This + * // prevents clients from accidentally creating duplicate commitments. + * // + * // The request ID must be + * // a valid UUID with the exception that zero UUID is not supported + * // (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Required. Name of the Rollout resource to pause. + * rollout: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "getVersionOperationMetadata": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + pause( + params: Params$Resource$Rollouts$Pause, + options: StreamMethodOptions + ): Promise>; + pause( + params?: Params$Resource$Rollouts$Pause, + options?: MethodOptions + ): Promise>; + pause( + params: Params$Resource$Rollouts$Pause, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + pause( + params: Params$Resource$Rollouts$Pause, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + pause( + params: Params$Resource$Rollouts$Pause, + callback: BodyResponseCallback + ): void; + pause(callback: BodyResponseCallback): void; + pause( + paramsOrCallback?: + | Params$Resource$Rollouts$Pause + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Rollouts$Pause; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Rollouts$Pause; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/global/rollouts/{rollout}/pause' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'rollout'], + pathParams: ['project', 'rollout'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Resumes a Rollout. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const compute = google.compute('beta'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await compute.rollouts.resume({ + * // The etag of the Rollout. + * // If this is provided, the request will only succeed if the etag matches + * // the current etag of the Rollout. + * etag: 'placeholder-value', + * // Required. Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so + * // that if you must retry your request, the server will know to ignore the + * // request if it has already been completed. + * // + * // For example, consider a situation where you make an initial request and + * // the request times out. If you make the request again with the same + * // request ID, the server can check if original operation with the same + * // request ID was received, and if so, will ignore the second request. This + * // prevents clients from accidentally creating duplicate commitments. + * // + * // The request ID must be + * // a valid UUID with the exception that zero UUID is not supported + * // (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Required. Name of the Rollout resource to resume. + * rollout: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "getVersionOperationMetadata": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + resume( + params: Params$Resource$Rollouts$Resume, + options: StreamMethodOptions + ): Promise>; + resume( + params?: Params$Resource$Rollouts$Resume, + options?: MethodOptions + ): Promise>; + resume( + params: Params$Resource$Rollouts$Resume, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resume( + params: Params$Resource$Rollouts$Resume, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resume( + params: Params$Resource$Rollouts$Resume, + callback: BodyResponseCallback + ): void; + resume(callback: BodyResponseCallback): void; + resume( + paramsOrCallback?: + | Params$Resource$Rollouts$Resume + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Rollouts$Resume; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Rollouts$Resume; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/global/rollouts/{rollout}/resume' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'rollout'], + pathParams: ['project', 'rollout'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } + export interface Params$Resource$Rollouts$Advance extends StandardParameters { + /** + * Required. Wave number of the current wave. + */ + currentWaveNumber?: string; + /** + * Required. Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so + * that if you must retry your request, the server will know to ignore the + * request if it has already been completed. + * + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same + * request ID, the server can check if original operation with the same + * request ID was received, and if so, will ignore the second request. This + * prevents clients from accidentally creating duplicate commitments. + * + * The request ID must be + * a valid UUID with the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Required. Name of the Rollout resource to advance. + */ + rollout?: string; + } export interface Params$Resource$Rollouts$Cancel extends StandardParameters { /** * Project ID for this request. @@ -241567,6 +242212,70 @@ export namespace compute_beta { */ returnPartialSuccess?: boolean; } + export interface Params$Resource$Rollouts$Pause extends StandardParameters { + /** + * The etag of the Rollout. + * If this is provided, the request will only succeed if the etag matches + * the current etag of the Rollout. + */ + etag?: string; + /** + * Required. Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so + * that if you must retry your request, the server will know to ignore the + * request if it has already been completed. + * + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same + * request ID, the server can check if original operation with the same + * request ID was received, and if so, will ignore the second request. This + * prevents clients from accidentally creating duplicate commitments. + * + * The request ID must be + * a valid UUID with the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Required. Name of the Rollout resource to pause. + */ + rollout?: string; + } + export interface Params$Resource$Rollouts$Resume extends StandardParameters { + /** + * The etag of the Rollout. + * If this is provided, the request will only succeed if the etag matches + * the current etag of the Rollout. + */ + etag?: string; + /** + * Required. Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so + * that if you must retry your request, the server will know to ignore the + * request if it has already been completed. + * + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same + * request ID, the server can check if original operation with the same + * request ID was received, and if so, will ignore the second request. This + * prevents clients from accidentally creating duplicate commitments. + * + * The request ID must be + * a valid UUID with the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Required. Name of the Rollout resource to resume. + */ + rollout?: string; + } export class Resource$Routers { context: APIRequestContext; diff --git a/src/apis/compute/v1.ts b/src/apis/compute/v1.ts index 8a04c41c5ee..3f70556d1a6 100644 --- a/src/apis/compute/v1.ts +++ b/src/apis/compute/v1.ts @@ -1392,29 +1392,6 @@ export namespace compute_v1 { * is 500 GB. */ diskSizeGb?: string | null; - /** - * Specifies the disk type to use to create the instance. If not specified, - * the default is pd-standard, specified using the full URL. - * For example: - * - * https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard - * - * - * For a full list of acceptable values, seePersistent disk - * types. If you specify this field when creating a VM, you can provide - * either the full or partial URL. For example, the following values are - * valid: - * - * - * - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType - * - projects/project/zones/zone/diskTypes/diskType - * - zones/zone/diskTypes/diskType - * - * - * If you specify this field when creating or updating an instance template - * or all-instances configuration, specify the type of the disk, not the - * URL. For example: pd-standard. - */ diskType?: string | null; /** * Whether this disk is using confidential compute mode. @@ -7824,6 +7801,20 @@ export namespace compute_v1 { * 'mirror'. Cannot be specified for other actions. */ securityProfileGroup?: string | null; + /** + * A list of forwarding rules to which this rule applies. + * This field allows you to control which load balancers get this rule. + * For example, the following are valid values: + * + * + * - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule + * - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule + * - projects/project/global/ + * forwardingRules/forwardingRule + * - projects/project/regions/region/forwardingRules/ + * forwardingRule + */ + targetForwardingRules?: string[] | null; /** * A list of network resource URLs to which this rule applies. This field * allows you to control which network's VMs get this rule. If this field @@ -7846,6 +7837,11 @@ export namespace compute_v1 { * applied with this rule. */ targetServiceAccounts?: string[] | null; + /** + * Target types of the firewall policy rule. + * Default value is INSTANCES. + */ + targetType?: string | null; /** * Boolean flag indicating if the traffic should be TLS decrypted. * Can be set only if action = 'apply_security_profile_group' and cannot @@ -19302,7 +19298,11 @@ export namespace compute_v1 { name?: string | null; /** * The URL of the network to which all network endpoints in the NEG belong. - * Uses default project network if unspecified. + * For networkEndpointType GCE_VM_IP_PORT,GCE_VM_IP_PORTMAP or NON_GCP_PRIVATE_IP_PORT, + * if this field is not specified, a default network will be used. + * This field cannot be set for NEGs with networkEndpointType set toSERVERLESS or PRIVATE_SERVICE_CONNECT and for + * global NEGs. + * For all other network endpoint types, this field is required. */ network?: string | null; /** @@ -56117,9 +56117,11 @@ export namespace compute_v1 { * // "ruleName": "my_ruleName", * // "ruleTupleCount": 0, * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], * // "targetResources": [], * // "targetSecureTags": [], * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", * // "tlsInspect": false * // } * }, @@ -57125,9 +57127,11 @@ export namespace compute_v1 { * // "ruleName": "my_ruleName", * // "ruleTupleCount": 0, * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], * // "targetResources": [], * // "targetSecureTags": [], * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", * // "tlsInspect": false * // } * } @@ -58281,9 +58285,11 @@ export namespace compute_v1 { * // "ruleName": "my_ruleName", * // "ruleTupleCount": 0, * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], * // "targetResources": [], * // "targetSecureTags": [], * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", * // "tlsInspect": false * // } * }, @@ -130534,9 +130540,11 @@ export namespace compute_v1 { * // "ruleName": "my_ruleName", * // "ruleTupleCount": 0, * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], * // "targetResources": [], * // "targetSecureTags": [], * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", * // "tlsInspect": false * // } * }, @@ -130748,9 +130756,11 @@ export namespace compute_v1 { * // "ruleName": "my_ruleName", * // "ruleTupleCount": 0, * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], * // "targetResources": [], * // "targetSecureTags": [], * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", * // "tlsInspect": false * // } * }, @@ -132036,9 +132046,11 @@ export namespace compute_v1 { * // "ruleName": "my_ruleName", * // "ruleTupleCount": 0, * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], * // "targetResources": [], * // "targetSecureTags": [], * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", * // "tlsInspect": false * // } * } @@ -132199,9 +132211,11 @@ export namespace compute_v1 { * // "ruleName": "my_ruleName", * // "ruleTupleCount": 0, * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], * // "targetResources": [], * // "targetSecureTags": [], * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", * // "tlsInspect": false * // } * } @@ -133017,9 +133031,11 @@ export namespace compute_v1 { * // "ruleName": "my_ruleName", * // "ruleTupleCount": 0, * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], * // "targetResources": [], * // "targetSecureTags": [], * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", * // "tlsInspect": false * // } * }, @@ -133227,9 +133243,11 @@ export namespace compute_v1 { * // "ruleName": "my_ruleName", * // "ruleTupleCount": 0, * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], * // "targetResources": [], * // "targetSecureTags": [], * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", * // "tlsInspect": false * // } * }, @@ -195010,9 +195028,11 @@ export namespace compute_v1 { * // "ruleName": "my_ruleName", * // "ruleTupleCount": 0, * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], * // "targetResources": [], * // "targetSecureTags": [], * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", * // "tlsInspect": false * // } * }, @@ -196210,9 +196230,11 @@ export namespace compute_v1 { * // "ruleName": "my_ruleName", * // "ruleTupleCount": 0, * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], * // "targetResources": [], * // "targetSecureTags": [], * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", * // "tlsInspect": false * // } * } @@ -197038,9 +197060,11 @@ export namespace compute_v1 { * // "ruleName": "my_ruleName", * // "ruleTupleCount": 0, * // "securityProfileGroup": "my_securityProfileGroup", + * // "targetForwardingRules": [], * // "targetResources": [], * // "targetSecureTags": [], * // "targetServiceAccounts": [], + * // "targetType": "my_targetType", * // "tlsInspect": false * // } * }, diff --git a/src/apis/contactcenterinsights/v1.ts b/src/apis/contactcenterinsights/v1.ts index cf768f57814..1edbcd2446c 100644 --- a/src/apis/contactcenterinsights/v1.ts +++ b/src/apis/contactcenterinsights/v1.ts @@ -124,6 +124,272 @@ export namespace contactcenterinsights_v1 { } } + /** + * A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. + */ + export interface Schema$GoogleCloudAiplatformV1Blob { + /** + * Required. The raw bytes of the data. + */ + data?: string | null; + /** + * Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + */ + displayName?: string | null; + /** + * Required. The IANA standard MIME type of the source data. + */ + mimeType?: string | null; + } + /** + * Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. + */ + export interface Schema$GoogleCloudAiplatformV1CodeExecutionResult { + /** + * Required. Outcome of the code execution. + */ + outcome?: string | null; + /** + * Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + */ + output?: string | null; + } + /** + * The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + */ + export interface Schema$GoogleCloudAiplatformV1Content { + /** + * Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + */ + parts?: Schema$GoogleCloudAiplatformV1Part[]; + /** + * Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + */ + role?: string | null; + } + /** + * Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. + */ + export interface Schema$GoogleCloudAiplatformV1ExecutableCode { + /** + * Required. The code to be executed. + */ + code?: string | null; + /** + * Required. Programming language of the `code`. + */ + language?: string | null; + } + /** + * URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. + */ + export interface Schema$GoogleCloudAiplatformV1FileData { + /** + * Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + */ + displayName?: string | null; + /** + * Required. The URI of the file in Google Cloud Storage. + */ + fileUri?: string | null; + /** + * Required. The IANA standard MIME type of the source data. + */ + mimeType?: string | null; + } + /** + * A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. + */ + export interface Schema$GoogleCloudAiplatformV1FunctionCall { + /** + * Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + */ + args?: {[key: string]: any} | null; + /** + * Optional. The name of the function to call. Matches FunctionDeclaration.name. + */ + name?: string | null; + /** + * Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + */ + partialArgs?: Schema$GoogleCloudAiplatformV1PartialArg[]; + /** + * Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + */ + willContinue?: boolean | null; + } + /** + * The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. + */ + export interface Schema$GoogleCloudAiplatformV1FunctionResponse { + /** + * Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + */ + name?: string | null; + /** + * Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + */ + parts?: Schema$GoogleCloudAiplatformV1FunctionResponsePart[]; + /** + * Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + */ + response?: {[key: string]: any} | null; + /** + * Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + */ + scheduling?: string | null; + } + /** + * Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. + */ + export interface Schema$GoogleCloudAiplatformV1FunctionResponseBlob { + /** + * Required. Raw bytes. + */ + data?: string | null; + /** + * Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + */ + displayName?: string | null; + /** + * Required. The IANA standard MIME type of the source data. + */ + mimeType?: string | null; + } + /** + * URI based data for function response. + */ + export interface Schema$GoogleCloudAiplatformV1FunctionResponseFileData { + /** + * Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + */ + displayName?: string | null; + /** + * Required. URI. + */ + fileUri?: string | null; + /** + * Required. The IANA standard MIME type of the source data. + */ + mimeType?: string | null; + } + /** + * A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + */ + export interface Schema$GoogleCloudAiplatformV1FunctionResponsePart { + /** + * URI based data. + */ + fileData?: Schema$GoogleCloudAiplatformV1FunctionResponseFileData; + /** + * Inline media bytes. + */ + inlineData?: Schema$GoogleCloudAiplatformV1FunctionResponseBlob; + } + /** + * A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + */ + export interface Schema$GoogleCloudAiplatformV1Part { + /** + * Optional. The result of executing the ExecutableCode. + */ + codeExecutionResult?: Schema$GoogleCloudAiplatformV1CodeExecutionResult; + /** + * Optional. Code generated by the model that is intended to be executed. + */ + executableCode?: Schema$GoogleCloudAiplatformV1ExecutableCode; + /** + * Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + */ + fileData?: Schema$GoogleCloudAiplatformV1FileData; + /** + * Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + */ + functionCall?: Schema$GoogleCloudAiplatformV1FunctionCall; + /** + * Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + */ + functionResponse?: Schema$GoogleCloudAiplatformV1FunctionResponse; + /** + * Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + */ + inlineData?: Schema$GoogleCloudAiplatformV1Blob; + /** + * per part media resolution. Media resolution for the input media. + */ + mediaResolution?: Schema$GoogleCloudAiplatformV1PartMediaResolution; + /** + * Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + */ + text?: string | null; + /** + * Optional. Indicates whether the `part` represents the model's thought process or reasoning. + */ + thought?: boolean | null; + /** + * Optional. An opaque signature for the thought so it can be reused in subsequent requests. + */ + thoughtSignature?: string | null; + /** + * Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + */ + videoMetadata?: Schema$GoogleCloudAiplatformV1VideoMetadata; + } + /** + * Partial argument value of the function call. + */ + export interface Schema$GoogleCloudAiplatformV1PartialArg { + /** + * Optional. Represents a boolean value. + */ + boolValue?: boolean | null; + /** + * Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + */ + jsonPath?: string | null; + /** + * Optional. Represents a null value. + */ + nullValue?: string | null; + /** + * Optional. Represents a double value. + */ + numberValue?: number | null; + /** + * Optional. Represents a string value. + */ + stringValue?: string | null; + /** + * Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + */ + willContinue?: boolean | null; + } + /** + * per part media resolution. Media resolution for the input media. + */ + export interface Schema$GoogleCloudAiplatformV1PartMediaResolution { + /** + * The tokenization quality used for given media. + */ + level?: string | null; + } + /** + * Provides metadata for a video, including the start and end offsets for clipping and the frame rate. + */ + export interface Schema$GoogleCloudAiplatformV1VideoMetadata { + /** + * Optional. The end offset of the video. + */ + endOffset?: string | null; + /** + * Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + */ + fps?: number | null; + /** + * Optional. The start offset of the video. + */ + startOffset?: string | null; + } /** * Represents an event indicating the transfer of a conversation to a different agent. */ @@ -1486,7 +1752,7 @@ export namespace contactcenterinsights_v1 { */ metricType?: string | null; /** - * Output only. Deprecated: Use partial_trajectory_steps instead. The intermediate trajectory updates (partial trajectory). + * Output only. Deprecated: Use partial_trajectory_steps instead. Output only. The intermediate trajectory updates (partial trajectory). */ partialTrajectories?: string[] | null; /** @@ -1503,7 +1769,7 @@ export namespace contactcenterinsights_v1 { */ export interface Schema$GoogleCloudContactcenterinsightsV1alpha1DiagnoseConversationsRequest { /** - * Optional. If true, the request will be validated and a simulation of the analysis will be performed without actually executing the task. + * Optional. Deprecated: If true, the request will be validated and a simulation of the analysis will be performed without actually executing the task. This field is unused. Use validate_only instead. */ dryRun?: boolean | null; /** @@ -1511,7 +1777,7 @@ export namespace contactcenterinsights_v1 { */ filter?: string | null; /** - * Optional. If true, the agent will generate a full diagnostic report for all sub-agents. + * Optional. Deprecated: If true, the agent will generate a full diagnostic report for all sub-agents. Subagent reporting configuration is unused. The final diagnostic details are already persisted inside the Diagnostic resource instead. */ fullReport?: boolean | null; /** @@ -1527,7 +1793,7 @@ export namespace contactcenterinsights_v1 { */ metricType?: string | null; /** - * Optional. The configuration for the output of the task. + * Optional. Deprecated: The configuration for the output of the task. The export destination is unused. Detailed markdown and conversation slices are already persisted inside the Diagnostic resource instead. */ outputConfig?: Schema$GoogleCloudContactcenterinsightsV1alpha1OutputConfig; /** @@ -1552,19 +1818,19 @@ export namespace contactcenterinsights_v1 { */ export interface Schema$GoogleCloudContactcenterinsightsV1alpha1DiagnoseConversationsResponse { /** - * Output only. The final, high-level answer or diagnostic summary returned by the Sherlock worker. + * Output only. Deprecated: Output only. The final, high-level answer or diagnostic summary returned by the Sherlock worker is deprecated. The persistent analysis summary is stored inside the Diagnostic resource instead. */ answer?: string | null; /** - * Output only. If an external destination was requested, the URI of the exported data. + * Output only. Deprecated: Output only. If an external destination was requested, the URI of the exported data is deprecated. The persistent diagnostic details are stored inside the Diagnostic resource instead. */ exportUri?: string | null; /** - * Output only. Deprecated: Use full_trajectory_steps instead. The complete sequence of thoughts and actions (full trajectory). + * Output only. Deprecated: Use full_trajectory_steps instead. Output only. The complete sequence of thoughts and actions (full trajectory). */ fullTrajectories?: string[] | null; /** - * Output only. The complete sequence of thoughts and actions taken by the agent. + * Output only. Deprecated: Output only. The complete sequence of thoughts and actions taken by the agent is deprecated under LRO response completions. Use the persistent details inside the Diagnostic resource instead. */ fullTrajectorySteps?: Schema$GoogleCloudContactcenterinsightsV1alpha1SherlockStep[]; } @@ -1573,7 +1839,15 @@ export namespace contactcenterinsights_v1 { */ export interface Schema$GoogleCloudContactcenterinsightsV1alpha1DiagnosticReport { /** - * Output only. A breakdown of metrics grouped by intent. + * Output only. A map of conversation slices used in the report. + */ + conversationSlices?: { + [ + key: string + ]: Schema$GoogleCloudContactcenterinsightsV1alpha1DiagnosticReportConversationSlice; + } | null; + /** + * Output only. Deprecated: Intent breakdowns are no longer used. */ intentStats?: Schema$GoogleCloudContactcenterinsightsV1alpha1DiagnosticReportIntentStats[]; /** @@ -1586,6 +1860,19 @@ export namespace contactcenterinsights_v1 { metrics?: { [key: string]: Schema$GoogleCloudContactcenterinsightsV1alpha1MetricValue; } | null; + /** + * Output only. The final report in markdown format. + */ + report?: string | null; + } + /** + * Output only. A map of conversation slices used in the report. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1alpha1DiagnosticReportConversationSlice { + /** + * The list of conversation IDs that match this slice. + */ + conversationIds?: string[] | null; } /** * A breakdown of metrics grouped by intent. @@ -2743,6 +3030,10 @@ export namespace contactcenterinsights_v1 { * Output only. The unique identifier for the loss pattern. */ id?: string | null; + /** + * Output only. A list of links to conversations or bot instructions. + */ + links?: Schema$GoogleCloudContactcenterinsightsV1alpha1LossPatternLink[]; /** * Output only. The percentage of conversations that match this loss pattern. */ @@ -2752,6 +3043,61 @@ export namespace contactcenterinsights_v1 { */ suggestedFixes?: string | null; } + /** + * A link to a conversation or bot instruction. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1alpha1LossPatternLink { + /** + * A link to a bot instruction. + */ + botInstructionLink?: Schema$GoogleCloudContactcenterinsightsV1alpha1LossPatternLinkBotInstructionLink; + /** + * A link to a conversation. + */ + conversationLink?: Schema$GoogleCloudContactcenterinsightsV1alpha1LossPatternLinkConversationLink; + /** + * The end byte index of the highlighted text (exclusive). + */ + endByteIndex?: number | null; + /** + * The text that is highlighted. (populated for debugging purposes) + */ + highlightedText?: string | null; + /** + * The location type. + */ + locationType?: string | null; + /** + * The start byte index of the highlighted text (inclusive). + */ + startByteIndex?: number | null; + } + /** + * A link to a bot instruction. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1alpha1LossPatternLinkBotInstructionLink { + /** + * The exclusive end line number of the instructions. + */ + endLine?: number | null; + /** + * The inclusive start line number of the instructions. + */ + startLine?: number | null; + /** + * The name of the subagent. + */ + subagent?: string | null; + } + /** + * A link to a conversation. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1alpha1LossPatternLinkConversationLink { + /** + * The conversation ID. + */ + conversationId?: string | null; + } /** * Deprecated: MetricValue is no longer used for diagnostics. */ @@ -3612,19 +3958,35 @@ export namespace contactcenterinsights_v1 { */ export interface Schema$GoogleCloudContactcenterinsightsV1alpha1SherlockStep { /** - * Output only. Natural language input stimulus. + * Output only. The ID of the agent that produced/received this content. + */ + agentId?: string | null; + /** + * Output only. The content of the turn (either Model or User role). + */ + content?: Schema$GoogleCloudAiplatformV1Content; + /** + * Output only. List of state changes caused by this specific turn. + */ + stateDeltas?: Array<{[key: string]: any}> | null; + /** + * Output only. Unique ID for this specific turn. + */ + stepId?: string | null; + /** + * Output only. Deprecated: Use content instead. */ textInput?: string[] | null; /** - * Output only. The reasoning or internal monologue of the agent. + * Output only. Deprecated: Use content instead. */ thought?: string | null; /** - * Output only. The tool call issued by the agent. + * Output only. Deprecated: Use content instead. */ toolCalls?: Schema$GoogleCloudContactcenterinsightsV1alpha1ToolCall[]; /** - * Output only. The output response from the tool execution. + * Output only. Deprecated: Use content instead. */ toolOutput?: {[key: string]: any} | null; } @@ -5739,7 +6101,7 @@ export namespace contactcenterinsights_v1 { */ metricType?: string | null; /** - * Output only. Deprecated: Use partial_trajectory_steps instead. The intermediate trajectory updates (partial trajectory). + * Output only. Deprecated: Use partial_trajectory_steps instead. Output only. The intermediate trajectory updates (partial trajectory). */ partialTrajectories?: string[] | null; /** @@ -5756,7 +6118,7 @@ export namespace contactcenterinsights_v1 { */ export interface Schema$GoogleCloudContactcenterinsightsV1DiagnoseConversationsRequest { /** - * Optional. If true, the request will be validated and a simulation of the analysis will be performed without actually executing the task. + * Optional. Deprecated: If true, the request will be validated and a simulation of the analysis will be performed without actually executing the task. This field is unused. Use validate_only instead. */ dryRun?: boolean | null; /** @@ -5764,7 +6126,7 @@ export namespace contactcenterinsights_v1 { */ filter?: string | null; /** - * Optional. If true, the agent will generate a full diagnostic report for all sub-agents. + * Optional. Deprecated: If true, the agent will generate a full diagnostic report for all sub-agents. Subagent reporting configuration is unused. The final diagnostic details are already persisted inside the Diagnostic resource instead. */ fullReport?: boolean | null; /** @@ -5780,7 +6142,7 @@ export namespace contactcenterinsights_v1 { */ metricType?: string | null; /** - * Optional. The configuration for the output of the task. + * Optional. Deprecated: The configuration for the output of the task. The export destination is unused. Detailed markdown and conversation slices are already persisted inside the Diagnostic resource instead. */ outputConfig?: Schema$GoogleCloudContactcenterinsightsV1OutputConfig; /** @@ -5805,19 +6167,19 @@ export namespace contactcenterinsights_v1 { */ export interface Schema$GoogleCloudContactcenterinsightsV1DiagnoseConversationsResponse { /** - * Output only. The final, high-level answer or diagnostic summary returned by the Sherlock worker. + * Output only. Deprecated: Output only. The final, high-level answer or diagnostic summary returned by the Sherlock worker is deprecated. The persistent analysis summary is stored inside the Diagnostic resource instead. */ answer?: string | null; /** - * Output only. If an external destination was requested, the URI of the exported data. + * Output only. Deprecated: Output only. If an external destination was requested, the URI of the exported data is deprecated. The persistent diagnostic details are stored inside the Diagnostic resource instead. */ exportUri?: string | null; /** - * Output only. Deprecated: Use full_trajectory_steps instead. The complete sequence of thoughts and actions (full trajectory). + * Output only. Deprecated: Use full_trajectory_steps instead. Output only. The complete sequence of thoughts and actions (full trajectory). */ fullTrajectories?: string[] | null; /** - * Output only. The complete sequence of thoughts and actions taken by the agent. + * Output only. Deprecated: Output only. The complete sequence of thoughts and actions taken by the agent is deprecated under LRO response completions. Use the persistent details inside the Diagnostic resource instead. */ fullTrajectorySteps?: Schema$GoogleCloudContactcenterinsightsV1SherlockStep[]; } @@ -5851,7 +6213,15 @@ export namespace contactcenterinsights_v1 { */ export interface Schema$GoogleCloudContactcenterinsightsV1DiagnosticReport { /** - * Output only. A breakdown of metrics grouped by intent. + * Output only. A map of conversation slices used in the report. + */ + conversationSlices?: { + [ + key: string + ]: Schema$GoogleCloudContactcenterinsightsV1DiagnosticReportConversationSlice; + } | null; + /** + * Output only. Deprecated: Intent breakdowns are no longer used. */ intentStats?: Schema$GoogleCloudContactcenterinsightsV1DiagnosticReportIntentStats[]; /** @@ -5864,6 +6234,19 @@ export namespace contactcenterinsights_v1 { metrics?: { [key: string]: Schema$GoogleCloudContactcenterinsightsV1MetricValue; } | null; + /** + * Output only. The final report in markdown format. + */ + report?: string | null; + } + /** + * Output only. A map of conversation slices used in the report. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1DiagnosticReportConversationSlice { + /** + * The list of conversation IDs that match this slice. + */ + conversationIds?: string[] | null; } /** * A breakdown of metrics grouped by intent. @@ -7469,6 +7852,10 @@ export namespace contactcenterinsights_v1 { * Output only. The unique identifier for the loss pattern. */ id?: string | null; + /** + * Output only. A list of links to conversations or bot instructions. + */ + links?: Schema$GoogleCloudContactcenterinsightsV1LossPatternLink[]; /** * Output only. The percentage of conversations that match this loss pattern. */ @@ -7478,6 +7865,61 @@ export namespace contactcenterinsights_v1 { */ suggestedFixes?: string | null; } + /** + * A link to a conversation or bot instruction. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1LossPatternLink { + /** + * A link to a bot instruction. + */ + botInstructionLink?: Schema$GoogleCloudContactcenterinsightsV1LossPatternLinkBotInstructionLink; + /** + * A link to a conversation. + */ + conversationLink?: Schema$GoogleCloudContactcenterinsightsV1LossPatternLinkConversationLink; + /** + * The end byte index of the highlighted text (exclusive). + */ + endByteIndex?: number | null; + /** + * The text that is highlighted. (populated for debugging purposes) + */ + highlightedText?: string | null; + /** + * The location type. + */ + locationType?: string | null; + /** + * The start byte index of the highlighted text (inclusive). + */ + startByteIndex?: number | null; + } + /** + * A link to a bot instruction. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1LossPatternLinkBotInstructionLink { + /** + * The exclusive end line number of the instructions. + */ + endLine?: number | null; + /** + * The inclusive start line number of the instructions. + */ + startLine?: number | null; + /** + * The name of the subagent. + */ + subagent?: string | null; + } + /** + * A link to a conversation. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1LossPatternLinkConversationLink { + /** + * The conversation ID. + */ + conversationId?: string | null; + } /** * The analysis resource. */ @@ -8763,7 +9205,7 @@ export namespace contactcenterinsights_v1 { */ metricType?: string | null; /** - * Output only. Deprecated: Use partial_trajectory_steps instead. The intermediate trajectory updates (partial trajectory). + * Output only. Deprecated: Use partial_trajectory_steps instead. Output only. The intermediate trajectory updates (partial trajectory). */ partialTrajectories?: string[] | null; /** @@ -8780,7 +9222,7 @@ export namespace contactcenterinsights_v1 { */ export interface Schema$GoogleCloudContactcenterinsightsV1mainDiagnoseConversationsRequest { /** - * Optional. If true, the request will be validated and a simulation of the analysis will be performed without actually executing the task. + * Optional. Deprecated: If true, the request will be validated and a simulation of the analysis will be performed without actually executing the task. This field is unused. Use validate_only instead. */ dryRun?: boolean | null; /** @@ -8788,7 +9230,7 @@ export namespace contactcenterinsights_v1 { */ filter?: string | null; /** - * Optional. If true, the agent will generate a full diagnostic report for all sub-agents. + * Optional. Deprecated: If true, the agent will generate a full diagnostic report for all sub-agents. Subagent reporting configuration is unused. The final diagnostic details are already persisted inside the Diagnostic resource instead. */ fullReport?: boolean | null; /** @@ -8804,7 +9246,7 @@ export namespace contactcenterinsights_v1 { */ metricType?: string | null; /** - * Optional. The configuration for the output of the task. + * Optional. Deprecated: The configuration for the output of the task. The export destination is unused. Detailed markdown and conversation slices are already persisted inside the Diagnostic resource instead. */ outputConfig?: Schema$GoogleCloudContactcenterinsightsV1mainOutputConfig; /** @@ -8829,19 +9271,19 @@ export namespace contactcenterinsights_v1 { */ export interface Schema$GoogleCloudContactcenterinsightsV1mainDiagnoseConversationsResponse { /** - * Output only. The final, high-level answer or diagnostic summary returned by the Sherlock worker. + * Output only. Deprecated: Output only. The final, high-level answer or diagnostic summary returned by the Sherlock worker is deprecated. The persistent analysis summary is stored inside the Diagnostic resource instead. */ answer?: string | null; /** - * Output only. If an external destination was requested, the URI of the exported data. + * Output only. Deprecated: Output only. If an external destination was requested, the URI of the exported data is deprecated. The persistent diagnostic details are stored inside the Diagnostic resource instead. */ exportUri?: string | null; /** - * Output only. Deprecated: Use full_trajectory_steps instead. The complete sequence of thoughts and actions (full trajectory). + * Output only. Deprecated: Use full_trajectory_steps instead. Output only. The complete sequence of thoughts and actions (full trajectory). */ fullTrajectories?: string[] | null; /** - * Output only. The complete sequence of thoughts and actions taken by the agent. + * Output only. Deprecated: Output only. The complete sequence of thoughts and actions taken by the agent is deprecated under LRO response completions. Use the persistent details inside the Diagnostic resource instead. */ fullTrajectorySteps?: Schema$GoogleCloudContactcenterinsightsV1mainSherlockStep[]; } @@ -8850,7 +9292,15 @@ export namespace contactcenterinsights_v1 { */ export interface Schema$GoogleCloudContactcenterinsightsV1mainDiagnosticReport { /** - * Output only. A breakdown of metrics grouped by intent. + * Output only. A map of conversation slices used in the report. + */ + conversationSlices?: { + [ + key: string + ]: Schema$GoogleCloudContactcenterinsightsV1mainDiagnosticReportConversationSlice; + } | null; + /** + * Output only. Deprecated: Intent breakdowns are no longer used. */ intentStats?: Schema$GoogleCloudContactcenterinsightsV1mainDiagnosticReportIntentStats[]; /** @@ -8863,6 +9313,19 @@ export namespace contactcenterinsights_v1 { metrics?: { [key: string]: Schema$GoogleCloudContactcenterinsightsV1mainMetricValue; } | null; + /** + * Output only. The final report in markdown format. + */ + report?: string | null; + } + /** + * Output only. A map of conversation slices used in the report. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1mainDiagnosticReportConversationSlice { + /** + * The list of conversation IDs that match this slice. + */ + conversationIds?: string[] | null; } /** * A breakdown of metrics grouped by intent. @@ -10020,6 +10483,10 @@ export namespace contactcenterinsights_v1 { * Output only. The unique identifier for the loss pattern. */ id?: string | null; + /** + * Output only. A list of links to conversations or bot instructions. + */ + links?: Schema$GoogleCloudContactcenterinsightsV1mainLossPatternLink[]; /** * Output only. The percentage of conversations that match this loss pattern. */ @@ -10029,6 +10496,61 @@ export namespace contactcenterinsights_v1 { */ suggestedFixes?: string | null; } + /** + * A link to a conversation or bot instruction. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1mainLossPatternLink { + /** + * A link to a bot instruction. + */ + botInstructionLink?: Schema$GoogleCloudContactcenterinsightsV1mainLossPatternLinkBotInstructionLink; + /** + * A link to a conversation. + */ + conversationLink?: Schema$GoogleCloudContactcenterinsightsV1mainLossPatternLinkConversationLink; + /** + * The end byte index of the highlighted text (exclusive). + */ + endByteIndex?: number | null; + /** + * The text that is highlighted. (populated for debugging purposes) + */ + highlightedText?: string | null; + /** + * The location type. + */ + locationType?: string | null; + /** + * The start byte index of the highlighted text (inclusive). + */ + startByteIndex?: number | null; + } + /** + * A link to a bot instruction. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1mainLossPatternLinkBotInstructionLink { + /** + * The exclusive end line number of the instructions. + */ + endLine?: number | null; + /** + * The inclusive start line number of the instructions. + */ + startLine?: number | null; + /** + * The name of the subagent. + */ + subagent?: string | null; + } + /** + * A link to a conversation. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1mainLossPatternLinkConversationLink { + /** + * The conversation ID. + */ + conversationId?: string | null; + } /** * Deprecated: MetricValue is no longer used for diagnostics. */ @@ -10889,19 +11411,35 @@ export namespace contactcenterinsights_v1 { */ export interface Schema$GoogleCloudContactcenterinsightsV1mainSherlockStep { /** - * Output only. Natural language input stimulus. + * Output only. The ID of the agent that produced/received this content. + */ + agentId?: string | null; + /** + * Output only. The content of the turn (either Model or User role). + */ + content?: Schema$GoogleCloudAiplatformV1Content; + /** + * Output only. List of state changes caused by this specific turn. + */ + stateDeltas?: Array<{[key: string]: any}> | null; + /** + * Output only. Unique ID for this specific turn. + */ + stepId?: string | null; + /** + * Output only. Deprecated: Use content instead. */ textInput?: string[] | null; /** - * Output only. The reasoning or internal monologue of the agent. + * Output only. Deprecated: Use content instead. */ thought?: string | null; /** - * Output only. The tool call issued by the agent. + * Output only. Deprecated: Use content instead. */ toolCalls?: Schema$GoogleCloudContactcenterinsightsV1mainToolCall[]; /** - * Output only. The output response from the tool execution. + * Output only. Deprecated: Use content instead. */ toolOutput?: {[key: string]: any} | null; } @@ -12286,6 +12824,10 @@ export namespace contactcenterinsights_v1 { * The redirect action to be taken when the chart is clicked. */ export interface Schema$GoogleCloudContactcenterinsightsV1RedirectAction { + /** + * The query params to be added to the redirect path. + */ + queryParams?: {[key: string]: string} | null; /** * The relative path to redirect to. */ @@ -12586,19 +13128,35 @@ export namespace contactcenterinsights_v1 { */ export interface Schema$GoogleCloudContactcenterinsightsV1SherlockStep { /** - * Output only. Natural language input stimulus. + * Output only. The ID of the agent that produced/received this content. + */ + agentId?: string | null; + /** + * Output only. The content of the turn (either Model or User role). + */ + content?: Schema$GoogleCloudAiplatformV1Content; + /** + * Output only. List of state changes caused by this specific turn. + */ + stateDeltas?: Array<{[key: string]: any}> | null; + /** + * Output only. Unique ID for this specific turn. + */ + stepId?: string | null; + /** + * Output only. Deprecated: Use content instead. */ textInput?: string[] | null; /** - * Output only. The reasoning or internal monologue of the agent. + * Output only. Deprecated: Use content instead. */ thought?: string | null; /** - * Output only. The tool call issued by the agent. + * Output only. Deprecated: Use content instead. */ toolCalls?: Schema$GoogleCloudContactcenterinsightsV1ToolCall[]; /** - * Output only. The output response from the tool execution. + * Output only. Deprecated: Use content instead. */ toolOutput?: {[key: string]: any} | null; } diff --git a/src/apis/datamigration/v1.ts b/src/apis/datamigration/v1.ts index d041bc28f6f..bf777ca62e3 100644 --- a/src/apis/datamigration/v1.ts +++ b/src/apis/datamigration/v1.ts @@ -2547,7 +2547,7 @@ export namespace datamigration_v1 { */ export interface Schema$QuotaFailureViolation { /** - * The API Service from which the `QuotaFailure.Violation` orginates. In some cases, Quota issues originate from an API Service other than the one that was called. In other words, a dependency of the called API Service could be the cause of the `QuotaFailure`, and this field would have the dependency API service name. For example, if the called API is Kubernetes Engine API (container.googleapis.com), and a quota violation occurs in the Kubernetes Engine API itself, this field would be "container.googleapis.com". On the other hand, if the quota violation occurs when the Kubernetes Engine API creates VMs in the Compute Engine API (compute.googleapis.com), this field would be "compute.googleapis.com". + * The API Service from which the `QuotaFailure.Violation` originates. In some cases, Quota issues originate from an API Service other than the one that was called. In other words, a dependency of the called API Service could be the cause of the `QuotaFailure`, and this field would have the dependency API service name. For example, if the called API is Kubernetes Engine API (container.googleapis.com), and a quota violation occurs in the Kubernetes Engine API itself, this field would be "container.googleapis.com". On the other hand, if the quota violation occurs when the Kubernetes Engine API creates VMs in the Compute Engine API (compute.googleapis.com), this field would be "compute.googleapis.com". */ apiService?: string | null; /** @@ -3891,7 +3891,7 @@ export namespace datamigration_v1 { } /** - * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. + * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. * @example * ```js * // Before running the sample: @@ -3921,7 +3921,7 @@ export namespace datamigration_v1 { * * // Do the magic * const res = await datamigration.projects.locations.list({ - * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -4062,7 +4062,7 @@ export namespace datamigration_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/datamigration/v1beta1.ts b/src/apis/datamigration/v1beta1.ts index f1408eb09dc..58fefb15a16 100644 --- a/src/apis/datamigration/v1beta1.ts +++ b/src/apis/datamigration/v1beta1.ts @@ -795,7 +795,7 @@ export namespace datamigration_v1beta1 { */ export interface Schema$QuotaFailureViolation { /** - * The API Service from which the `QuotaFailure.Violation` orginates. In some cases, Quota issues originate from an API Service other than the one that was called. In other words, a dependency of the called API Service could be the cause of the `QuotaFailure`, and this field would have the dependency API service name. For example, if the called API is Kubernetes Engine API (container.googleapis.com), and a quota violation occurs in the Kubernetes Engine API itself, this field would be "container.googleapis.com". On the other hand, if the quota violation occurs when the Kubernetes Engine API creates VMs in the Compute Engine API (compute.googleapis.com), this field would be "compute.googleapis.com". + * The API Service from which the `QuotaFailure.Violation` originates. In some cases, Quota issues originate from an API Service other than the one that was called. In other words, a dependency of the called API Service could be the cause of the `QuotaFailure`, and this field would have the dependency API service name. For example, if the called API is Kubernetes Engine API (container.googleapis.com), and a quota violation occurs in the Kubernetes Engine API itself, this field would be "container.googleapis.com". On the other hand, if the quota violation occurs when the Kubernetes Engine API creates VMs in the Compute Engine API (compute.googleapis.com), this field would be "compute.googleapis.com". */ apiService?: string | null; /** @@ -1237,7 +1237,7 @@ export namespace datamigration_v1beta1 { } /** - * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. + * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. * @example * ```js * // Before running the sample: @@ -1267,7 +1267,7 @@ export namespace datamigration_v1beta1 { * * // Do the magic * const res = await datamigration.projects.locations.list({ - * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -1394,7 +1394,7 @@ export namespace datamigration_v1beta1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/dataplex/v1.ts b/src/apis/dataplex/v1.ts index a5a14910b95..92635c0cde7 100644 --- a/src/apis/dataplex/v1.ts +++ b/src/apis/dataplex/v1.ts @@ -762,6 +762,208 @@ export namespace dataplex_v1 { * Cancel metadata job request. */ export interface Schema$GoogleCloudDataplexV1CancelMetadataJobRequest {} + /** + * Represents a proposed change to a metadata resource. + */ + export interface Schema$GoogleCloudDataplexV1ChangeRequest { + /** + * Output only. The email address of the user who approved/rejected the ChangeRequest. + */ + approver?: string | null; + /** + * Output only. The email address of the user who created the ChangeRequest. + */ + author?: string | null; + /** + * Output only. The type of change represented by the change_payload. This field is derived from the populated field in the change_payload oneof. + */ + changeType?: string | null; + /** + * Payload for creating an Entry. + */ + createEntry?: Schema$GoogleCloudDataplexV1CreateEntryRequest; + /** + * Payload for creating an EntryLink. + */ + createEntryLink?: Schema$GoogleCloudDataplexV1CreateEntryLinkRequest; + /** + * Payload for creating a Glossary. + */ + createGlossary?: Schema$GoogleCloudDataplexV1CreateGlossaryRequest; + /** + * Payload for creating a GlossaryCategory. + */ + createGlossaryCategory?: Schema$GoogleCloudDataplexV1CreateGlossaryCategoryRequest; + /** + * Payload for creating a GlossaryTerm. + */ + createGlossaryTerm?: Schema$GoogleCloudDataplexV1CreateGlossaryTermRequest; + /** + * Output only. The time when the ChangeRequest was created. + */ + createTime?: string | null; + /** + * Payload for deleting an Entry. + */ + deleteEntry?: Schema$GoogleCloudDataplexV1DeleteEntryRequest; + /** + * Payload for deleting an EntryLink. + */ + deleteEntryLink?: Schema$GoogleCloudDataplexV1DeleteEntryLinkRequest; + /** + * Payload for deleting a Glossary. + */ + deleteGlossary?: Schema$GoogleCloudDataplexV1DeleteGlossaryRequest; + /** + * Payload for deleting a GlossaryCategory. + */ + deleteGlossaryCategory?: Schema$GoogleCloudDataplexV1DeleteGlossaryCategoryRequest; + /** + * Payload for deleting a GlossaryTerm. + */ + deleteGlossaryTerm?: Schema$GoogleCloudDataplexV1DeleteGlossaryTermRequest; + /** + * Optional. This checksum is computed by the service. It can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. + */ + etag?: string | null; + /** + * Optional. Justification of the ChangeRequest. This should explain why the change is needed or why it should be approved. + */ + justification?: string | null; + /** + * Optional. User-defined labels for the ChangeRequest. + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. The relative resource name of the ChangeRequest, of the form: projects/{project_number\}/locations/{location_id\}/changeRequests/{change_request_id\} + */ + name?: string | null; + /** + * Output only. The reason provided for rejecting the ChangeRequest. + */ + rejectionComment?: string | null; + /** + * Output only. The full resource name of the target resource to be modified. Example: //dataplex.googleapis.com/projects/my-project/locations/us-central1/entryGroups/my-group/entries/my-entry + */ + resource?: string | null; + /** + * Output only. The current state of the ChangeRequest. + */ + state?: string | null; + /** + * Output only. System generated globally unique ID for the ChangeRequest. + */ + uid?: string | null; + /** + * Payload for updating an Entry. + */ + updateEntry?: Schema$GoogleCloudDataplexV1UpdateEntryRequest; + /** + * Payload for updating a Glossary. + */ + updateGlossary?: Schema$GoogleCloudDataplexV1UpdateGlossaryRequest; + /** + * Payload for updating a GlossaryCategory. + */ + updateGlossaryCategory?: Schema$GoogleCloudDataplexV1UpdateGlossaryCategoryRequest; + /** + * Payload for updating a GlossaryTerm. + */ + updateGlossaryTerm?: Schema$GoogleCloudDataplexV1UpdateGlossaryTermRequest; + /** + * Output only. The time when the ChangeRequest was last updated. + */ + updateTime?: string | null; + } + /** + * Request message for CreateEntryLink. + */ + export interface Schema$GoogleCloudDataplexV1CreateEntryLinkRequest { + /** + * Required. Entry Link resource. + */ + entryLink?: Schema$GoogleCloudDataplexV1EntryLink; + /** + * Required. Entry Link identifier * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the EntryGroup. + */ + entryLinkId?: string | null; + /** + * Required. The resource name of the parent Entry Group: projects/{project_id_or_number\}/locations/{location_id\}/entryGroups/{entry_group_id\}. + */ + parent?: string | null; + } + /** + * Create Entry request. + */ + export interface Schema$GoogleCloudDataplexV1CreateEntryRequest { + /** + * Required. Entry resource. + */ + entry?: Schema$GoogleCloudDataplexV1Entry; + /** + * Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud.The maximum size of the field is 4000 characters. + */ + entryId?: string | null; + /** + * Required. The resource name of the parent Entry Group: projects/{project\}/locations/{location\}/entryGroups/{entry_group\}. + */ + parent?: string | null; + } + /** + * Creates a new GlossaryCategory under the specified Glossary. + */ + export interface Schema$GoogleCloudDataplexV1CreateGlossaryCategoryRequest { + /** + * Required. The GlossaryCategory to create. + */ + category?: Schema$GoogleCloudDataplexV1GlossaryCategory; + /** + * Required. GlossaryCategory identifier. + */ + categoryId?: string | null; + /** + * Required. The parent resource where this GlossaryCategory will be created. Format: projects/{project_id_or_number\}/locations/{location_id\}/glossaries/{glossary_id\} where locationId refers to a Google Cloud region. + */ + parent?: string | null; + } + /** + * Create Glossary Request + */ + export interface Schema$GoogleCloudDataplexV1CreateGlossaryRequest { + /** + * Required. The Glossary to create. + */ + glossary?: Schema$GoogleCloudDataplexV1Glossary; + /** + * Required. Glossary ID: Glossary identifier. + */ + glossaryId?: string | null; + /** + * Required. The parent resource where this Glossary will be created. Format: projects/{project_id_or_number\}/locations/{location_id\} where location_id refers to a Google Cloud region. + */ + parent?: string | null; + /** + * Optional. Validates the request without actually creating the Glossary. Default: false. + */ + validateOnly?: boolean | null; + } + /** + * Creates a new GlossaryTerm under the specified Glossary. + */ + export interface Schema$GoogleCloudDataplexV1CreateGlossaryTermRequest { + /** + * Required. The parent resource where the GlossaryTerm will be created. Format: projects/{project_id_or_number\}/locations/{location_id\}/glossaries/{glossary_id\} where location_id refers to a Google Cloud region. + */ + parent?: string | null; + /** + * Required. The GlossaryTerm to create. + */ + term?: Schema$GoogleCloudDataplexV1GlossaryTerm; + /** + * Required. GlossaryTerm identifier. + */ + termId?: string | null; + } /** * DataAccessSpec holds the access control configuration to be enforced on data stored within resources (eg: rows, columns in BigQuery Tables). When associated with data, the data is only accessible to principals explicitly granted access through the DataAccessSpec. Principals with access to the containing resource are not implicitly granted access. */ @@ -1252,6 +1454,10 @@ export namespace dataplex_v1 { * A data product is a curated collection of data assets, packaged to address specific use cases. It's a way to manage and share data in a more organized, product-like manner. */ export interface Schema$GoogleCloudDataplexV1DataProduct { + /** + * Optional. Configuration for access approval for the data product. + */ + accessApprovalConfig?: Schema$GoogleCloudDataplexV1DataProductAccessApprovalConfig; /** * Optional. Data product access groups by access group id as key. If data product is used only for packaging data assets, then access groups may be empty. However, if a data product is used for sharing data assets, then at least one access group must be specified.Example: { "analyst": { "id": "analyst", "displayName": "Analyst", "description": "Access group for analysts", "principal": { "googleGroup": "analysts@example.com" \} \} \} */ @@ -1303,6 +1509,15 @@ export namespace dataplex_v1 { */ updateTime?: string | null; } + /** + * Configuration for access approval for the data product. + */ + export interface Schema$GoogleCloudDataplexV1DataProductAccessApprovalConfig { + /** + * Optional. Specifies the email addresses of users who are potential approvers and are notified when an access request is made for the data product. The maximum number of emails allowed is 10. + */ + approverEmails?: string[] | null; + } /** * Custom user defined access groups at the data product level. These are used for granting different levels of access (IAM roles) on the individual data product's data assets. */ @@ -1332,6 +1547,10 @@ export namespace dataplex_v1 { * Optional. Email of the Google Group, as per https://cloud.google.com/iam/docs/principals-overview#google-group. */ googleGroup?: string | null; + /** + * Optional. Specifies the email of the producer service account, as per https://cloud.google.com/iam/docs/principals-overview#service-account. + */ + serviceAccount?: string | null; } /** * DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. @@ -2700,6 +2919,55 @@ export namespace dataplex_v1 { */ updateTime?: string | null; } + /** + * Request message for DeleteEntryLink. + */ + export interface Schema$GoogleCloudDataplexV1DeleteEntryLinkRequest { + /** + * Required. The resource name of the Entry Link: projects/{project_id_or_number\}/locations/{location_id\}/entryGroups/{entry_group_id\}/entryLinks/{entry_link_id\}. + */ + name?: string | null; + } + /** + * Delete Entry request. + */ + export interface Schema$GoogleCloudDataplexV1DeleteEntryRequest { + /** + * Required. The resource name of the Entry: projects/{project\}/locations/{location\}/entryGroups/{entry_group\}/entries/{entry\}. + */ + name?: string | null; + } + /** + * Delete GlossaryCategory Request + */ + export interface Schema$GoogleCloudDataplexV1DeleteGlossaryCategoryRequest { + /** + * Required. The name of the GlossaryCategory to delete. Format: projects/{project_id_or_number\}/locations/{location_id\}/glossaries/{glossary_id\}/categories/{category_id\} + */ + name?: string | null; + } + /** + * Delete Glossary Request + */ + export interface Schema$GoogleCloudDataplexV1DeleteGlossaryRequest { + /** + * Optional. The etag of the Glossary. If this is provided, it must match the server's etag. If the etag is provided and does not match the server-computed etag, the request must fail with a ABORTED error code. + */ + etag?: string | null; + /** + * Required. The name of the Glossary to delete. Format: projects/{project_id_or_number\}/locations/{location_id\}/glossaries/{glossary_id\} + */ + name?: string | null; + } + /** + * Delete GlossaryTerm Request + */ + export interface Schema$GoogleCloudDataplexV1DeleteGlossaryTermRequest { + /** + * Required. The name of the GlossaryTerm to delete. Format: projects/{project_id_or_number\}/locations/{location_id\}/glossaries/{glossary_id\}/terms/{term_id\} + */ + name?: string | null; + } /** * The payload associated with Discovery data processing. */ @@ -4037,6 +4305,10 @@ export namespace dataplex_v1 { * Lookup Context using permissions in the source system. */ export interface Schema$GoogleCloudDataplexV1LookupContextRequest { + /** + * Optional. The text representing contextual information for which metadata context is being requested. + */ + context?: string | null; /** * Optional. Allows to configure the context.Supported options: format - The format of the context (one of yaml, xml, json, default is yaml). context_budget - If provided, the output will be intelligently truncated on a best-effort basis to contain approximately the desired amount of characters. There is no guarantee to achieve the specific amount. */ @@ -4434,6 +4706,28 @@ export namespace dataplex_v1 { */ values?: string[] | null; } + /** + * Message for requesting access to a Data Product. + */ + export interface Schema$GoogleCloudDataplexV1RequestDataProductAccessRequest { + /** + * Required. The change request for the data product access request. + */ + changeRequest?: Schema$GoogleCloudDataplexV1ChangeRequest; + /** + * Optional. Validates the request without actually creating the access change request. Defaults to false. + */ + validateOnly?: boolean | null; + } + /** + * Response message for requesting access to a Data Product. + */ + export interface Schema$GoogleCloudDataplexV1RequestDataProductAccessResponse { + /** + * The resource name of the created ChangeRequest. Format: projects/{project_number\}/locations/{location_id\}/changeRequests/{change_request_id\} + */ + changeRequestName?: string | null; + } /** * ResourceAccessSpec holds the access control configuration to be enforced on the resources, for example, Cloud Storage bucket, BigQuery dataset, BigQuery table. */ @@ -5034,6 +5328,74 @@ export namespace dataplex_v1 { */ cron?: string | null; } + /** + * Update Entry request. + */ + export interface Schema$GoogleCloudDataplexV1UpdateEntryRequest { + /** + * Optional. If set to true and the entry doesn't exist, the service will create it. + */ + allowMissing?: boolean | null; + /** + * Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. @* - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request. + */ + aspectKeys?: string[] | null; + /** + * Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request. + */ + deleteMissingAspects?: boolean | null; + /** + * Required. Entry resource. + */ + entry?: Schema$GoogleCloudDataplexV1Entry; + /** + * Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".If the update_mask is empty, the service will update all modifiable fields present in the request. + */ + updateMask?: string | null; + } + /** + * Update GlossaryCategory Request + */ + export interface Schema$GoogleCloudDataplexV1UpdateGlossaryCategoryRequest { + /** + * Required. The GlossaryCategory to update. The GlossaryCategory's name field is used to identify the GlossaryCategory to update. Format: projects/{project_id_or_number\}/locations/{location_id\}/glossaries/{glossary_id\}/categories/{category_id\} + */ + category?: Schema$GoogleCloudDataplexV1GlossaryCategory; + /** + * Required. The list of fields to update. + */ + updateMask?: string | null; + } + /** + * Update Glossary Request + */ + export interface Schema$GoogleCloudDataplexV1UpdateGlossaryRequest { + /** + * Required. The Glossary to update. The Glossary's name field is used to identify the Glossary to update. Format: projects/{project_id_or_number\}/locations/{location_id\}/glossaries/{glossary_id\} + */ + glossary?: Schema$GoogleCloudDataplexV1Glossary; + /** + * Required. The list of fields to update. + */ + updateMask?: string | null; + /** + * Optional. Validates the request without actually updating the Glossary. Default: false. + */ + validateOnly?: boolean | null; + } + /** + * Update GlossaryTerm Request + */ + export interface Schema$GoogleCloudDataplexV1UpdateGlossaryTermRequest { + /** + * Required. The GlossaryTerm to update. The GlossaryTerm's name field is used to identify the GlossaryTerm to update. Format: projects/{project_id_or_number\}/locations/{location_id\}/glossaries/{glossary_id\}/terms/{term_id\} + */ + term?: Schema$GoogleCloudDataplexV1GlossaryTerm; + /** + * Required. The list of fields to update. + */ + updateMask?: string | null; + } /** * A zone represents a logical group of related assets within a lake. A zone can be used to map to organizational structure or represent stages of data readiness from raw to curated. It provides managing behavior that is shared or inherited by all contained assets. */ @@ -7828,6 +8190,7 @@ export namespace dataplex_v1 { * requestBody: { * // request body parameters * // { + * // "context": "my_context", * // "options": {}, * // "resources": [] * // } @@ -12568,6 +12931,7 @@ export namespace dataplex_v1 { * requestBody: { * // request body parameters * // { + * // "accessApprovalConfig": {}, * // "accessGroups": {}, * // "assetCount": 0, * // "createTime": "my_createTime", @@ -12886,6 +13250,7 @@ export namespace dataplex_v1 { * * // Example response * // { + * // "accessApprovalConfig": {}, * // "accessGroups": {}, * // "assetCount": 0, * // "createTime": "my_createTime", @@ -13359,6 +13724,7 @@ export namespace dataplex_v1 { * requestBody: { * // request body parameters * // { + * // "accessApprovalConfig": {}, * // "accessGroups": {}, * // "assetCount": 0, * // "createTime": "my_createTime", @@ -13482,6 +13848,167 @@ export namespace dataplex_v1 { } } + /** + * Requests access to a data product. This will trigger an access approval workflow, and the requester will need to wait for the approval to be granted before they will be able to access the data product assets. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataplex.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataplex = google.dataplex('v1'); + * + * async function main() { + * const auth = new google.auth.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/dataplex.read-write', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataplex.projects.locations.dataProducts.requestAccess({ + * // Required. The resource name of the data product. Format: projects/{project_number\}/locations/{location_id\}/dataProducts/{data_product_id\} + * parent: + * 'projects/my-project/locations/my-location/dataProducts/my-dataProduct', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "changeRequest": {}, + * // "validateOnly": false + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "changeRequestName": "my_changeRequestName" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + requestAccess( + params: Params$Resource$Projects$Locations$Dataproducts$Requestaccess, + options: StreamMethodOptions + ): Promise>; + requestAccess( + params?: Params$Resource$Projects$Locations$Dataproducts$Requestaccess, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + requestAccess( + params: Params$Resource$Projects$Locations$Dataproducts$Requestaccess, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + requestAccess( + params: Params$Resource$Projects$Locations$Dataproducts$Requestaccess, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + requestAccess( + params: Params$Resource$Projects$Locations$Dataproducts$Requestaccess, + callback: BodyResponseCallback + ): void; + requestAccess( + callback: BodyResponseCallback + ): void; + requestAccess( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Dataproducts$Requestaccess + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Dataproducts$Requestaccess; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Dataproducts$Requestaccess; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}:requestAccess').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 + ); + } + } + /** * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. * @example @@ -13891,6 +14418,17 @@ export namespace dataplex_v1 { */ requestBody?: Schema$GoogleCloudDataplexV1DataProduct; } + export interface Params$Resource$Projects$Locations$Dataproducts$Requestaccess extends StandardParameters { + /** + * Required. The resource name of the data product. Format: projects/{project_number\}/locations/{location_id\}/dataProducts/{data_product_id\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1RequestDataProductAccessRequest; + } export interface Params$Resource$Projects$Locations$Dataproducts$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. @@ -14844,7 +15382,7 @@ export namespace dataplex_v1 { * * // Do the magic * const res = await dataplex.projects.locations.dataScans.create({ - * // Required. DataScan identifier. Must contain only lowercase letters, numbers and hyphens. Must start with a letter. Must end with a number or a letter. Must be between 1-63 characters. Must be unique within the customer project / location. + * // Optional. DataScan identifier. If not provided, a unique ID will be generated with the prefix "data-scan-". Must contain only lowercase letters, numbers and hyphens. Must start with a letter. Must end with a number or a letter. Must be between 1-63 characters. Must be unique within the customer project / location. * dataScanId: 'placeholder-value', * // Required. The resource name of the parent location: projects/{project\}/locations/{location_id\} where project refers to a project_id or project_number and location_id refers to a Google Cloud region. * parent: 'projects/my-project/locations/my-location', @@ -16419,7 +16957,7 @@ export namespace dataplex_v1 { export interface Params$Resource$Projects$Locations$Datascans$Create extends StandardParameters { /** - * Required. DataScan identifier. Must contain only lowercase letters, numbers and hyphens. Must start with a letter. Must end with a number or a letter. Must be between 1-63 characters. Must be unique within the customer project / location. + * Optional. DataScan identifier. If not provided, a unique ID will be generated with the prefix "data-scan-". Must contain only lowercase letters, numbers and hyphens. Must start with a letter. Must end with a number or a letter. Must be between 1-63 characters. Must be unique within the customer project / location. */ dataScanId?: string; /** diff --git a/src/apis/datastream/v1.ts b/src/apis/datastream/v1.ts index dc64296872e..09717012d8d 100644 --- a/src/apis/datastream/v1.ts +++ b/src/apis/datastream/v1.ts @@ -2288,6 +2288,15 @@ export namespace datastream_v1 { */ sqlServerIdentifier?: Schema$SqlServerObjectIdentifier; } + /** + * Represents a position in a Spanner change stream from which to start replicating. + */ + export interface Schema$SpannerChangeStreamPosition { + /** + * Required. The timestamp to start change stream queries from. The timestamp must be a positive value. + */ + startTime?: string | null; + } /** * Spanner column. */ @@ -2427,6 +2436,10 @@ export namespace datastream_v1 { * Oracle SCN to start replicating from. */ oracleScnPosition?: Schema$OracleScnPosition; + /** + * Optional. Spanner change stream position to start replicating from. + */ + spannerChangeStreamPosition?: Schema$SpannerChangeStreamPosition; /** * SqlServer LSN to start replicating from. */ diff --git a/src/apis/developerknowledge/v1.ts b/src/apis/developerknowledge/v1.ts index 51fe8173f7d..bd4b3ed94ca 100644 --- a/src/apis/developerknowledge/v1.ts +++ b/src/apis/developerknowledge/v1.ts @@ -242,7 +242,7 @@ export namespace developerknowledge_v1 { * * // Do the magic * const res = await developerknowledge.documents.batchGet({ - * // Required. Specifies the names of the documents to retrieve. A maximum of 20 documents can be retrieved in a batch. The documents are returned in the same order as the `names` in the request. Format: `documents/{uri_without_scheme\}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` + * // Required. Specifies the names of the documents to retrieve. A maximum of 20 documents can be retrieved in a batch. The documents are returned in the same order as the `names` in the request. Format: `documents/{uri_without_scheme\}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` If you are changing the batch size, consider the value of `maxConcurrentGCSFetches` constant in the service implementation: http://cs///depot/google3/devrel/boq/developerknowledge/service/developerknowledge.go * names: 'placeholder-value', * // Optional. Specifies the DocumentView of the document. If unspecified, DeveloperKnowledge.BatchGetDocuments defaults to `DOCUMENT_VIEW_CONTENT`. * view: 'placeholder-value', @@ -652,7 +652,7 @@ export namespace developerknowledge_v1 { export interface Params$Resource$Documents$Batchget extends StandardParameters { /** - * Required. Specifies the names of the documents to retrieve. A maximum of 20 documents can be retrieved in a batch. The documents are returned in the same order as the `names` in the request. Format: `documents/{uri_without_scheme\}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` + * Required. Specifies the names of the documents to retrieve. A maximum of 20 documents can be retrieved in a batch. The documents are returned in the same order as the `names` in the request. Format: `documents/{uri_without_scheme\}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` If you are changing the batch size, consider the value of `maxConcurrentGCSFetches` constant in the service implementation: http://cs///depot/google3/devrel/boq/developerknowledge/service/developerknowledge.go */ names?: string[]; /** diff --git a/src/apis/developerknowledge/v1alpha.ts b/src/apis/developerknowledge/v1alpha.ts index b9bc9c0be7b..9402943efc4 100644 --- a/src/apis/developerknowledge/v1alpha.ts +++ b/src/apis/developerknowledge/v1alpha.ts @@ -131,7 +131,7 @@ export namespace developerknowledge_v1alpha { */ export interface Schema$Answer { /** - * The text of the answer. + * Contains the text of the answer. */ answerText?: string | null; } @@ -271,7 +271,7 @@ export namespace developerknowledge_v1alpha { * * // Do the magic * const res = await developerknowledge.documents.batchGet({ - * // Required. Specifies the names of the documents to retrieve. A maximum of 20 documents can be retrieved in a batch. The documents are returned in the same order as the `names` in the request. Format: `documents/{uri_without_scheme\}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` + * // Required. Specifies the names of the documents to retrieve. A maximum of 20 documents can be retrieved in a batch. The documents are returned in the same order as the `names` in the request. Format: `documents/{uri_without_scheme\}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` If you are changing the batch size, consider the value of `maxConcurrentGCSFetches` constant in the service implementation: http://cs///depot/google3/devrel/boq/developerknowledge/service/developerknowledge.go * names: 'placeholder-value', * // Optional. Specifies the DocumentView of the document. If unspecified, DeveloperKnowledge.BatchGetDocuments defaults to `DOCUMENT_VIEW_CONTENT`. * view: 'placeholder-value', @@ -681,7 +681,7 @@ export namespace developerknowledge_v1alpha { export interface Params$Resource$Documents$Batchget extends StandardParameters { /** - * Required. Specifies the names of the documents to retrieve. A maximum of 20 documents can be retrieved in a batch. The documents are returned in the same order as the `names` in the request. Format: `documents/{uri_without_scheme\}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` + * Required. Specifies the names of the documents to retrieve. A maximum of 20 documents can be retrieved in a batch. The documents are returned in the same order as the `names` in the request. Format: `documents/{uri_without_scheme\}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` If you are changing the batch size, consider the value of `maxConcurrentGCSFetches` constant in the service implementation: http://cs///depot/google3/devrel/boq/developerknowledge/service/developerknowledge.go */ names?: string[]; /** diff --git a/src/apis/discoveryengine/v1.ts b/src/apis/discoveryengine/v1.ts index 2312c8611f0..a3877e11ac2 100644 --- a/src/apis/discoveryengine/v1.ts +++ b/src/apis/discoveryengine/v1.ts @@ -2912,6 +2912,10 @@ export namespace discoveryengine_v1 { * Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. */ connectorModes?: string[] | null; + /** + * Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source. + */ + connectorSourceId?: string | null; /** * Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system. */ @@ -3842,7 +3846,7 @@ export namespace discoveryengine_v1 { */ displayName?: string | null; /** - * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` + * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` */ features?: {[key: string]: string} | null; /** @@ -5101,6 +5105,10 @@ export namespace discoveryengine_v1 { * Defines a user inputed query. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaQuery { + /** + * Output only. The time at which the server accepted this query. + */ + createTime?: string | null; /** * Query content parts. */ @@ -6149,6 +6157,10 @@ export namespace discoveryengine_v1 { * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` */ name?: string | null; + /** + * Output only. Full resource name of an in-progress AsyncAssist operation for this session, e.g. `projects/x/locations/x/collections/x/engines/x/sessions/x/operations/x`. Set when the operation starts and cleared when it finishes. + */ + pendingAsyncAssistOperationId?: string | null; /** * Output only. The time the session started. */ @@ -8949,7 +8961,7 @@ export namespace discoveryengine_v1 { */ displayName?: string | null; /** - * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` + * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` */ features?: {[key: string]: string} | null; /** @@ -11967,6 +11979,10 @@ export namespace discoveryengine_v1 { * Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. */ connectorModes?: string[] | null; + /** + * Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source. + */ + connectorSourceId?: string | null; /** * Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system. */ @@ -12983,7 +12999,7 @@ export namespace discoveryengine_v1 { */ displayName?: string | null; /** - * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` + * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` */ features?: {[key: string]: string} | null; /** @@ -14007,6 +14023,19 @@ export namespace discoveryengine_v1 { */ nextPageToken?: string | null; } + /** + * Response message for LicenseConfigService.ListLicenseConfigs method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsResponse { + /** + * All the customer's LicenseConfigs. + */ + licenseConfigs?: Schema$GoogleCloudDiscoveryengineV1LicenseConfig[]; + /** + * Not supported. + */ + nextPageToken?: string | null; + } /** * Response message for UserLicenseService.ListLicenseConfigsUsageStats method. */ @@ -15976,6 +16005,10 @@ export namespace discoveryengine_v1 { * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` */ name?: string | null; + /** + * Output only. Full resource name of an in-progress AsyncAssist operation for this session, e.g. `projects/x/locations/x/collections/x/engines/x/sessions/x/operations/x`. Set when the operation starts and cleared when it finishes. + */ + pendingAsyncAssistOperationId?: string | null; /** * Output only. The time the session started. */ @@ -17114,7 +17147,7 @@ export namespace discoveryengine_v1 { */ enableVisualContentSummary?: boolean | null; /** - * Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` + * Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` */ features?: {[key: string]: string} | null; /** @@ -18632,6 +18665,7 @@ export namespace discoveryengine_v1 { * // "blockingReasons": [], * // "cliConfig": {}, * // "connectorModes": [], + * // "connectorSourceId": "my_connectorSourceId", * // "connectorType": "my_connectorType", * // "createEuaSaas": false, * // "createTime": "my_createTime", @@ -20055,6 +20089,7 @@ export namespace discoveryengine_v1 { * // "blockingReasons": [], * // "cliConfig": {}, * // "connectorModes": [], + * // "connectorSourceId": "my_connectorSourceId", * // "connectorType": "my_connectorType", * // "createEuaSaas": false, * // "createTime": "my_createTime", @@ -20251,6 +20286,7 @@ export namespace discoveryengine_v1 { * // "blockingReasons": [], * // "cliConfig": {}, * // "connectorModes": [], + * // "connectorSourceId": "my_connectorSourceId", * // "connectorType": "my_connectorType", * // "createEuaSaas": false, * // "createTime": "my_createTime", @@ -20301,6 +20337,7 @@ export namespace discoveryengine_v1 { * // "blockingReasons": [], * // "cliConfig": {}, * // "connectorModes": [], + * // "connectorSourceId": "my_connectorSourceId", * // "connectorType": "my_connectorType", * // "createEuaSaas": false, * // "createTime": "my_createTime", @@ -31214,6 +31251,7 @@ export namespace discoveryengine_v1 { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -31231,6 +31269,7 @@ export namespace discoveryengine_v1 { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -31540,6 +31579,7 @@ export namespace discoveryengine_v1 { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -31870,6 +31910,7 @@ export namespace discoveryengine_v1 { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -31887,6 +31928,7 @@ export namespace discoveryengine_v1 { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -38065,7 +38107,7 @@ export namespace discoveryengine_v1 { } /** - * Sets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.user` and `roles/discoveryengine.agentspaceUser`. Attempting to grant any other role will result in a warning in logging. + * Sets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.admin`, `roles/discoveryengine.agentspaceAdmin`, `roles/discoveryengine.user`, `roles/discoveryengine.agentspaceUser`, `roles/discoveryengine.viewer`, `roles/discoveryengine.agentspaceViewer`. Attempting to grant any other role will result in a warning in logging. * @example * ```js * // Before running the sample: @@ -46037,6 +46079,7 @@ export namespace discoveryengine_v1 { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -46054,6 +46097,7 @@ export namespace discoveryengine_v1 { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -46361,6 +46405,7 @@ export namespace discoveryengine_v1 { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -46689,6 +46734,7 @@ export namespace discoveryengine_v1 { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -46706,6 +46752,7 @@ export namespace discoveryengine_v1 { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -57282,6 +57329,7 @@ export namespace discoveryengine_v1 { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -57298,6 +57346,7 @@ export namespace discoveryengine_v1 { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -57602,6 +57651,7 @@ export namespace discoveryengine_v1 { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -57930,6 +57980,7 @@ export namespace discoveryengine_v1 { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -57946,6 +57997,7 @@ export namespace discoveryengine_v1 { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -64077,6 +64129,165 @@ export namespace discoveryengine_v1 { } } + /** + * Lists all the LicenseConfigs associated with the project. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await discoveryengine.projects.locations.licenseConfigs.list({ + * // Optional. The filter to apply to the list results. The supported fields are: * `subscription_tier` * `state` Examples: * `subscription_tier=SUBSCRIPTION_TIER_SEARCH,state=ACTIVE` - Lists all active search license configs. * `state=ACTIVE` - Lists all active license configs. The filter string should be a comma-separated list of field=value pairs. + * filter: 'placeholder-value', + * // Optional. Not supported. + * pageSize: 'placeholder-value', + * // Optional. Not supported. + * pageToken: 'placeholder-value', + * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "licenseConfigs": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Licenseconfigs$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Licenseconfigs$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Licenseconfigs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Licenseconfigs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Licenseconfigs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Licenseconfigs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Licenseconfigs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Licenseconfigs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/licenseConfigs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Updates the LicenseConfig * @example @@ -64280,6 +64491,24 @@ export namespace discoveryengine_v1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Licenseconfigs$List extends StandardParameters { + /** + * Optional. The filter to apply to the list results. The supported fields are: * `subscription_tier` * `state` Examples: * `subscription_tier=SUBSCRIPTION_TIER_SEARCH,state=ACTIVE` - Lists all active search license configs. * `state=ACTIVE` - Lists all active license configs. The filter string should be a comma-separated list of field=value pairs. + */ + filter?: string; + /** + * Optional. Not supported. + */ + pageSize?: number; + /** + * Optional. Not supported. + */ + pageToken?: string; + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}`. + */ + parent?: string; + } export interface Params$Resource$Projects$Locations$Licenseconfigs$Patch extends StandardParameters { /** * Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project\}/locations/{location\}/licenseConfigs/{license_config\}` diff --git a/src/apis/discoveryengine/v1alpha.ts b/src/apis/discoveryengine/v1alpha.ts index 68d54f82e9e..f273be62fb2 100644 --- a/src/apis/discoveryengine/v1alpha.ts +++ b/src/apis/discoveryengine/v1alpha.ts @@ -4155,6 +4155,10 @@ export namespace discoveryengine_v1alpha { * Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. */ connectorModes?: string[] | null; + /** + * Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source. + */ + connectorSourceId?: string | null; /** * Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system. */ @@ -5288,7 +5292,7 @@ export namespace discoveryengine_v1alpha { */ displayName?: string | null; /** - * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` + * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` */ features?: {[key: string]: string} | null; /** @@ -7068,6 +7072,19 @@ export namespace discoveryengine_v1alpha { */ nextPageToken?: string | null; } + /** + * Response message for LicenseConfigService.ListLicenseConfigs method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaListLicenseConfigsResponse { + /** + * All the customer's LicenseConfigs. + */ + licenseConfigs?: Schema$GoogleCloudDiscoveryengineV1alphaLicenseConfig[]; + /** + * Not supported. + */ + nextPageToken?: string | null; + } /** * Response message for UserLicenseService.ListLicenseConfigsUsageStats method. */ @@ -7835,6 +7852,10 @@ export namespace discoveryengine_v1alpha { * Defines a user inputed query. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaQuery { + /** + * Output only. The time at which the server accepted this query. + */ + createTime?: string | null; /** * Query content parts. */ @@ -10087,6 +10108,10 @@ export namespace discoveryengine_v1alpha { * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` */ name?: string | null; + /** + * Output only. Full resource name of an in-progress AsyncAssist operation for this session, e.g. `projects/x/locations/x/collections/x/engines/x/sessions/x/operations/x`. Set when the operation starts and cleared when it finishes. + */ + pendingAsyncAssistOperationId?: string | null; /** * Output only. The time the session started. */ @@ -11432,7 +11457,7 @@ export namespace discoveryengine_v1alpha { */ enableVisualContentSummary?: boolean | null; /** - * Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` + * Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` */ features?: {[key: string]: string} | null; /** @@ -12756,7 +12781,7 @@ export namespace discoveryengine_v1alpha { */ displayName?: string | null; /** - * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` + * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` */ features?: {[key: string]: string} | null; /** @@ -15135,6 +15160,10 @@ export namespace discoveryengine_v1alpha { * Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. */ connectorModes?: string[] | null; + /** + * Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source. + */ + connectorSourceId?: string | null; /** * Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system. */ @@ -15966,7 +15995,7 @@ export namespace discoveryengine_v1alpha { */ displayName?: string | null; /** - * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` + * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` */ features?: {[key: string]: string} | null; /** @@ -21209,6 +21238,7 @@ export namespace discoveryengine_v1alpha { * // "blockingReasons": [], * // "cliConfig": {}, * // "connectorModes": [], + * // "connectorSourceId": "my_connectorSourceId", * // "connectorType": "my_connectorType", * // "createEuaSaas": false, * // "createTime": "my_createTime", @@ -23727,6 +23757,7 @@ export namespace discoveryengine_v1alpha { * // "blockingReasons": [], * // "cliConfig": {}, * // "connectorModes": [], + * // "connectorSourceId": "my_connectorSourceId", * // "connectorType": "my_connectorType", * // "createEuaSaas": false, * // "createTime": "my_createTime", @@ -24243,6 +24274,7 @@ export namespace discoveryengine_v1alpha { * // "blockingReasons": [], * // "cliConfig": {}, * // "connectorModes": [], + * // "connectorSourceId": "my_connectorSourceId", * // "connectorType": "my_connectorType", * // "createEuaSaas": false, * // "createTime": "my_createTime", @@ -24294,6 +24326,7 @@ export namespace discoveryengine_v1alpha { * // "blockingReasons": [], * // "cliConfig": {}, * // "connectorModes": [], + * // "connectorSourceId": "my_connectorSourceId", * // "connectorType": "my_connectorType", * // "createEuaSaas": false, * // "createTime": "my_createTime", @@ -38121,6 +38154,7 @@ export namespace discoveryengine_v1alpha { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -38138,6 +38172,7 @@ export namespace discoveryengine_v1alpha { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -38447,6 +38482,7 @@ export namespace discoveryengine_v1alpha { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -38777,6 +38813,7 @@ export namespace discoveryengine_v1alpha { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -38794,6 +38831,7 @@ export namespace discoveryengine_v1alpha { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -45848,7 +45886,7 @@ export namespace discoveryengine_v1alpha { } /** - * Sets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.user` and `roles/discoveryengine.agentspaceUser`. Attempting to grant any other role will result in a warning in logging. + * Sets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.admin`, `roles/discoveryengine.agentspaceAdmin`, `roles/discoveryengine.user`, `roles/discoveryengine.agentspaceUser`, `roles/discoveryengine.viewer`, `roles/discoveryengine.agentspaceViewer`. Attempting to grant any other role will result in a warning in logging. * @example * ```js * // Before running the sample: @@ -54902,6 +54940,7 @@ export namespace discoveryengine_v1alpha { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -54919,6 +54958,7 @@ export namespace discoveryengine_v1alpha { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -55226,6 +55266,7 @@ export namespace discoveryengine_v1alpha { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -55554,6 +55595,7 @@ export namespace discoveryengine_v1alpha { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -55571,6 +55613,7 @@ export namespace discoveryengine_v1alpha { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -68662,6 +68705,7 @@ export namespace discoveryengine_v1alpha { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -68678,6 +68722,7 @@ export namespace discoveryengine_v1alpha { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -68982,6 +69027,7 @@ export namespace discoveryengine_v1alpha { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -69310,6 +69356,7 @@ export namespace discoveryengine_v1alpha { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -69326,6 +69373,7 @@ export namespace discoveryengine_v1alpha { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -76322,6 +76370,165 @@ export namespace discoveryengine_v1alpha { } } + /** + * Lists all the LicenseConfigs associated with the project. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await discoveryengine.projects.locations.licenseConfigs.list({ + * // Optional. The filter to apply to the list results. The supported fields are: * `subscription_tier` * `state` Examples: * `subscription_tier=SUBSCRIPTION_TIER_SEARCH,state=ACTIVE` - Lists all active search license configs. * `state=ACTIVE` - Lists all active license configs. The filter string should be a comma-separated list of field=value pairs. + * filter: 'placeholder-value', + * // Optional. Not supported. + * pageSize: 'placeholder-value', + * // Optional. Not supported. + * pageToken: 'placeholder-value', + * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "licenseConfigs": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Licenseconfigs$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Licenseconfigs$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Licenseconfigs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Licenseconfigs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Licenseconfigs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Licenseconfigs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Licenseconfigs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Licenseconfigs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/licenseConfigs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Updates the LicenseConfig * @example @@ -76527,6 +76734,24 @@ export namespace discoveryengine_v1alpha { */ name?: string; } + export interface Params$Resource$Projects$Locations$Licenseconfigs$List extends StandardParameters { + /** + * Optional. The filter to apply to the list results. The supported fields are: * `subscription_tier` * `state` Examples: * `subscription_tier=SUBSCRIPTION_TIER_SEARCH,state=ACTIVE` - Lists all active search license configs. * `state=ACTIVE` - Lists all active license configs. The filter string should be a comma-separated list of field=value pairs. + */ + filter?: string; + /** + * Optional. Not supported. + */ + pageSize?: number; + /** + * Optional. Not supported. + */ + pageToken?: string; + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}`. + */ + parent?: string; + } export interface Params$Resource$Projects$Locations$Licenseconfigs$Patch extends StandardParameters { /** * Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project\}/locations/{location\}/licenseConfigs/{license_config\}` diff --git a/src/apis/discoveryengine/v1beta.ts b/src/apis/discoveryengine/v1beta.ts index f9cc93b1a9a..34b364e30aa 100644 --- a/src/apis/discoveryengine/v1beta.ts +++ b/src/apis/discoveryengine/v1beta.ts @@ -2041,6 +2041,10 @@ export namespace discoveryengine_v1beta { * Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. */ connectorModes?: string[] | null; + /** + * Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source. + */ + connectorSourceId?: string | null; /** * Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system. */ @@ -2971,7 +2975,7 @@ export namespace discoveryengine_v1beta { */ displayName?: string | null; /** - * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` + * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` */ features?: {[key: string]: string} | null; /** @@ -4230,6 +4234,10 @@ export namespace discoveryengine_v1beta { * Defines a user inputed query. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaQuery { + /** + * Output only. The time at which the server accepted this query. + */ + createTime?: string | null; /** * Query content parts. */ @@ -5278,6 +5286,10 @@ export namespace discoveryengine_v1beta { * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` */ name?: string | null; + /** + * Output only. Full resource name of an in-progress AsyncAssist operation for this session, e.g. `projects/x/locations/x/collections/x/engines/x/sessions/x/operations/x`. Set when the operation starts and cleared when it finishes. + */ + pendingAsyncAssistOperationId?: string | null; /** * Output only. The time the session started. */ @@ -9396,7 +9408,7 @@ export namespace discoveryengine_v1beta { */ displayName?: string | null; /** - * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` + * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` */ features?: {[key: string]: string} | null; /** @@ -10594,6 +10606,19 @@ export namespace discoveryengine_v1beta { */ nextPageToken?: string | null; } + /** + * Response message for LicenseConfigService.ListLicenseConfigs method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsResponse { + /** + * All the customer's LicenseConfigs. + */ + licenseConfigs?: Schema$GoogleCloudDiscoveryengineV1betaLicenseConfig[]; + /** + * Not supported. + */ + nextPageToken?: string | null; + } /** * Response message for UserLicenseService.ListLicenseConfigsUsageStats method. */ @@ -13043,6 +13068,10 @@ export namespace discoveryengine_v1beta { * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` */ name?: string | null; + /** + * Output only. Full resource name of an in-progress AsyncAssist operation for this session, e.g. `projects/x/locations/x/collections/x/engines/x/sessions/x/operations/x`. Set when the operation starts and cleared when it finishes. + */ + pendingAsyncAssistOperationId?: string | null; /** * Output only. The time the session started. */ @@ -14135,6 +14164,10 @@ export namespace discoveryengine_v1beta { * Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. */ connectorModes?: string[] | null; + /** + * Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source. + */ + connectorSourceId?: string | null; /** * Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system. */ @@ -14966,7 +14999,7 @@ export namespace discoveryengine_v1beta { */ displayName?: string | null; /** - * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` + * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` */ features?: {[key: string]: string} | null; /** @@ -29717,6 +29750,7 @@ export namespace discoveryengine_v1beta { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -29734,6 +29768,7 @@ export namespace discoveryengine_v1beta { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -30043,6 +30078,7 @@ export namespace discoveryengine_v1beta { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -30373,6 +30409,7 @@ export namespace discoveryengine_v1beta { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -30390,6 +30427,7 @@ export namespace discoveryengine_v1beta { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -36462,7 +36500,7 @@ export namespace discoveryengine_v1beta { } /** - * Sets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.user` and `roles/discoveryengine.agentspaceUser`. Attempting to grant any other role will result in a warning in logging. + * Sets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.admin`, `roles/discoveryengine.agentspaceAdmin`, `roles/discoveryengine.user`, `roles/discoveryengine.agentspaceUser`, `roles/discoveryengine.viewer`, `roles/discoveryengine.agentspaceViewer`. Attempting to grant any other role will result in a warning in logging. * @example * ```js * // Before running the sample: @@ -42905,6 +42943,7 @@ export namespace discoveryengine_v1beta { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -42922,6 +42961,7 @@ export namespace discoveryengine_v1beta { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -43229,6 +43269,7 @@ export namespace discoveryengine_v1beta { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -43557,6 +43598,7 @@ export namespace discoveryengine_v1beta { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -43574,6 +43616,7 @@ export namespace discoveryengine_v1beta { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -53718,6 +53761,7 @@ export namespace discoveryengine_v1beta { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -53734,6 +53778,7 @@ export namespace discoveryengine_v1beta { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -54038,6 +54083,7 @@ export namespace discoveryengine_v1beta { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -54366,6 +54412,7 @@ export namespace discoveryengine_v1beta { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -54382,6 +54429,7 @@ export namespace discoveryengine_v1beta { * // "isPinned": false, * // "labels": [], * // "name": "my_name", + * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId", * // "startTime": "my_startTime", * // "state": "my_state", * // "turns": [], @@ -60907,6 +60955,165 @@ export namespace discoveryengine_v1beta { } } + /** + * Lists all the LicenseConfigs associated with the project. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1beta'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await discoveryengine.projects.locations.licenseConfigs.list({ + * // Optional. The filter to apply to the list results. The supported fields are: * `subscription_tier` * `state` Examples: * `subscription_tier=SUBSCRIPTION_TIER_SEARCH,state=ACTIVE` - Lists all active search license configs. * `state=ACTIVE` - Lists all active license configs. The filter string should be a comma-separated list of field=value pairs. + * filter: 'placeholder-value', + * // Optional. Not supported. + * pageSize: 'placeholder-value', + * // Optional. Not supported. + * pageToken: 'placeholder-value', + * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "licenseConfigs": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Licenseconfigs$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Licenseconfigs$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Licenseconfigs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Licenseconfigs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Licenseconfigs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Licenseconfigs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Licenseconfigs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Licenseconfigs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/licenseConfigs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Updates the LicenseConfig * @example @@ -61110,6 +61317,24 @@ export namespace discoveryengine_v1beta { */ name?: string; } + export interface Params$Resource$Projects$Locations$Licenseconfigs$List extends StandardParameters { + /** + * Optional. The filter to apply to the list results. The supported fields are: * `subscription_tier` * `state` Examples: * `subscription_tier=SUBSCRIPTION_TIER_SEARCH,state=ACTIVE` - Lists all active search license configs. * `state=ACTIVE` - Lists all active license configs. The filter string should be a comma-separated list of field=value pairs. + */ + filter?: string; + /** + * Optional. Not supported. + */ + pageSize?: number; + /** + * Optional. Not supported. + */ + pageToken?: string; + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}`. + */ + parent?: string; + } export interface Params$Resource$Projects$Locations$Licenseconfigs$Patch extends StandardParameters { /** * Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project\}/locations/{location\}/licenseConfigs/{license_config\}` diff --git a/src/apis/dlp/v2.ts b/src/apis/dlp/v2.ts index 544a530bd59..1c9cba11edb 100644 --- a/src/apis/dlp/v2.ts +++ b/src/apis/dlp/v2.ts @@ -3330,6 +3330,10 @@ export namespace dlp_v2 { * The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. */ export interface Schema$GooglePrivacyDlpV2InspectTemplate { + /** + * Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + */ + allowLimitedAvailabilityInfoTypes?: boolean | null; /** * Output only. The creation timestamp of an inspectTemplate. */ @@ -7053,6 +7057,7 @@ export namespace dlp_v2 { * * // Example response * // { + * // "allowLimitedAvailabilityInfoTypes": false, * // "createTime": "my_createTime", * // "description": "my_description", * // "displayName": "my_displayName", @@ -7337,6 +7342,7 @@ export namespace dlp_v2 { * * // Example response * // { + * // "allowLimitedAvailabilityInfoTypes": false, * // "createTime": "my_createTime", * // "description": "my_description", * // "displayName": "my_displayName", @@ -7651,6 +7657,7 @@ export namespace dlp_v2 { * * // Example response * // { + * // "allowLimitedAvailabilityInfoTypes": false, * // "createTime": "my_createTime", * // "description": "my_description", * // "displayName": "my_displayName", @@ -11795,6 +11802,7 @@ export namespace dlp_v2 { * * // Example response * // { + * // "allowLimitedAvailabilityInfoTypes": false, * // "createTime": "my_createTime", * // "description": "my_description", * // "displayName": "my_displayName", @@ -12081,6 +12089,7 @@ export namespace dlp_v2 { * * // Example response * // { + * // "allowLimitedAvailabilityInfoTypes": false, * // "createTime": "my_createTime", * // "description": "my_description", * // "displayName": "my_displayName", @@ -12397,6 +12406,7 @@ export namespace dlp_v2 { * * // Example response * // { + * // "allowLimitedAvailabilityInfoTypes": false, * // "createTime": "my_createTime", * // "description": "my_description", * // "displayName": "my_displayName", @@ -18302,6 +18312,7 @@ export namespace dlp_v2 { * * // Example response * // { + * // "allowLimitedAvailabilityInfoTypes": false, * // "createTime": "my_createTime", * // "description": "my_description", * // "displayName": "my_displayName", @@ -18586,6 +18597,7 @@ export namespace dlp_v2 { * * // Example response * // { + * // "allowLimitedAvailabilityInfoTypes": false, * // "createTime": "my_createTime", * // "description": "my_description", * // "displayName": "my_displayName", @@ -18900,6 +18912,7 @@ export namespace dlp_v2 { * * // Example response * // { + * // "allowLimitedAvailabilityInfoTypes": false, * // "createTime": "my_createTime", * // "description": "my_description", * // "displayName": "my_displayName", @@ -25673,6 +25686,7 @@ export namespace dlp_v2 { * * // Example response * // { + * // "allowLimitedAvailabilityInfoTypes": false, * // "createTime": "my_createTime", * // "description": "my_description", * // "displayName": "my_displayName", @@ -25959,6 +25973,7 @@ export namespace dlp_v2 { * * // Example response * // { + * // "allowLimitedAvailabilityInfoTypes": false, * // "createTime": "my_createTime", * // "description": "my_description", * // "displayName": "my_displayName", @@ -26273,6 +26288,7 @@ export namespace dlp_v2 { * * // Example response * // { + * // "allowLimitedAvailabilityInfoTypes": false, * // "createTime": "my_createTime", * // "description": "my_description", * // "displayName": "my_displayName", diff --git a/src/apis/documentai/v1.ts b/src/apis/documentai/v1.ts index 705b4500c91..77a5fc86d3d 100644 --- a/src/apis/documentai/v1.ts +++ b/src/apis/documentai/v1.ts @@ -2624,6 +2624,10 @@ export namespace documentai_v1 { * Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. */ export interface Schema$GoogleCloudDocumentaiV1Document { + /** + * Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id. + */ + blobAssets?: Schema$GoogleCloudDocumentaiV1DocumentBlobAsset[]; /** * Document chunked based on chunking config. */ @@ -2697,6 +2701,32 @@ export namespace documentai_v1 { */ uri?: string | null; } + /** + * Represents the annotation of a block or a chunk. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentAnnotations { + /** + * The description of the content with this annotation. + */ + description?: string | null; + } + /** + * Represents a blob asset. It's used to store the content of the inline blob in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentBlobAsset { + /** + * Optional. The id of the blob asset. + */ + assetId?: string | null; + /** + * Optional. The content of the blob asset, for example, image bytes. + */ + content?: string | null; + /** + * The mime type of the blob asset. An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). + */ + mimeType?: string | null; + } /** * Represents the chunks that the document is divided into. */ @@ -2710,6 +2740,10 @@ export namespace documentai_v1 { * Represents a chunk. */ export interface Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk { + /** + * Chunk fields inside this chunk. + */ + chunkFields?: Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkField[]; /** * ID of the chunk. */ @@ -2735,6 +2769,19 @@ export namespace documentai_v1 { */ sourceBlockIds?: string[] | null; } + /** + * The chunk field in the chunk. A chunk field could be one of the various types (for example, image, table) supported. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkField { + /** + * The image chunk field in the chunk. + */ + imageChunkField?: Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkImageChunkField; + /** + * The table chunk field in the chunk. + */ + tableChunkField?: Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkTableChunkField; + } /** * Represents the page footer associated with the chunk. */ @@ -2774,6 +2821,36 @@ export namespace documentai_v1 { */ pageStart?: number | null; } + /** + * The image chunk field in the chunk. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkImageChunkField { + /** + * Annotation of the image chunk field. + */ + annotations?: Schema$GoogleCloudDocumentaiV1DocumentAnnotations; + /** + * Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. + */ + blobAssetId?: string | null; + /** + * Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + */ + dataUri?: string | null; + /** + * Optional. Google Cloud Storage uri of the image. + */ + gcsUri?: string | null; + } + /** + * The table chunk field in the chunk. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkTableChunkField { + /** + * Annotation of the table chunk field. + */ + annotations?: Schema$GoogleCloudDocumentaiV1DocumentAnnotations; + } /** * Represents the parsed layout of a document as a collection of blocks that the document is divided into. */ @@ -2795,6 +2872,10 @@ export namespace documentai_v1 { * Identifies the bounding box for the block. */ boundingBox?: Schema$GoogleCloudDocumentaiV1BoundingPoly; + /** + * Block consisting of image content. + */ + imageBlock?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutImageBlock; /** * Block consisting of list content/structure. */ @@ -2812,6 +2893,35 @@ export namespace documentai_v1 { */ textBlock?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock; } + /** + * Represents an image type block. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutImageBlock { + /** + * Annotation of the image block. + */ + annotations?: Schema$GoogleCloudDocumentaiV1DocumentAnnotations; + /** + * Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. + */ + blobAssetId?: string | null; + /** + * Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + */ + dataUri?: string | null; + /** + * Optional. Google Cloud Storage uri of the image. + */ + gcsUri?: string | null; + /** + * Text extracted from the image using OCR or alt text describing the image. + */ + imageText?: string | null; + /** + * Mime type of the image. An IANA published [media type (MIME type)] (https://www.iana.org/assignments/media-types/media-types.xhtml). + */ + mimeType?: string | null; + } /** * Represents a list type block. */ @@ -2851,6 +2961,10 @@ export namespace documentai_v1 { * Represents a table type block. */ export interface Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock { + /** + * Annotation of the table block. + */ + annotations?: Schema$GoogleCloudDocumentaiV1DocumentAnnotations; /** * Body rows containing main table content. */ @@ -2894,6 +3008,10 @@ export namespace documentai_v1 { * Represents a text type block. */ export interface Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock { + /** + * Annotation of the text block. + */ + annotations?: Schema$GoogleCloudDocumentaiV1DocumentAnnotations; /** * A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks. */ @@ -5842,7 +5960,7 @@ export namespace documentai_v1 { } /** - * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. + * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. * @example * ```js * // Before running the sample: @@ -5872,7 +5990,7 @@ export namespace documentai_v1 { * * // Do the magic * const res = await documentai.projects.locations.list({ - * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -6012,7 +6130,7 @@ export namespace documentai_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/documentai/v1beta3.ts b/src/apis/documentai/v1beta3.ts index 596e4af5492..78b60e95b94 100644 --- a/src/apis/documentai/v1beta3.ts +++ b/src/apis/documentai/v1beta3.ts @@ -5684,7 +5684,7 @@ export namespace documentai_v1beta3 { } /** - * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. + * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. * @example * ```js * // Before running the sample: @@ -5714,7 +5714,7 @@ export namespace documentai_v1beta3 { * * // Do the magic * const res = await documentai.projects.locations.list({ - * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -5854,7 +5854,7 @@ export namespace documentai_v1beta3 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/eventarc/v1.ts b/src/apis/eventarc/v1.ts index b25d2d96693..a00ef464b89 100644 --- a/src/apis/eventarc/v1.ts +++ b/src/apis/eventarc/v1.ts @@ -5994,9 +5994,9 @@ export namespace eventarc_v1 { * * // Do the magic * const res = await eventarc.projects.locations.googleApiSources.delete({ - * // Optional. If set to true, and the MessageBus is not found, the request will succeed but no action will be taken on the server. + * // Optional. If set to true, and the GoogleApiSource is not found, the request will succeed but no action will be taken on the server. * allowMissing: 'placeholder-value', - * // Optional. If provided, the MessageBus will only be deleted if the etag matches the current etag on the resource. + * // Optional. If provided, the GoogleApiSource will only be deleted if the etag matches the current etag on the resource. * etag: 'placeholder-value', * // Required. The name of the GoogleApiSource to be deleted. * name: 'projects/my-project/locations/my-location/googleApiSources/my-googleApiSource', @@ -7049,11 +7049,11 @@ export namespace eventarc_v1 { } export interface Params$Resource$Projects$Locations$Googleapisources$Delete extends StandardParameters { /** - * Optional. If set to true, and the MessageBus is not found, the request will succeed but no action will be taken on the server. + * Optional. If set to true, and the GoogleApiSource is not found, the request will succeed but no action will be taken on the server. */ allowMissing?: boolean; /** - * Optional. If provided, the MessageBus will only be deleted if the etag matches the current etag on the resource. + * Optional. If provided, the GoogleApiSource will only be deleted if the etag matches the current etag on the resource. */ etag?: string; /** diff --git a/src/apis/firebaseappdistribution/v1.ts b/src/apis/firebaseappdistribution/v1.ts index 714b1ab095a..28be754874a 100644 --- a/src/apis/firebaseappdistribution/v1.ts +++ b/src/apis/firebaseappdistribution/v1.ts @@ -447,6 +447,10 @@ export namespace firebaseappdistribution_v1 { * Scotty-provided SHA256 hash for an upload. */ sha256Hash?: string | null; + /** + * Scotty-provided SHA512 hash for an upload. + */ + sha512Hash?: string | null; /** * Time at which the media data was last updated, in milliseconds since UNIX epoch */ diff --git a/src/apis/firebaseapphosting/v1.ts b/src/apis/firebaseapphosting/v1.ts index a5278a87d94..c2e5f26574e 100644 --- a/src/apis/firebaseapphosting/v1.ts +++ b/src/apis/firebaseapphosting/v1.ts @@ -984,7 +984,7 @@ export namespace firebaseapphosting_v1 { */ ignoredPaths?: Schema$Path[]; /** - * Optional. A list of file paths patterns that trigger a build and rollout if at least one of the changed files in the commit are present in this list. This field is optional; the rollout policy will default to triggering on all paths if not populated. Limited to 100 paths. Example: “required_paths: { pattern: "foo/bar/x” type: GLOB \} + * Optional. A list of file paths patterns that trigger a build and rollout if at least one of the changed files in the commit are present in this list. This field is optional; the rollout policy will default to triggering on all paths if both ignored_paths and required_paths are not populated. Limited to 100 paths. Example: “required_paths: { pattern: "foo/bar/x” type: GLOB \} */ requiredPaths?: Schema$Path[]; } diff --git a/src/apis/firebaseapphosting/v1beta.ts b/src/apis/firebaseapphosting/v1beta.ts index 0538c9094db..47262d909b7 100644 --- a/src/apis/firebaseapphosting/v1beta.ts +++ b/src/apis/firebaseapphosting/v1beta.ts @@ -1005,7 +1005,7 @@ export namespace firebaseapphosting_v1beta { */ ignoredPaths?: Schema$Path[]; /** - * Optional. A list of file paths patterns that trigger a build and rollout if at least one of the changed files in the commit are present in this list. This field is optional; the rollout policy will default to triggering on all paths if not populated. Limited to 100 paths. Example: “required_paths: { pattern: "foo/bar/x” type: GLOB \} + * Optional. A list of file paths patterns that trigger a build and rollout if at least one of the changed files in the commit are present in this list. This field is optional; the rollout policy will default to triggering on all paths if both ignored_paths and required_paths are not populated. Limited to 100 paths. Example: “required_paths: { pattern: "foo/bar/x” type: GLOB \} */ requiredPaths?: Schema$Path[]; } diff --git a/src/apis/firebaseml/v2beta.ts b/src/apis/firebaseml/v2beta.ts index 3a0eee6f0c8..287507cd9fb 100644 --- a/src/apis/firebaseml/v2beta.ts +++ b/src/apis/firebaseml/v2beta.ts @@ -581,6 +581,10 @@ export namespace firebaseml_v2beta { * Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. */ export interface Schema$GoogleCloudAiplatformV1beta1FunctionDeclaration { + /** + * Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + */ + behavior?: string | null; /** * Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. */ @@ -1867,6 +1871,10 @@ export namespace firebaseml_v2beta { * Tool to support computer use. */ export interface Schema$GoogleCloudAiplatformV1beta1ToolComputerUse { + /** + * Optional. Enables the prompt injection detection check on computer-use request. + */ + enablePromptInjectionDetection?: boolean | null; /** * Required. The environment being operated. */ diff --git a/src/apis/firestore/v1.ts b/src/apis/firestore/v1.ts index 1d977ac01c4..8134a2b3bf6 100644 --- a/src/apis/firestore/v1.ts +++ b/src/apis/firestore/v1.ts @@ -1249,7 +1249,7 @@ export namespace firestore_v1 { */ queryScope?: string | null; /** - * Optional. Options for search indexes that are at the index definition level. This field is only currently supported for indexes with MONGODB_COMPATIBLE_API ApiScope. + * Optional. Options for search indexes that are at the index definition level. */ searchIndexOptions?: Schema$GoogleFirestoreAdminV1SearchIndexOptions; /** @@ -1538,7 +1538,7 @@ export namespace firestore_v1 { */ export interface Schema$GoogleFirestoreAdminV1SearchGeoSpec { /** - * Optional. Disables geoJSON indexing for the field. By default, geoJSON points are indexed. + * Optional. Disables geoJSON indexing for the field. By default, geoJSON points are indexed. Firestore GeoPoints are indexed regardless of this value. */ geoJsonIndexingDisabled?: boolean | null; } @@ -1551,7 +1551,7 @@ export namespace firestore_v1 { */ textLanguage?: string | null; /** - * Optional. The field in the document that specifies which language to use for that specific document. For indexes with MONGODB_COMPATIBLE_API ApiScope: if unspecified, the language is taken from the "language" field if it exists or from `text_language` if it does not. + * Optional. The field in the document that specifies which language to use for that specific document. If unspecified, the language is taken from the "language" field if it exists or from `text_language` if it does not. */ textLanguageOverrideFieldPath?: string | null; } diff --git a/src/apis/gkehub/v1alpha.ts b/src/apis/gkehub/v1alpha.ts index 9c556dfc586..3c5590ad2c2 100644 --- a/src/apis/gkehub/v1alpha.ts +++ b/src/apis/gkehub/v1alpha.ts @@ -2726,6 +2726,23 @@ export namespace gkehub_v1alpha { */ response?: {[key: string]: any} | null; } + /** + * Operational state of the Rollout Sequence. + */ + export interface Schema$OperationalState { + /** + * Output only. Reasons for the Rollout Sequence state. + */ + reasons?: string[] | null; + /** + * Output only. State of the Rollout Sequence. + */ + state?: string | null; + /** + * Output only. The timestamp at which the operational state was last changed. Used to track how long it has been in the current state. + */ + stateChangeTime?: string | null; + } /** * Represents the metadata of the long-running operation. */ @@ -3271,13 +3288,13 @@ export namespace gkehub_v1alpha { */ name?: string | null; /** - * Required. Ordered list of stages that constitutes this Rollout. + * Output only. Operational state of the Rollout Sequence. */ - stages?: Schema$Stage[]; + operationalState?: Schema$OperationalState; /** - * Output only. State of the Rollout Sequence as a whole. + * Required. Ordered list of stages that constitutes this Rollout. */ - state?: Schema$RolloutSequenceState; + stages?: Schema$Stage[]; /** * Output only. Google-generated UUID for this resource. This is unique across all Rollout Sequence resources. If a Rollout Sequence resource is deleted and another resource with the same name is created, it gets a different uid. */ @@ -3287,23 +3304,6 @@ export namespace gkehub_v1alpha { */ updateTime?: string | null; } - /** - * State and reasons of the Rollout Sequence. - */ - export interface Schema$RolloutSequenceState { - /** - * Output only. The timestamp at which the LifecycleState was last changed. Used to track how long it has been in the current state. - */ - lastStateChangeTime?: string | null; - /** - * Output only. Lifecycle state of the Rollout Sequence. - */ - lifecycleState?: string | null; - /** - * Output only. StateReason represents the reason for the Rollout Sequence state. - */ - stateReasons?: string[] | null; - } /** * Stage represents a single stage in the Rollout. */ @@ -11716,8 +11716,8 @@ export namespace gkehub_v1alpha { * // "ignoredClustersSelector": {}, * // "labels": {}, * // "name": "my_name", + * // "operationalState": {}, * // "stages": [], - * // "state": {}, * // "uid": "my_uid", * // "updateTime": "my_updateTime" * // } @@ -12017,8 +12017,8 @@ export namespace gkehub_v1alpha { * // "ignoredClustersSelector": {}, * // "labels": {}, * // "name": "my_name", + * // "operationalState": {}, * // "stages": [], - * // "state": {}, * // "uid": "my_uid", * // "updateTime": "my_updateTime" * // } @@ -12315,8 +12315,8 @@ export namespace gkehub_v1alpha { * // "ignoredClustersSelector": {}, * // "labels": {}, * // "name": "my_name", + * // "operationalState": {}, * // "stages": [], - * // "state": {}, * // "uid": "my_uid", * // "updateTime": "my_updateTime" * // } diff --git a/src/apis/gkehub/v1beta.ts b/src/apis/gkehub/v1beta.ts index aa7f73c0b6d..028472735d2 100644 --- a/src/apis/gkehub/v1beta.ts +++ b/src/apis/gkehub/v1beta.ts @@ -2570,6 +2570,23 @@ export namespace gkehub_v1beta { */ response?: {[key: string]: any} | null; } + /** + * Operational state of the Rollout Sequence. + */ + export interface Schema$OperationalState { + /** + * Output only. Reasons for the Rollout Sequence state. + */ + reasons?: string[] | null; + /** + * Output only. State of the Rollout Sequence. + */ + state?: string | null; + /** + * Output only. The timestamp at which the operational state was last changed. Used to track how long it has been in the current state. + */ + stateChangeTime?: string | null; + } /** * Represents the metadata of the long-running operation. */ @@ -3115,13 +3132,13 @@ export namespace gkehub_v1beta { */ name?: string | null; /** - * Required. Ordered list of stages that constitutes this Rollout. + * Output only. Operational state of the Rollout Sequence. */ - stages?: Schema$Stage[]; + operationalState?: Schema$OperationalState; /** - * Output only. State of the Rollout Sequence as a whole. + * Required. Ordered list of stages that constitutes this Rollout. */ - state?: Schema$RolloutSequenceState; + stages?: Schema$Stage[]; /** * Output only. Google-generated UUID for this resource. This is unique across all Rollout Sequence resources. If a Rollout Sequence resource is deleted and another resource with the same name is created, it gets a different uid. */ @@ -3131,23 +3148,6 @@ export namespace gkehub_v1beta { */ updateTime?: string | null; } - /** - * State and reasons of the Rollout Sequence. - */ - export interface Schema$RolloutSequenceState { - /** - * Output only. The timestamp at which the LifecycleState was last changed. Used to track how long it has been in the current state. - */ - lastStateChangeTime?: string | null; - /** - * Output only. Lifecycle state of the Rollout Sequence. - */ - lifecycleState?: string | null; - /** - * Output only. StateReason represents the reason for the Rollout Sequence state. - */ - stateReasons?: string[] | null; - } /** * Stage represents a single stage in the Rollout. */ @@ -10734,8 +10734,8 @@ export namespace gkehub_v1beta { * // "ignoredClustersSelector": {}, * // "labels": {}, * // "name": "my_name", + * // "operationalState": {}, * // "stages": [], - * // "state": {}, * // "uid": "my_uid", * // "updateTime": "my_updateTime" * // } @@ -11035,8 +11035,8 @@ export namespace gkehub_v1beta { * // "ignoredClustersSelector": {}, * // "labels": {}, * // "name": "my_name", + * // "operationalState": {}, * // "stages": [], - * // "state": {}, * // "uid": "my_uid", * // "updateTime": "my_updateTime" * // } @@ -11333,8 +11333,8 @@ export namespace gkehub_v1beta { * // "ignoredClustersSelector": {}, * // "labels": {}, * // "name": "my_name", + * // "operationalState": {}, * // "stages": [], - * // "state": {}, * // "uid": "my_uid", * // "updateTime": "my_updateTime" * // } diff --git a/src/apis/gmail/v1.ts b/src/apis/gmail/v1.ts index 89a0b392239..b12a32c8445 100644 --- a/src/apis/gmail/v1.ts +++ b/src/apis/gmail/v1.ts @@ -148,6 +148,10 @@ export namespace gmail_v1 { ids?: string[] | null; } export interface Schema$BatchModifyMessagesRequest { + /** + * A list of Classification Label values to add. If a Classification Label with the same label ID is already applied to the message, fields with existing field IDs will be updated and fields with new field IDs will be added. There's a limit of 20 Classification Label values per request. If the message is already classified and the final total number of Classification Label values exceeds the maximum allowed number of Classification Label values per message, the modification fails. + */ + addClassificationLabels?: Schema$ClassificationLabelValue[]; /** * A list of label IDs to add to messages. */ @@ -156,6 +160,10 @@ export namespace gmail_v1 { * The IDs of the messages to modify. There is a limit of 1000 ids per request. */ ids?: string[] | null; + /** + * A list of Classification Label values to remove from messages. + */ + removeClassificationLabelIds?: string[] | null; /** * A list of label IDs to remove from messages. */ @@ -661,7 +669,7 @@ export namespace gmail_v1 { */ export interface Schema$Message { /** - * Classification Label values on the message. Available Classification Label schemas can be queried using the Google Drive Labels API. Each classification label ID must be unique. If duplicate IDs are provided, only one will be retained, and the selection is arbitrary. Only used for Google Workspace accounts. + * Classification Label values on the message. Available Classification Label schemas can be queried using the Google Drive Labels API. Each classification label ID must be unique. If duplicate IDs are provided, only one will be retained, and the selection is arbitrary. Only used for Google Workspace accounts. There's a limit of 20 Classification Label values per request. If the Classification Label values exceeds the maximum allowed number, the request fails. */ classificationLabelValues?: Schema$ClassificationLabelValue[]; /** @@ -758,10 +766,18 @@ export namespace gmail_v1 { value?: string | null; } export interface Schema$ModifyMessageRequest { + /** + * A list of classification label values to add. If a Classification Label with the same label ID is already applied to the message, fields with existing field IDs will be updated and fields with new field IDs will be added. There's a limit of 20 Classification Label values per request. If the message is already classified and the final total number of Classification Label values exceeds the maximum allowed number of Classification Label values per message, the modification fails. + */ + addClassificationLabels?: Schema$ClassificationLabelValue[]; /** * A list of IDs of labels to add to this message. You can add up to 100 labels with each update. */ addLabelIds?: string[] | null; + /** + * A list of Classification Label values to remove from this message. + */ + removeClassificationLabelIds?: string[] | null; /** * A list IDs of labels to remove from this message. You can remove up to 100 labels with each update. */ @@ -3900,7 +3916,7 @@ export namespace gmail_v1 { } /** - * Modifies the labels on the specified messages. + * Modifies the labels and the Classification Label values on the specified messages. For administrators modifying messages for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.modify.restricted` scope. * @example * ```js * // Before running the sample: @@ -3940,8 +3956,10 @@ export namespace gmail_v1 { * requestBody: { * // request body parameters * // { + * // "addClassificationLabels": [], * // "addLabelIds": [], * // "ids": [], + * // "removeClassificationLabelIds": [], * // "removeLabelIds": [] * // } * }, @@ -4850,7 +4868,7 @@ export namespace gmail_v1 { } /** - * Modifies the labels on the specified message. + * Modifies the labels and the Classification Label values on the specified message. For administrators modifying message for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.modify.restricted` scope. * @example * ```js * // Before running the sample: @@ -4892,7 +4910,9 @@ export namespace gmail_v1 { * requestBody: { * // request body parameters * // { + * // "addClassificationLabels": [], * // "addLabelIds": [], + * // "removeClassificationLabelIds": [], * // "removeLabelIds": [] * // } * }, diff --git a/src/apis/health/v4.ts b/src/apis/health/v4.ts index 3b3c41bef60..28e7e4863bf 100644 --- a/src/apis/health/v4.ts +++ b/src/apis/health/v4.ts @@ -494,7 +494,7 @@ export namespace health_v4 { calculationMethod?: string | null; } /** - * Value of a daily rollup for a single civil time interval (aggregation window) + * Value of a daily rollup for a single civil time interval (aggregation window) of reconciled data points from all data sources, excluding those data points that are identified as recorded by wearables in intervals when they were not actually worn. */ export interface Schema$DailyRollupDataPoint { /** @@ -1014,7 +1014,7 @@ export namespace health_v4 { */ export interface Schema$ExportExerciseTcxResponse { /** - * Contains the exported TCX data. + * Contains the exported TCX data. This field is intended for gRPC clients, as media download integration is not supported for gRPC. HTTP clients should instead use the `alt=media` query parameter to download the raw binary TCX file. */ tcxData?: string | null; } @@ -1110,7 +1110,7 @@ export namespace health_v4 { */ export interface Schema$HeartRateVariability { /** - * Optional. The root mean square of successive differences between normal heartbeats. This is a measure of heart rate variability used by Fitbit. + * Optional. The root mean square of successive differences between normal heartbeats. This is a measure of heart rate variability used by Google Health. */ rootMeanSquareOfSuccessiveDifferencesMilliseconds?: number | null; /** @@ -1695,7 +1695,7 @@ export namespace health_v4 { beatsPerMinuteMin?: number | null; } /** - * Value of a rollup for a single physical time interval (aggregation window) + * Value of a rollup for a single physical time interval (aggregation window) of reconciled data points from all data sources, excluding those data points that are identified as recorded by wearables in intervals when they were not actually worn. */ export interface Schema$RollupDataPoint { /** @@ -2202,7 +2202,7 @@ export namespace health_v4 { */ export interface Schema$SubscriberConfig { /** - * Required. Supported data types are: "altitude", "distance", "floors", "sleep", "steps", "weight". Values should be in kebab-case. + * Required. See [Google Health API data types](https://developers.google.com/health/data-types) for the list of supported data types. Values should be in kebab-case. */ dataTypes?: string[] | null; /** @@ -2361,7 +2361,7 @@ export namespace health_v4 { */ milliliters?: number | null; /** - * Optional. Value representing the user provided unit. + * Optional. Value representing the user provided unit, used only for user-facing input and display purposes. In the API format, all volume quantities are converted to milliliters. */ userProvidedUnit?: string | null; } @@ -3098,7 +3098,13 @@ export namespace health_v4 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [], + * scopes: [ + * 'https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly', + * 'https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly', + * 'https://www.googleapis.com/auth/googlehealth.profile.readonly', + * 'https://www.googleapis.com/auth/googlehealth.settings.readonly', + * 'https://www.googleapis.com/auth/googlehealth.sleep.readonly', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -3234,7 +3240,7 @@ export namespace health_v4 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [], + * scopes: ['https://www.googleapis.com/auth/googlehealth.profile.readonly'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -3373,7 +3379,7 @@ export namespace health_v4 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [], + * scopes: ['https://www.googleapis.com/auth/googlehealth.settings.readonly'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -4240,7 +4246,12 @@ export namespace health_v4 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [], + * scopes: [ + * 'https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly', + * 'https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly', + * 'https://www.googleapis.com/auth/googlehealth.location.readonly', + * 'https://www.googleapis.com/auth/googlehealth.sleep.readonly', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -4374,7 +4385,7 @@ export namespace health_v4 { } /** - * Exports exercise data in TCX format. Note: While the Authorization section below states that any one of the listed scopes is accepted, this specific method requires the user to provide both one of the `activity_and_fitness` scopes (`normal` or `readonly`) AND one of the `location` scopes (`normal` or `readonly`) in their access token to succeed. + * Exports exercise data in TCX format. **IMPORTANT:** HTTP clients must append `?alt=media` to the request URL to download the raw TCX file. Example: `https://health.googleapis.com/v4/users/me/dataTypes/exercise/dataPoints/EXERCISE_ID:exportExerciseTcx?alt=media` Without `alt=media`, the server returns a JSON response (`ExportExerciseTcxResponse`) which is intended primarily for gRPC clients. **Note:** While the Authorization section below states that any one of the listed scopes is accepted, this specific method requires the user to provide both one of the `activity_and_fitness` scopes (`normal` or `readonly`) AND one of the `location` scopes (`normal` or `readonly`) in their access token to succeed. * @example * ```js * // Before running the sample: @@ -4395,7 +4406,10 @@ export namespace health_v4 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [], + * scopes: [ + * 'https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly', + * 'https://www.googleapis.com/auth/googlehealth.location.readonly', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -4539,7 +4553,12 @@ export namespace health_v4 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [], + * scopes: [ + * 'https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly', + * 'https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly', + * 'https://www.googleapis.com/auth/googlehealth.location.readonly', + * 'https://www.googleapis.com/auth/googlehealth.sleep.readonly', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -4704,7 +4723,12 @@ export namespace health_v4 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [], + * scopes: [ + * 'https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly', + * 'https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly', + * 'https://www.googleapis.com/auth/googlehealth.location.readonly', + * 'https://www.googleapis.com/auth/googlehealth.sleep.readonly', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -4713,7 +4737,7 @@ export namespace health_v4 { * * // Do the magic * const res = await health.users.dataTypes.dataPoints.list({ - * // Optional. Filter expression following https://google.aip.dev/160. A time range (either physical or civil) can be specified. The supported filter fields are: - Interval start time: - Pattern: `{interval_data_type\}.interval.start_time` - Supported comparison operators: `\>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `steps.interval.start_time \>= "2023-11-24T00:00:00Z" AND steps.interval.start_time < "2023-11-25T00:00:00Z"` - `distance.interval.start_time \>= "2024-08-14T12:34:56Z"` - Interval civil start time: - Pattern: `{interval_data_type\}.interval.civil_start_time` - Supported comparison operators: `\>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `steps.interval.civil_start_time \>= "2023-11-24" AND steps.interval.civil_start_time < "2023-11-25"` - `distance.interval.civil_start_time \>= "2024-08-14T12:34:56"` - Sample observation physical time: - Pattern: `{sample_data_type\}.sample_time.physical_time` - Supported comparison operators: `\>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `weight.sample_time.physical_time \>= "2023-11-24T00:00:00Z" AND weight.sample_time.physical_time < "2023-11-25T00:00:00Z"` - `weight.sample_time.physical_time \>= "2024-08-14T12:34:56Z"` - Sample observation civil time: - Pattern: `{sample_data_type\}.sample_time.civil_time` - Supported comparison operators: `\>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `weight.sample_time.civil_time \>= "2023-11-24" AND weight.sample_time.civil_time < "2023-11-25"` - `weight.sample_time.civil_time \>= "2024-08-14T12:34:56"` - Daily summary date: - Pattern: `{daily_summary_data_type\}.date` - Supported comparison operators: `\>=`, `<` - Date literal expected in ISO 8601 `YYYY-MM-DD` format - Supported logical operators: `AND` - Example: - `daily_heart_rate_variability.date < "2024-08-15"` - Session civil start time (**Excluding Sleep**): - Pattern: `{session_data_type\}.interval.civil_start_time` - Supported comparison operators: `\>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `exercise.interval.civil_start_time \>= "2023-11-24" AND exercise.interval.civil_start_time < "2023-11-25"` - `exercise.interval.civil_start_time \>= "2024-08-14T12:34:56"` - Session end time (**Sleep specific**): - Pattern: `sleep.interval.end_time` - Supported comparison operators: `\>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.end_time \>= "2023-11-24T00:00:00Z" AND sleep.interval.end_time < "2023-11-25T00:00:00Z"` - Session civil end time (**Sleep specific**): - Pattern: `sleep.interval.civil_end_time` - Supported comparison operators: `\>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.civil_end_time \>= "2023-11-24" AND sleep.interval.civil_end_time < "2023-11-25"` Data points in the response will be ordered by the interval start time in descending order. + * // Optional. Filter expression following https://google.aip.dev/160. A time range (either physical or civil) can be specified. The supported filter fields are: - Interval start time: - Pattern: `{interval_data_type\}.interval.start_time` - Supported comparison operators: `\>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `steps.interval.start_time \>= "2023-11-24T00:00:00Z" AND steps.interval.start_time < "2023-11-25T00:00:00Z"` - `distance.interval.start_time \>= "2024-08-14T12:34:56Z"` - Interval civil start time: - Pattern: `{interval_data_type\}.interval.civil_start_time` - Supported comparison operators: `\>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `steps.interval.civil_start_time \>= "2023-11-24" AND steps.interval.civil_start_time < "2023-11-25"` - `distance.interval.civil_start_time \>= "2024-08-14T12:34:56"` - Sample observation physical time: - Pattern: `{sample_data_type\}.sample_time.physical_time` - Supported comparison operators: `\>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `weight.sample_time.physical_time \>= "2023-11-24T00:00:00Z" AND weight.sample_time.physical_time < "2023-11-25T00:00:00Z"` - `weight.sample_time.physical_time \>= "2024-08-14T12:34:56Z"` - Sample observation civil time: - Pattern: `{sample_data_type\}.sample_time.civil_time` - Supported comparison operators: `\>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `weight.sample_time.civil_time \>= "2023-11-24" AND weight.sample_time.civil_time < "2023-11-25"` - `weight.sample_time.civil_time \>= "2024-08-14T12:34:56"` - Daily summary date: - Pattern: `{daily_summary_data_type\}.date` - Supported comparison operators: `\>=`, `<` - Date literal expected in ISO 8601 `YYYY-MM-DD` format - Supported logical operators: `AND` - Example: - `daily_heart_rate_variability.date < "2024-08-15"` - Session start time (**ECG specific**): - Pattern: `electrocardiogram.interval.start_time` - Supported comparison operators: `\>=` - Timestamp literal expected in RFC-3339 format - Example: - `electrocardiogram.interval.start_time \>= "2024-08-14T12:34:56Z"` - Note: Only filtering by start time is supported for ECG. Filtering by end time (e.g., `electrocardiogram.interval.end_time`) is not supported. - Session civil start time (**Excluding Sleep**): - Pattern: `{session_data_type\}.interval.civil_start_time` - Supported comparison operators: `\>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `exercise.interval.civil_start_time \>= "2023-11-24" AND exercise.interval.civil_start_time < "2023-11-25"` - `exercise.interval.civil_start_time \>= "2024-08-14T12:34:56"` - Session end time (**Sleep specific**): - Pattern: `sleep.interval.end_time` - Supported comparison operators: `\>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.end_time \>= "2023-11-24T00:00:00Z" AND sleep.interval.end_time < "2023-11-25T00:00:00Z"` - Session civil end time (**Sleep specific**): - Pattern: `sleep.interval.civil_end_time` - Supported comparison operators: `\>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.civil_end_time \>= "2023-11-24" AND sleep.interval.civil_end_time < "2023-11-25"` Data points in the response will be ordered by the interval start time in descending order. * filter: 'placeholder-value', * // Optional. The maximum number of data points to return. If unspecified, at most 1440 data points will be returned. The maximum page size is 10000; values above that will be truncated accordingly. For `exercise` and `sleep` the default page size is 25. The maximum page size for `exercise` and `sleep` is 25. * pageSize: 'placeholder-value', @@ -5027,7 +5051,12 @@ export namespace health_v4 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [], + * scopes: [ + * 'https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly', + * 'https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly', + * 'https://www.googleapis.com/auth/googlehealth.location.readonly', + * 'https://www.googleapis.com/auth/googlehealth.sleep.readonly', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -5177,7 +5206,12 @@ export namespace health_v4 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [], + * scopes: [ + * 'https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly', + * 'https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly', + * 'https://www.googleapis.com/auth/googlehealth.location.readonly', + * 'https://www.googleapis.com/auth/googlehealth.sleep.readonly', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -5361,7 +5395,7 @@ export namespace health_v4 { } export interface Params$Resource$Users$Datatypes$Datapoints$List extends StandardParameters { /** - * Optional. Filter expression following https://google.aip.dev/160. A time range (either physical or civil) can be specified. The supported filter fields are: - Interval start time: - Pattern: `{interval_data_type\}.interval.start_time` - Supported comparison operators: `\>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `steps.interval.start_time \>= "2023-11-24T00:00:00Z" AND steps.interval.start_time < "2023-11-25T00:00:00Z"` - `distance.interval.start_time \>= "2024-08-14T12:34:56Z"` - Interval civil start time: - Pattern: `{interval_data_type\}.interval.civil_start_time` - Supported comparison operators: `\>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `steps.interval.civil_start_time \>= "2023-11-24" AND steps.interval.civil_start_time < "2023-11-25"` - `distance.interval.civil_start_time \>= "2024-08-14T12:34:56"` - Sample observation physical time: - Pattern: `{sample_data_type\}.sample_time.physical_time` - Supported comparison operators: `\>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `weight.sample_time.physical_time \>= "2023-11-24T00:00:00Z" AND weight.sample_time.physical_time < "2023-11-25T00:00:00Z"` - `weight.sample_time.physical_time \>= "2024-08-14T12:34:56Z"` - Sample observation civil time: - Pattern: `{sample_data_type\}.sample_time.civil_time` - Supported comparison operators: `\>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `weight.sample_time.civil_time \>= "2023-11-24" AND weight.sample_time.civil_time < "2023-11-25"` - `weight.sample_time.civil_time \>= "2024-08-14T12:34:56"` - Daily summary date: - Pattern: `{daily_summary_data_type\}.date` - Supported comparison operators: `\>=`, `<` - Date literal expected in ISO 8601 `YYYY-MM-DD` format - Supported logical operators: `AND` - Example: - `daily_heart_rate_variability.date < "2024-08-15"` - Session civil start time (**Excluding Sleep**): - Pattern: `{session_data_type\}.interval.civil_start_time` - Supported comparison operators: `\>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `exercise.interval.civil_start_time \>= "2023-11-24" AND exercise.interval.civil_start_time < "2023-11-25"` - `exercise.interval.civil_start_time \>= "2024-08-14T12:34:56"` - Session end time (**Sleep specific**): - Pattern: `sleep.interval.end_time` - Supported comparison operators: `\>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.end_time \>= "2023-11-24T00:00:00Z" AND sleep.interval.end_time < "2023-11-25T00:00:00Z"` - Session civil end time (**Sleep specific**): - Pattern: `sleep.interval.civil_end_time` - Supported comparison operators: `\>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.civil_end_time \>= "2023-11-24" AND sleep.interval.civil_end_time < "2023-11-25"` Data points in the response will be ordered by the interval start time in descending order. + * Optional. Filter expression following https://google.aip.dev/160. A time range (either physical or civil) can be specified. The supported filter fields are: - Interval start time: - Pattern: `{interval_data_type\}.interval.start_time` - Supported comparison operators: `\>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `steps.interval.start_time \>= "2023-11-24T00:00:00Z" AND steps.interval.start_time < "2023-11-25T00:00:00Z"` - `distance.interval.start_time \>= "2024-08-14T12:34:56Z"` - Interval civil start time: - Pattern: `{interval_data_type\}.interval.civil_start_time` - Supported comparison operators: `\>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `steps.interval.civil_start_time \>= "2023-11-24" AND steps.interval.civil_start_time < "2023-11-25"` - `distance.interval.civil_start_time \>= "2024-08-14T12:34:56"` - Sample observation physical time: - Pattern: `{sample_data_type\}.sample_time.physical_time` - Supported comparison operators: `\>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `weight.sample_time.physical_time \>= "2023-11-24T00:00:00Z" AND weight.sample_time.physical_time < "2023-11-25T00:00:00Z"` - `weight.sample_time.physical_time \>= "2024-08-14T12:34:56Z"` - Sample observation civil time: - Pattern: `{sample_data_type\}.sample_time.civil_time` - Supported comparison operators: `\>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `weight.sample_time.civil_time \>= "2023-11-24" AND weight.sample_time.civil_time < "2023-11-25"` - `weight.sample_time.civil_time \>= "2024-08-14T12:34:56"` - Daily summary date: - Pattern: `{daily_summary_data_type\}.date` - Supported comparison operators: `\>=`, `<` - Date literal expected in ISO 8601 `YYYY-MM-DD` format - Supported logical operators: `AND` - Example: - `daily_heart_rate_variability.date < "2024-08-15"` - Session start time (**ECG specific**): - Pattern: `electrocardiogram.interval.start_time` - Supported comparison operators: `\>=` - Timestamp literal expected in RFC-3339 format - Example: - `electrocardiogram.interval.start_time \>= "2024-08-14T12:34:56Z"` - Note: Only filtering by start time is supported for ECG. Filtering by end time (e.g., `electrocardiogram.interval.end_time`) is not supported. - Session civil start time (**Excluding Sleep**): - Pattern: `{session_data_type\}.interval.civil_start_time` - Supported comparison operators: `\>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `exercise.interval.civil_start_time \>= "2023-11-24" AND exercise.interval.civil_start_time < "2023-11-25"` - `exercise.interval.civil_start_time \>= "2024-08-14T12:34:56"` - Session end time (**Sleep specific**): - Pattern: `sleep.interval.end_time` - Supported comparison operators: `\>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.end_time \>= "2023-11-24T00:00:00Z" AND sleep.interval.end_time < "2023-11-25T00:00:00Z"` - Session civil end time (**Sleep specific**): - Pattern: `sleep.interval.civil_end_time` - Supported comparison operators: `\>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.civil_end_time \>= "2023-11-24" AND sleep.interval.civil_end_time < "2023-11-25"` Data points in the response will be ordered by the interval start time in descending order. */ filter?: string; /** diff --git a/src/apis/homegraph/v1.ts b/src/apis/homegraph/v1.ts index adee9626871..29d83242edd 100644 --- a/src/apis/homegraph/v1.ts +++ b/src/apis/homegraph/v1.ts @@ -235,6 +235,15 @@ export namespace homegraph_v1 { */ swVersion?: string | null; } + /** + * Metadata for traits of a single device. + */ + export interface Schema$DeviceMetadata { + /** + * Map from the Trait ID (e.g., "action.devices.traits.OnOff") to its last Spanner commit timestamp. + */ + traitCommitTimestamps?: {[key: string]: string} | null; + } /** * Identifiers used to describe the device. */ @@ -320,6 +329,10 @@ export namespace homegraph_v1 { * Required. Third-party user ID. */ agentUserId?: string | null; + /** + * Optional. If true, the response will include device metadata in the device_metadata field. + */ + includeDeviceMetadata?: boolean | null; /** * Required. Inputs containing third-party device IDs for which to get the device states. */ @@ -364,6 +377,10 @@ export namespace homegraph_v1 { * Payload containing device states information. */ export interface Schema$QueryResponsePayload { + /** + * Map from the Trait ID (e.g., "action.devices.traits.OnOff") to its last Spanner commit timestamp. If a trait has no recorded timestamp, it will be omitted from this map. + */ + deviceMetadata?: {[key: string]: Schema$DeviceMetadata} | null; /** * States of the devices. Map of third-party device ID to struct of device states. */ @@ -693,6 +710,7 @@ export namespace homegraph_v1 { * // request body parameters * // { * // "agentUserId": "my_agentUserId", + * // "includeDeviceMetadata": false, * // "inputs": [], * // "requestId": "my_requestId" * // } diff --git a/src/apis/hypercomputecluster/v1.ts b/src/apis/hypercomputecluster/v1.ts index bba0b515b84..f58554b9417 100644 --- a/src/apis/hypercomputecluster/v1.ts +++ b/src/apis/hypercomputecluster/v1.ts @@ -1059,7 +1059,7 @@ export namespace hypercomputecluster_v1 { localMount?: string | null; } /** - * A resource representing a form of persistent storage that is accessible to compute resources in the cluster. + * A resource representing a form of persistent storage that can be mounted onto compute resources in the cluster. */ export interface Schema$StorageResource { /** diff --git a/src/apis/index.ts b/src/apis/index.ts index e36352b62b2..4d41d085159 100644 --- a/src/apis/index.ts +++ b/src/apis/index.ts @@ -229,6 +229,10 @@ import { VERSIONS as cloudlocationfinderVersions, cloudlocationfinder, } from './cloudlocationfinder'; +import { + VERSIONS as cloudnumberregistryVersions, + cloudnumberregistry, +} from './cloudnumberregistry'; import { VERSIONS as cloudprofilerVersions, cloudprofiler, @@ -878,6 +882,7 @@ export const APIS: APIList = { cloudiot: cloudiotVersions, cloudkms: cloudkmsVersions, cloudlocationfinder: cloudlocationfinderVersions, + cloudnumberregistry: cloudnumberregistryVersions, cloudprofiler: cloudprofilerVersions, cloudresourcemanager: cloudresourcemanagerVersions, cloudscheduler: cloudschedulerVersions, @@ -1205,6 +1210,7 @@ export class GeneratedAPIs { cloudiot = cloudiot; cloudkms = cloudkms; cloudlocationfinder = cloudlocationfinder; + cloudnumberregistry = cloudnumberregistry; cloudprofiler = cloudprofiler; cloudresourcemanager = cloudresourcemanager; cloudscheduler = cloudscheduler; diff --git a/src/apis/managedidentities/v1.ts b/src/apis/managedidentities/v1.ts index a0d97ebd7a6..2b49b2f19e2 100644 --- a/src/apis/managedidentities/v1.ts +++ b/src/apis/managedidentities/v1.ts @@ -1469,7 +1469,7 @@ export namespace managedidentities_v1 { * * // Do the magic * const res = await managedidentities.projects.locations.list({ - * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -1596,7 +1596,7 @@ export namespace managedidentities_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/merchantapi/accounts_v1.ts b/src/apis/merchantapi/accounts_v1.ts index 31bcc90cfda..da2b4e9caa2 100644 --- a/src/apis/merchantapi/accounts_v1.ts +++ b/src/apis/merchantapi/accounts_v1.ts @@ -5131,7 +5131,7 @@ export namespace merchantapi_accounts_v1 { } /** - * Registers the GCP used for the API call to the shopping account passed in the request. Will create a user with an "API developer" and add the "developer_email" as a contact with "API notifications" email preference on. + * Registers the GCP used for the API call to the shopping account passed in the request. Will create a user with an "API developer" and add the "developer_email" as a contact with "API notifications" email preference on. Restrictions: * The caller account must be authenticated and must not impersonate another account at registration time. Registering for subaccounts is not supported if the caller account is authenticated with the parent or the managing advanced account. * The caller account must have a [verified website](https://support.google.com/merchants/answer/11586344) in Merchant Center. * [Test accounts](https://developers.google.com/merchant/api/guides/accounts/test-accounts) are not eligible for registration. * @example * ```js * // Before running the sample: @@ -5161,7 +5161,7 @@ export namespace merchantapi_accounts_v1 { * * // Do the magic * const res = await merchantapi.accounts.developerRegistration.registerGcp({ - * // Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account\}/developerRegistration` The {account\} used must be the same account where user calling this API method is directly added to. + * // Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account\}/developerRegistration` The {account\} used must be the same account where user calling this API method is directly added to. Note: The account used must be a production account (can't be a [test account](https://developers.google.com/merchant/api/guides/accounts/test-accounts) ) and must have a [verified website](https://support.google.com/merchants/answer/11586344) in Merchant Center. * name: 'accounts/my-account/developerRegistration', * * // Request body metadata @@ -5433,7 +5433,7 @@ export namespace merchantapi_accounts_v1 { } export interface Params$Resource$Accounts$Developerregistration$Registergcp extends StandardParameters { /** - * Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account\}/developerRegistration` The {account\} used must be the same account where user calling this API method is directly added to. + * Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account\}/developerRegistration` The {account\} used must be the same account where user calling this API method is directly added to. Note: The account used must be a production account (can't be a [test account](https://developers.google.com/merchant/api/guides/accounts/test-accounts) ) and must have a [verified website](https://support.google.com/merchants/answer/11586344) in Merchant Center. */ name?: string; diff --git a/src/apis/merchantapi/accounts_v1beta.ts b/src/apis/merchantapi/accounts_v1beta.ts index 82cd1018a29..fe8322cd7b5 100644 --- a/src/apis/merchantapi/accounts_v1beta.ts +++ b/src/apis/merchantapi/accounts_v1beta.ts @@ -5066,7 +5066,7 @@ export namespace merchantapi_accounts_v1beta { } /** - * Registers the GCP used for the API call to the shopping account passed in the request. Will create a user with an "API developer" and add the "developer_email" as a contact with "API notifications" email preference on. + * Registers the GCP used for the API call to the shopping account passed in the request. Will create a user with an "API developer" and add the "developer_email" as a contact with "API notifications" email preference on. Restrictions: * The caller account must be authenticated and must not impersonate another account at registration time. Registering for subaccounts is not supported if the caller account is authenticated with the parent or the managing advanced account. * The caller account must have a [verified website](https://support.google.com/merchants/answer/11586344) in Merchant Center. * [Test accounts](https://developers.google.com/merchant/api/guides/accounts/test-accounts) are not eligible for registration. * @example * ```js * // Before running the sample: @@ -5096,7 +5096,7 @@ export namespace merchantapi_accounts_v1beta { * * // Do the magic * const res = await merchantapi.accounts.developerRegistration.registerGcp({ - * // Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account\}/developerRegistration` The {account\} used must be the same account where user calling this API method is directly added to. + * // Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account\}/developerRegistration` The {account\} used must be the same account where user calling this API method is directly added to. Note: The account used must be a production account (can't be a [test account](https://developers.google.com/merchant/api/guides/accounts/test-accounts) ) and must have a [verified website](https://support.google.com/merchants/answer/11586344) in Merchant Center. * name: 'accounts/my-account/developerRegistration', * * // Request body metadata @@ -5368,7 +5368,7 @@ export namespace merchantapi_accounts_v1beta { } export interface Params$Resource$Accounts$Developerregistration$Registergcp extends StandardParameters { /** - * Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account\}/developerRegistration` The {account\} used must be the same account where user calling this API method is directly added to. + * Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account\}/developerRegistration` The {account\} used must be the same account where user calling this API method is directly added to. Note: The account used must be a production account (can't be a [test account](https://developers.google.com/merchant/api/guides/accounts/test-accounts) ) and must have a [verified website](https://support.google.com/merchants/answer/11586344) in Merchant Center. */ name?: string; diff --git a/src/apis/merchantapi/products_v1.ts b/src/apis/merchantapi/products_v1.ts index 8558da8a921..40316cc4f37 100644 --- a/src/apis/merchantapi/products_v1.ts +++ b/src/apis/merchantapi/products_v1.ts @@ -480,6 +480,19 @@ export namespace merchantapi_products_v1 { */ value?: string | null; } + /** + * The pickup cost of the item. + */ + export interface Schema$PickupCost { + /** + * Required. The flat rate pickup cost of the item. + */ + flatRate?: Schema$Price; + /** + * Optional. The price threshold above which pickup is free of charge. + */ + freeThreshold?: Schema$Price; + } /** * The price represented as a number and currency. */ @@ -497,6 +510,10 @@ export namespace merchantapi_products_v1 { * The processed product, built from multiple product inputs after applying rules and supplemental data sources. This processed product matches what is shown in your Merchant Center account. Each product is built from exactly one primary data source product input, and multiple supplemental data source inputs. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved. All fields in the processed product and its sub-messages match the name of their corresponding attribute in the [Product data specification](https://support.google.com/merchants/answer/7052112) with some exceptions. */ export interface Schema$Product { + /** + * Output only. Determines whether the product is [archived](https://support.google.com/merchants/answer/11909930). To archive or restore your product, visit Merchant Center products page. Learn also more about [offer visibility](https://support.google.com/merchants/answer/12488713). + */ + archived?: boolean | null; /** * Output only. The automated discounts information for the product. */ @@ -846,6 +863,10 @@ export namespace merchantapi_products_v1 { * Publication of this item will be temporarily [paused](https://support.google.com/merchants/answer/11909930). */ pause?: string | null; + /** + * Optional. The [pickup cost](https://support.google.com/merchants/answer/16988704) for an item when a customer buys it online and picks it up at a store. + */ + pickupCost?: Schema$PickupCost; /** * The [pickup](https://support.google.com/merchants/answer/14634021) option for the item. */ @@ -2064,6 +2085,7 @@ export namespace merchantapi_products_v1 { * * // Example response * // { + * // "archived": false, * // "automatedDiscounts": {}, * // "base64EncodedName": "my_base64EncodedName", * // "contentLanguage": "my_contentLanguage", diff --git a/src/apis/merchantapi/products_v1beta.ts b/src/apis/merchantapi/products_v1beta.ts index a6f3ca1cb72..1752ecebc6c 100644 --- a/src/apis/merchantapi/products_v1beta.ts +++ b/src/apis/merchantapi/products_v1beta.ts @@ -794,6 +794,10 @@ export namespace merchantapi_products_v1beta { * The processed product, built from multiple product inputs after applying rules and supplemental data sources. This processed product matches what is shown in your Merchant Center account. Each product is built from exactly one primary data source product input, and multiple supplemental data source inputs. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved. All fields in the processed product and its sub-messages match the name of their corresponding attribute in the [Product data specification](https://support.google.com/merchants/answer/7052112) with some exceptions. */ export interface Schema$Product { + /** + * Output only. Determines whether the product is [archived](https://support.google.com/merchants/answer/11909930). To archive or restore your product, visit Merchant Center products page. Learn also more about [offer visibility](https://support.google.com/merchants/answer/12488713). + */ + archived?: boolean | null; /** * Output only. A list of product attributes. */ @@ -1808,6 +1812,7 @@ export namespace merchantapi_products_v1beta { * * // Example response * // { + * // "archived": false, * // "attributes": {}, * // "automatedDiscounts": {}, * // "base64EncodedName": "my_base64EncodedName", diff --git a/src/apis/migrationcenter/v1alpha1.ts b/src/apis/migrationcenter/v1alpha1.ts index e0ef979d0da..3a42da6b572 100644 --- a/src/apis/migrationcenter/v1alpha1.ts +++ b/src/apis/migrationcenter/v1alpha1.ts @@ -291,6 +291,10 @@ export namespace migrationcenter_v1alpha1 { * Output only. Asset information specific for AWS AppSync GraphQL APIs. */ awsAppSyncGraphqlApiDetails?: Schema$AwsAppSyncGraphqlApiDetails; + /** + * Output only. Asset information specific for AwsAthenaWorkGroupDetails + */ + awsAthenaWorkGroupDetails?: Schema$AwsAthenaWorkGroupDetails; /** * Output only. Asset information specific for AwsAutoscalingGroupDetails */ @@ -339,10 +343,26 @@ export namespace migrationcenter_v1alpha1 { * Output only. Asset information specific for AWS Load Balancers. */ awsElbLoadBalancerDetails?: Schema$AwsElbLoadBalancerDetails; + /** + * Output only. Asset information specific for AwsEmrClusterDetails + */ + awsEmrClusterDetails?: Schema$AwsEmrClusterDetails; + /** + * Output only. Asset information specific for AwsFirehoseDetails + */ + awsFirehoseDetails?: Schema$AwsFirehoseDetails; + /** + * Output only. Asset information specific for AwsGlueJobDetails + */ + awsGlueJobDetails?: Schema$AwsGlueJobDetails; /** * Output only. Asset information specific for AWS Internet Gateways. */ awsInternetGatewayDetails?: Schema$AwsInternetGatewayDetails; + /** + * Output only. Asset information specific for AwsKinesisStreamDetails + */ + awsKinesisStreamDetails?: Schema$AwsKinesisStreamDetails; /** * Output only. Asset information specific for AWS Lambda functions. */ @@ -460,6 +480,10 @@ export namespace migrationcenter_v1alpha1 { * Optional. Asset information specific for AWS AppSync GraphQL APIs. */ awsAppSyncGraphqlApiDetails?: Schema$AwsAppSyncGraphqlApiDetails; + /** + * Optional. Asset information specific for AwsAthenaWorkGroupDetails + */ + awsAthenaWorkGroupDetails?: Schema$AwsAthenaWorkGroupDetails; /** * Optional. Asset information specific for AwsAutoscalingGroupDetails */ @@ -508,10 +532,26 @@ export namespace migrationcenter_v1alpha1 { * Asset information specific for AWS Load Balancers. */ awsElbLoadBalancerDetails?: Schema$AwsElbLoadBalancerDetails; + /** + * Optional. Asset information specific for AwsEmrClusterDetails + */ + awsEmrClusterDetails?: Schema$AwsEmrClusterDetails; + /** + * Optional. Asset information specific for AwsFirehoseDetails + */ + awsFirehoseDetails?: Schema$AwsFirehoseDetails; + /** + * Optional. Asset information specific for AwsGlueJobDetails + */ + awsGlueJobDetails?: Schema$AwsGlueJobDetails; /** * Optional. Asset information specific for AWS Internet Gateways. */ awsInternetGatewayDetails?: Schema$AwsInternetGatewayDetails; + /** + * Optional. Asset information specific for AwsKinesisStreamDetails + */ + awsKinesisStreamDetails?: Schema$AwsKinesisStreamDetails; /** * Asset information specific for AWS Lambda functions. */ @@ -736,6 +776,10 @@ export namespace migrationcenter_v1alpha1 { * Asset information specific for AWS AppSync GraphQL APIs. */ export interface Schema$AwsAppSyncGraphqlApiDetails {} + /** + * Contains details for an AWS Athena Work Group asset. + */ + export interface Schema$AwsAthenaWorkGroupDetails {} /** * Asset information specific for AWS Autoscaling Group. */ @@ -801,10 +845,26 @@ export namespace migrationcenter_v1alpha1 { * Asset information specific for AWS Load Balancers. */ export interface Schema$AwsElbLoadBalancerDetails {} + /** + * Contains details for an AWS EMR Cluster asset. + */ + export interface Schema$AwsEmrClusterDetails {} + /** + * Contains details for an AWS Firehose asset. + */ + export interface Schema$AwsFirehoseDetails {} + /** + * Contains details for an AWS Glue Job asset. + */ + export interface Schema$AwsGlueJobDetails {} /** * Asset information specific for AWS Internet Gateways. */ export interface Schema$AwsInternetGatewayDetails {} + /** + * Contains details for an AWS Kinesis Stream asset. + */ + export interface Schema$AwsKinesisStreamDetails {} /** * Asset information specific for AWS Lambda functions. */ @@ -6420,6 +6480,7 @@ export namespace migrationcenter_v1alpha1 { * // "awsApiGatewayRestApiDetails": {}, * // "awsAppSyncGraphqlApiDetails": {}, * // "awsApplicationLoadBalancerDetails": {}, + * // "awsAthenaWorkGroupDetails": {}, * // "awsAutoscalingGroupDetails": {}, * // "awsBatchComputeEnvironmentDetails": {}, * // "awsCloudFrontDistributionDetails": {}, @@ -6432,7 +6493,11 @@ export namespace migrationcenter_v1alpha1 { * // "awsElasticIpAddressDetails": {}, * // "awsElasticNetworkInterfaceDetails": {}, * // "awsElbLoadBalancerDetails": {}, + * // "awsEmrClusterDetails": {}, + * // "awsFirehoseDetails": {}, + * // "awsGlueJobDetails": {}, * // "awsInternetGatewayDetails": {}, + * // "awsKinesisStreamDetails": {}, * // "awsLambdaFunctionDetails": {}, * // "awsNatGatewayDetails": {}, * // "awsRedshiftDetails": {}, @@ -6752,6 +6817,7 @@ export namespace migrationcenter_v1alpha1 { * // "awsApiGatewayRestApiDetails": {}, * // "awsAppSyncGraphqlApiDetails": {}, * // "awsApplicationLoadBalancerDetails": {}, + * // "awsAthenaWorkGroupDetails": {}, * // "awsAutoscalingGroupDetails": {}, * // "awsBatchComputeEnvironmentDetails": {}, * // "awsCloudFrontDistributionDetails": {}, @@ -6764,7 +6830,11 @@ export namespace migrationcenter_v1alpha1 { * // "awsElasticIpAddressDetails": {}, * // "awsElasticNetworkInterfaceDetails": {}, * // "awsElbLoadBalancerDetails": {}, + * // "awsEmrClusterDetails": {}, + * // "awsFirehoseDetails": {}, + * // "awsGlueJobDetails": {}, * // "awsInternetGatewayDetails": {}, + * // "awsKinesisStreamDetails": {}, * // "awsLambdaFunctionDetails": {}, * // "awsNatGatewayDetails": {}, * // "awsRedshiftDetails": {}, @@ -6801,6 +6871,7 @@ export namespace migrationcenter_v1alpha1 { * // "awsApiGatewayRestApiDetails": {}, * // "awsAppSyncGraphqlApiDetails": {}, * // "awsApplicationLoadBalancerDetails": {}, + * // "awsAthenaWorkGroupDetails": {}, * // "awsAutoscalingGroupDetails": {}, * // "awsBatchComputeEnvironmentDetails": {}, * // "awsCloudFrontDistributionDetails": {}, @@ -6813,7 +6884,11 @@ export namespace migrationcenter_v1alpha1 { * // "awsElasticIpAddressDetails": {}, * // "awsElasticNetworkInterfaceDetails": {}, * // "awsElbLoadBalancerDetails": {}, + * // "awsEmrClusterDetails": {}, + * // "awsFirehoseDetails": {}, + * // "awsGlueJobDetails": {}, * // "awsInternetGatewayDetails": {}, + * // "awsKinesisStreamDetails": {}, * // "awsLambdaFunctionDetails": {}, * // "awsNatGatewayDetails": {}, * // "awsRedshiftDetails": {}, diff --git a/src/apis/mybusinessaccountmanagement/v1.ts b/src/apis/mybusinessaccountmanagement/v1.ts index 36b72abdec9..337cb198525 100644 --- a/src/apis/mybusinessaccountmanagement/v1.ts +++ b/src/apis/mybusinessaccountmanagement/v1.ts @@ -351,6 +351,10 @@ export namespace mybusinessaccountmanagement_v1 { * The name of the location to which the user is invited. */ locationName?: string | null; + /** + * Output only. The Place ID of the location to which the user is invited. Not always populated. + */ + placeId?: string | null; } /** * Request message for AccessControl.TransferLocation. diff --git a/src/apis/netapp/v1.ts b/src/apis/netapp/v1.ts index 680ab65be2d..c937ff9daa0 100644 --- a/src/apis/netapp/v1.ts +++ b/src/apis/netapp/v1.ts @@ -266,7 +266,7 @@ export namespace netapp_v1 { */ sourceSnapshot?: string | null; /** - * Volume full name of this backup belongs to. Either source_volume or ontap_source should be provided. Format: `projects/{projects_id\}/locations/{location\}/volumes/{volume_id\}` + * The resource name of the volume that this backup belongs to. You must provide either `source_volume` or `ontap_source`. Format: `projects/{project_id\}/locations/{location\}/volumes/{volume_id\}` */ sourceVolume?: string | null; /** @@ -643,7 +643,7 @@ export namespace netapp_v1 { */ peerClusterName?: string | null; /** - * Optional. List of IPv4 ip addresses to be used for peering. + * Optional. List of IPv4 IP addresses to be used for peering. */ peerIpAddresses?: string[] | null; /** @@ -879,7 +879,7 @@ export namespace netapp_v1 { */ labels?: {[key: string]: string} | null; /** - * Identifier. Name of the KmsConfig. Format: `projects/{project\}/locations/{location\}/kmsConfigs/{kms_config\}` + * Identifier. Name of the `KmsConfig`. Format: `projects/{project\}/locations/{location\}/kmsConfigs/{kms_config\}` */ name?: string | null; /** @@ -896,7 +896,7 @@ export namespace netapp_v1 { stateDetails?: string | null; } /** - * Configuration for a Large Capacity Volume. A Large Capacity Volume supports sizes ranging from 4.8 TiB to 20 PiB, it is composed of multiple internal constituents, and must be created in a large capacity pool. + * Configuration for a Large Capacity Volume. A Large Capacity Volume supports sizes ranging from 4.8 TiB to 20 PiB; it is composed of multiple internal constituents, and must be created in a large capacity pool. */ export interface Schema$LargeCapacityConfig { /** @@ -1411,7 +1411,7 @@ export namespace netapp_v1 { */ export interface Schema$RestoreParameters { /** - * Full name of the backup resource. Format for standard backup: projects/{project\}/locations/{location\}/backupVaults/{backup_vault_id\}/backups/{backup_id\} Format for BackupDR backup: projects/{project\}/locations/{location\}/backupVaults/{backup_vault\}/dataSources/{data_source\}/backups/{backup\} + * Full name of the backup resource. Format for standard backup: projects/{project\}/locations/{location\}/backupVaults/{backup_vault_id\}/backups/{backup_id\}. Format for BackupDR backup: projects/{project\}/locations/{location\}/backupVaults/{backup_vault\}/dataSources/{data_source\}/backups/{backup\} */ sourceBackup?: string | null; /** @@ -1646,7 +1646,7 @@ export namespace netapp_v1 { */ ldapEnabled?: boolean | null; /** - * Optional. Mode of the storage pool. This field is used to control whether the user can perform the ONTAP operations on the storage pool using the GCNV ONTAP Mode APIs. If not specified during creation, it defaults to `DEFAULT`. + * Optional. Mode of the storage pool. This field is used to control whether the user can perform ONTAP operations on the storage pool using the GCNV ONTAP Mode APIs. If not specified during creation, it defaults to `DEFAULT`. */ mode?: string | null; /** @@ -7325,7 +7325,7 @@ export namespace netapp_v1 { * * // Do the magic * const res = await netapp.projects.locations.kmsConfigs.patch({ - * // Identifier. Name of the KmsConfig. Format: `projects/{project\}/locations/{location\}/kmsConfigs/{kms_config\}` + * // Identifier. Name of the `KmsConfig`. Format: `projects/{project\}/locations/{location\}/kmsConfigs/{kms_config\}` * name: 'projects/my-project/locations/my-location/kmsConfigs/my-kmsConfig', * // Required. Field mask is used to specify the fields to be overwritten in the KmsConfig resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. * updateMask: 'placeholder-value', @@ -7659,7 +7659,7 @@ export namespace netapp_v1 { } export interface Params$Resource$Projects$Locations$Kmsconfigs$Patch extends StandardParameters { /** - * Identifier. Name of the KmsConfig. Format: `projects/{project\}/locations/{location\}/kmsConfigs/{kms_config\}` + * Identifier. Name of the `KmsConfig`. Format: `projects/{project\}/locations/{location\}/kmsConfigs/{kms_config\}` */ name?: string; /** @@ -9515,7 +9515,7 @@ export namespace netapp_v1 { } /** - * `ExecuteOntapDelete` dispatches the ONTAP `DELETE` request to the `StoragePool` cluster. + * `ExecuteOntapDelete` sends the ONTAP `DELETE` request to the `StoragePool` cluster. * @example * ```js * // Before running the sample: @@ -9656,7 +9656,7 @@ export namespace netapp_v1 { } /** - * `ExecuteOntapGet` dispatches the ONTAP `GET` request to the `StoragePool` cluster. + * `ExecuteOntapGet` sends the ONTAP `GET` request to the `StoragePool` cluster. * @example * ```js * // Before running the sample: @@ -9797,7 +9797,7 @@ export namespace netapp_v1 { } /** - * `ExecuteOntapPatch` dispatches the ONTAP `PATCH` request to the `StoragePool` cluster. + * `ExecuteOntapPatch` sends the ONTAP `PATCH` request to the `StoragePool` cluster. * @example * ```js * // Before running the sample: @@ -9946,7 +9946,7 @@ export namespace netapp_v1 { } /** - * `ExecuteOntapPost` dispatches the ONTAP `POST` request to the `StoragePool` cluster. + * `ExecuteOntapPost` sends the ONTAP `POST` request to the `StoragePool` cluster. * @example * ```js * // Before running the sample: @@ -9977,7 +9977,7 @@ export namespace netapp_v1 { * // Do the magic * const res = * await netapp.projects.locations.storagePools.ontap.executeOntapPost({ - * // Required. The resource path of the ONTAP resource. Format: `projects/{project_number\}/locations/{location_id\}/storagePools/{storage_pool_id\}/ontap/{ontap_resource_path\}`. For example: `projects/123456789/locations/us-central1/storagePools/my-storage-pool/ontap/api/storage/volumes`. + * // Required. The path of the ONTAP resource. Format: `projects/{project_number\}/locations/{location_id\}/storagePools/{storage_pool_id\}/ontap/{ontap_resource_path\}`. For example: `projects/123456789/locations/us-central1/storagePools/my-storage-pool/ontap/api/storage/volumes`. * ontapPath: * 'projects/my-project/locations/my-location/storagePools/my-storagePool/ontap/.*', * @@ -10120,7 +10120,7 @@ export namespace netapp_v1 { } export interface Params$Resource$Projects$Locations$Storagepools$Ontap$Executeontappost extends StandardParameters { /** - * Required. The resource path of the ONTAP resource. Format: `projects/{project_number\}/locations/{location_id\}/storagePools/{storage_pool_id\}/ontap/{ontap_resource_path\}`. For example: `projects/123456789/locations/us-central1/storagePools/my-storage-pool/ontap/api/storage/volumes`. + * Required. The path of the ONTAP resource. Format: `projects/{project_number\}/locations/{location_id\}/storagePools/{storage_pool_id\}/ontap/{ontap_resource_path\}`. For example: `projects/123456789/locations/us-central1/storagePools/my-storage-pool/ontap/api/storage/volumes`. */ ontapPath?: string; diff --git a/src/apis/netapp/v1beta1.ts b/src/apis/netapp/v1beta1.ts index e76c8f8e285..730ee1da3b1 100644 --- a/src/apis/netapp/v1beta1.ts +++ b/src/apis/netapp/v1beta1.ts @@ -253,6 +253,10 @@ export namespace netapp_v1beta1 { * Identifier. The resource name of the backup. Format: `projects/{project_id\}/locations/{location\}/backupVaults/{backup_vault_id\}/backups/{backup_id\}`. */ name?: string | null; + /** + * Optional. Represents source details for ONTAP backups. Either source_volume or ontap_source should be provided. + */ + ontapSource?: Schema$OntapSource; /** * Output only. Reserved for future use */ @@ -266,7 +270,7 @@ export namespace netapp_v1beta1 { */ sourceSnapshot?: string | null; /** - * Volume full name of this backup belongs to. Either source_volume or ontap_source should be provided. Format: `projects/{projects_id\}/locations/{location\}/volumes/{volume_id\}` + * The resource name of the volume that this backup belongs to. You must provide either `source_volume` or `ontap_source`. Format: `projects/{project_id\}/locations/{location\}/volumes/{volume_id\}` */ sourceVolume?: string | null; /** @@ -373,6 +377,19 @@ export namespace netapp_v1beta1 { */ weeklyBackupImmutable?: boolean | null; } + /** + * Represents the backup source of the restore operation. + */ + export interface Schema$BackupSource { + /** + * Required. The backup resource name. + */ + backup?: string | null; + /** + * Optional. List of files to be restored in the form of their absolute path as in source volume. If provided, only these files will be restored. If not provided, the entire backup will be restored (Full Backup Restore) + */ + fileList?: string[] | null; + } /** * A NetApp BackupVault. */ @@ -647,7 +664,7 @@ export namespace netapp_v1beta1 { */ peerClusterName?: string | null; /** - * Optional. List of IPv4 ip addresses to be used for peering. + * Optional. List of IPv4 IP addresses to be used for peering. */ peerIpAddresses?: string[] | null; /** @@ -883,7 +900,7 @@ export namespace netapp_v1beta1 { */ labels?: {[key: string]: string} | null; /** - * Identifier. Name of the KmsConfig. Format: `projects/{project\}/locations/{location\}/kmsConfigs/{kms_config\}` + * Identifier. Name of the `KmsConfig`. Format: `projects/{project\}/locations/{location\}/kmsConfigs/{kms_config\}` */ name?: string | null; /** @@ -900,7 +917,7 @@ export namespace netapp_v1beta1 { stateDetails?: string | null; } /** - * Configuration for a Large Capacity Volume. A Large Capacity Volume supports sizes ranging from 4.8 TiB to 20 PiB, it is composed of multiple internal constituents, and must be created in a large capacity pool. + * Configuration for a Large Capacity Volume. A Large Capacity Volume supports sizes ranging from 4.8 TiB to 20 PiB; it is composed of multiple internal constituents, and must be created in a large capacity pool. */ export interface Schema$LargeCapacityConfig { /** @@ -925,6 +942,23 @@ export namespace netapp_v1beta1 { */ unreachable?: string[] | null; } + /** + * Message for response to listing BackupConfigs in an ONTAP StoragePool. + */ + export interface Schema$ListBackupConfigsResponse { + /** + * The token you can use to retrieve the next page of results. Not returned if there are no more results in the list. + */ + nextPageToken?: string | null; + /** + * Unordered list. Locations that could not be reached. + */ + unreachable?: string[] | null; + /** + * A list of backup configurations for volumes in the pool. + */ + volumeBackupConfigs?: Schema$VolumeBackupConfig[]; + } /** * ListBackupPoliciesResponse contains all the backup policies requested. */ @@ -1217,6 +1251,36 @@ export namespace netapp_v1beta1 { */ protocol?: string | null; } + /** + * Represents ONTAP source details. + */ + export interface Schema$OntapSource { + /** + * Optional. The UUID of the ONTAP source snapshot. + */ + snapshotUuid?: string | null; + /** + * Required. Name of the storage pool. This must be specified for creating backups for ONTAP mode volumes. Format: `projects/{projects_id\}/locations/{location\}/storagePools/{storage_pool_id\}` + */ + storagePool?: string | null; + /** + * Required. The UUID of the ONTAP source volume. + */ + volumeUuid?: string | null; + } + /** + * Represents the ONTAP volume target of the restore operation. + */ + export interface Schema$OntapVolumeTarget { + /** + * Optional. Absolute directory path in the destination volume. + */ + restoreDestinationPath?: string | null; + /** + * Required. The UUID of the ONTAP volume to restore to. + */ + volumeUuid?: string | null; + } /** * This resource represents a long-running operation that is the result of a network API call. */ @@ -1415,7 +1479,7 @@ export namespace netapp_v1beta1 { */ export interface Schema$RestoreParameters { /** - * Full name of the backup resource. Format for standard backup: projects/{project\}/locations/{location\}/backupVaults/{backup_vault_id\}/backups/{backup_id\} Format for BackupDR backup: projects/{project\}/locations/{location\}/backupVaults/{backup_vault\}/dataSources/{data_source\}/backups/{backup\} + * Full name of the backup resource. Format for standard backup: projects/{project\}/locations/{location\}/backupVaults/{backup_vault_id\}/backups/{backup_id\}. Format for BackupDR backup: projects/{project\}/locations/{location\}/backupVaults/{backup_vault\}/dataSources/{data_source\}/backups/{backup\} */ sourceBackup?: string | null; /** @@ -1423,6 +1487,19 @@ export namespace netapp_v1beta1 { */ sourceSnapshot?: string | null; } + /** + * Request message for `RestoreVolume` API. + */ + export interface Schema$RestoreVolumeRequest { + /** + * The backup source of the restore operation. + */ + backupSource?: Schema$BackupSource; + /** + * The ONTAP volume target of the restore operation. + */ + ontapVolumeTarget?: Schema$OntapVolumeTarget; + } /** * ResumeReplicationRequest resumes a stopped replication. */ @@ -1650,7 +1727,7 @@ export namespace netapp_v1beta1 { */ ldapEnabled?: boolean | null; /** - * Optional. Mode of the storage pool. This field is used to control whether the user can perform the ONTAP operations on the storage pool using the GCNV ONTAP Mode APIs. If not specified during creation, it defaults to `DEFAULT`. + * Optional. Mode of the storage pool. This field is used to control whether the user can perform ONTAP operations on the storage pool using the GCNV ONTAP Mode APIs. If not specified during creation, it defaults to `DEFAULT`. */ mode?: string | null; /** @@ -1788,6 +1865,23 @@ export namespace netapp_v1beta1 { */ updateTime?: string | null; } + /** + * Request message for UpdateBackupConfig + */ + export interface Schema$UpdateBackupConfigRequest { + /** + * Required. Backup configuration to apply. + */ + backupConfig?: Schema$BackupConfig; + /** + * Required. Field mask is used to specify the fields to be overwritten in the BackupConfig for the Volume. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. + */ + updateMask?: string | null; + /** + * Required. The UUID of the ONTAP-mode volume. + */ + volumeUuid?: string | null; + } /** * UserCommands contains the commands to be executed by the customer. */ @@ -2008,6 +2102,19 @@ export namespace netapp_v1beta1 { */ zone?: string | null; } + /** + * Backup configuration for a volume in a pool. + */ + export interface Schema$VolumeBackupConfig { + /** + * Backup configuration for the volume. + */ + backupConfig?: Schema$BackupConfig; + /** + * Provides the Ontap UUID of the volume within the pool. + */ + volumeUuid?: string | null; + } /** * Make a snapshot every week e.g. at Monday 04:00, Wednesday 05:20, Sunday 23:50 */ @@ -4967,6 +5074,7 @@ export namespace netapp_v1beta1 { * // "enforcedRetentionEndTime": "my_enforcedRetentionEndTime", * // "labels": {}, * // "name": "my_name", + * // "ontapSource": {}, * // "satisfiesPzi": false, * // "satisfiesPzs": false, * // "sourceSnapshot": "my_sourceSnapshot", @@ -5270,6 +5378,7 @@ export namespace netapp_v1beta1 { * // "enforcedRetentionEndTime": "my_enforcedRetentionEndTime", * // "labels": {}, * // "name": "my_name", + * // "ontapSource": {}, * // "satisfiesPzi": false, * // "satisfiesPzs": false, * // "sourceSnapshot": "my_sourceSnapshot", @@ -5570,6 +5679,7 @@ export namespace netapp_v1beta1 { * // "enforcedRetentionEndTime": "my_enforcedRetentionEndTime", * // "labels": {}, * // "name": "my_name", + * // "ontapSource": {}, * // "satisfiesPzi": false, * // "satisfiesPzs": false, * // "sourceSnapshot": "my_sourceSnapshot", @@ -7336,7 +7446,7 @@ export namespace netapp_v1beta1 { * * // Do the magic * const res = await netapp.projects.locations.kmsConfigs.patch({ - * // Identifier. Name of the KmsConfig. Format: `projects/{project\}/locations/{location\}/kmsConfigs/{kms_config\}` + * // Identifier. Name of the `KmsConfig`. Format: `projects/{project\}/locations/{location\}/kmsConfigs/{kms_config\}` * name: 'projects/my-project/locations/my-location/kmsConfigs/my-kmsConfig', * // Required. Field mask is used to specify the fields to be overwritten in the KmsConfig resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. * updateMask: 'placeholder-value', @@ -7673,7 +7783,7 @@ export namespace netapp_v1beta1 { } export interface Params$Resource$Projects$Locations$Kmsconfigs$Patch extends StandardParameters { /** - * Identifier. Name of the KmsConfig. Format: `projects/{project\}/locations/{location\}/kmsConfigs/{kms_config\}` + * Identifier. Name of the `KmsConfig`. Format: `projects/{project\}/locations/{location\}/kmsConfigs/{kms_config\}` */ name?: string; /** @@ -8313,9 +8423,14 @@ export namespace netapp_v1beta1 { export class Resource$Projects$Locations$Storagepools { context: APIRequestContext; + backupConfigs: Resource$Projects$Locations$Storagepools$Backupconfigs; ontap: Resource$Projects$Locations$Storagepools$Ontap; constructor(context: APIRequestContext) { this.context = context; + this.backupConfigs = + new Resource$Projects$Locations$Storagepools$Backupconfigs( + this.context + ); this.ontap = new Resource$Projects$Locations$Storagepools$Ontap( this.context ); @@ -9143,6 +9258,157 @@ export namespace netapp_v1beta1 { } } + /** + * Restores a backup to an ONTAP-mode volume. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/netapp.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const netapp = google.netapp('v1beta1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await netapp.projects.locations.storagePools.restoreVolume({ + * // Required. The resource name of the ONTAP mode storage pool, in the format of `projects/{project\}/locations/{location\}/storagePools/{storage_pool\}` + * name: 'projects/my-project/locations/my-location/storagePools/my-storagePool', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "backupSource": {}, + * // "ontapVolumeTarget": {} + * // } + * }, + * }); + * 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. + */ + restoreVolume( + params: Params$Resource$Projects$Locations$Storagepools$Restorevolume, + options: StreamMethodOptions + ): Promise>; + restoreVolume( + params?: Params$Resource$Projects$Locations$Storagepools$Restorevolume, + options?: MethodOptions + ): Promise>; + restoreVolume( + params: Params$Resource$Projects$Locations$Storagepools$Restorevolume, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restoreVolume( + params: Params$Resource$Projects$Locations$Storagepools$Restorevolume, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restoreVolume( + params: Params$Resource$Projects$Locations$Storagepools$Restorevolume, + callback: BodyResponseCallback + ): void; + restoreVolume(callback: BodyResponseCallback): void; + restoreVolume( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Storagepools$Restorevolume + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Storagepools$Restorevolume; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Storagepools$Restorevolume; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://netapp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:restoreVolume').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); + } + } + /** * This operation will switch the active/replica zone for a regional storagePool. * @example @@ -9290,6 +9556,158 @@ export namespace netapp_v1beta1 { } } + /** + * Updates the backup configuration for an ONTAP-mode volume. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/netapp.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const netapp = google.netapp('v1beta1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await netapp.projects.locations.storagePools.updateBackupConfig({ + * // Required. The resource name of the StoragePool, in the format: projects/{projectNumber\}/locations/{locationId\}/storagePools/{poolId\} + * name: 'projects/my-project/locations/my-location/storagePools/my-storagePool', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "backupConfig": {}, + * // "updateMask": "my_updateMask", + * // "volumeUuid": "my_volumeUuid" + * // } + * }, + * }); + * 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. + */ + updateBackupConfig( + params: Params$Resource$Projects$Locations$Storagepools$Updatebackupconfig, + options: StreamMethodOptions + ): Promise>; + updateBackupConfig( + params?: Params$Resource$Projects$Locations$Storagepools$Updatebackupconfig, + options?: MethodOptions + ): Promise>; + updateBackupConfig( + params: Params$Resource$Projects$Locations$Storagepools$Updatebackupconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateBackupConfig( + params: Params$Resource$Projects$Locations$Storagepools$Updatebackupconfig, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateBackupConfig( + params: Params$Resource$Projects$Locations$Storagepools$Updatebackupconfig, + callback: BodyResponseCallback + ): void; + updateBackupConfig(callback: BodyResponseCallback): void; + updateBackupConfig( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Storagepools$Updatebackupconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Storagepools$Updatebackupconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Storagepools$Updatebackupconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://netapp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:updateBackupConfig').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); + } + } + /** * ValidateDirectoryService does a connectivity check for a directory service policy attached to the storage pool. * @example @@ -9507,6 +9925,17 @@ export namespace netapp_v1beta1 { */ requestBody?: Schema$StoragePool; } + export interface Params$Resource$Projects$Locations$Storagepools$Restorevolume extends StandardParameters { + /** + * Required. The resource name of the ONTAP mode storage pool, in the format of `projects/{project\}/locations/{location\}/storagePools/{storage_pool\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RestoreVolumeRequest; + } export interface Params$Resource$Projects$Locations$Storagepools$Switch extends StandardParameters { /** * Required. Name of the storage pool @@ -9518,6 +9947,17 @@ export namespace netapp_v1beta1 { */ requestBody?: Schema$SwitchActiveReplicaZoneRequest; } + export interface Params$Resource$Projects$Locations$Storagepools$Updatebackupconfig extends StandardParameters { + /** + * Required. The resource name of the StoragePool, in the format: projects/{projectNumber\}/locations/{locationId\}/storagePools/{poolId\} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UpdateBackupConfigRequest; + } export interface Params$Resource$Projects$Locations$Storagepools$Validatedirectoryservice extends StandardParameters { /** * Required. Name of the storage pool @@ -9530,6 +9970,189 @@ export namespace netapp_v1beta1 { requestBody?: Schema$ValidateDirectoryServiceRequest; } + export class Resource$Projects$Locations$Storagepools$Backupconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists backup configurations for all volumes in an ONTAP-mode Storage Pool. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/netapp.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const netapp = google.netapp('v1beta1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await netapp.projects.locations.storagePools.backupConfigs.list({ + * // Optional. The standard list filter. + * filter: 'placeholder-value', + * // Optional. Sort results. Supported values are "volume_id" or "" + * orderBy: 'placeholder-value', + * // Optional. The maximum number of items to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified or set to 0, a default of 50 will be used. + * pageSize: 'placeholder-value', + * // Optional. The next_page_token value to use if there are additional results to retrieve for this list request. + * pageToken: 'placeholder-value', + * // Required. The ONTAP StoragePool for which to retrieve backup configuration information, in the format `projects/{project\}/locations/{location\}/storagePools/{storage_pool\}`. + * parent: + * 'projects/my-project/locations/my-location/storagePools/my-storagePool', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "unreachable": [], + * // "volumeBackupConfigs": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Storagepools$Backupconfigs$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Storagepools$Backupconfigs$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Storagepools$Backupconfigs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Storagepools$Backupconfigs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Storagepools$Backupconfigs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Storagepools$Backupconfigs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Storagepools$Backupconfigs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Storagepools$Backupconfigs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://netapp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/backupConfigs').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$Storagepools$Backupconfigs$List extends StandardParameters { + /** + * Optional. The standard list filter. + */ + filter?: string; + /** + * Optional. Sort results. Supported values are "volume_id" or "" + */ + orderBy?: string; + /** + * Optional. The maximum number of items to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified or set to 0, a default of 50 will be used. + */ + pageSize?: number; + /** + * Optional. The next_page_token value to use if there are additional results to retrieve for this list request. + */ + pageToken?: string; + /** + * Required. The ONTAP StoragePool for which to retrieve backup configuration information, in the format `projects/{project\}/locations/{location\}/storagePools/{storage_pool\}`. + */ + parent?: string; + } + export class Resource$Projects$Locations$Storagepools$Ontap { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -9537,7 +10160,7 @@ export namespace netapp_v1beta1 { } /** - * `ExecuteOntapDelete` dispatches the ONTAP `DELETE` request to the `StoragePool` cluster. + * `ExecuteOntapDelete` sends the ONTAP `DELETE` request to the `StoragePool` cluster. * @example * ```js * // Before running the sample: @@ -9681,7 +10304,7 @@ export namespace netapp_v1beta1 { } /** - * `ExecuteOntapGet` dispatches the ONTAP `GET` request to the `StoragePool` cluster. + * `ExecuteOntapGet` sends the ONTAP `GET` request to the `StoragePool` cluster. * @example * ```js * // Before running the sample: @@ -9825,7 +10448,7 @@ export namespace netapp_v1beta1 { } /** - * `ExecuteOntapPatch` dispatches the ONTAP `PATCH` request to the `StoragePool` cluster. + * `ExecuteOntapPatch` sends the ONTAP `PATCH` request to the `StoragePool` cluster. * @example * ```js * // Before running the sample: @@ -9977,7 +10600,7 @@ export namespace netapp_v1beta1 { } /** - * `ExecuteOntapPost` dispatches the ONTAP `POST` request to the `StoragePool` cluster. + * `ExecuteOntapPost` sends the ONTAP `POST` request to the `StoragePool` cluster. * @example * ```js * // Before running the sample: @@ -10008,7 +10631,7 @@ export namespace netapp_v1beta1 { * // Do the magic * const res = * await netapp.projects.locations.storagePools.ontap.executeOntapPost({ - * // Required. The resource path of the ONTAP resource. Format: `projects/{project_number\}/locations/{location_id\}/storagePools/{storage_pool_id\}/ontap/{ontap_resource_path\}`. For example: `projects/123456789/locations/us-central1/storagePools/my-storage-pool/ontap/api/storage/volumes`. + * // Required. The path of the ONTAP resource. Format: `projects/{project_number\}/locations/{location_id\}/storagePools/{storage_pool_id\}/ontap/{ontap_resource_path\}`. For example: `projects/123456789/locations/us-central1/storagePools/my-storage-pool/ontap/api/storage/volumes`. * ontapPath: * 'projects/my-project/locations/my-location/storagePools/my-storagePool/ontap/.*', * @@ -10154,7 +10777,7 @@ export namespace netapp_v1beta1 { } export interface Params$Resource$Projects$Locations$Storagepools$Ontap$Executeontappost extends StandardParameters { /** - * Required. The resource path of the ONTAP resource. Format: `projects/{project_number\}/locations/{location_id\}/storagePools/{storage_pool_id\}/ontap/{ontap_resource_path\}`. For example: `projects/123456789/locations/us-central1/storagePools/my-storage-pool/ontap/api/storage/volumes`. + * Required. The path of the ONTAP resource. Format: `projects/{project_number\}/locations/{location_id\}/storagePools/{storage_pool_id\}/ontap/{ontap_resource_path\}`. For example: `projects/123456789/locations/us-central1/storagePools/my-storage-pool/ontap/api/storage/volumes`. */ ontapPath?: string; diff --git a/src/apis/networkconnectivity/v1.ts b/src/apis/networkconnectivity/v1.ts index a32449cecc2..f9ffc8c0d0e 100644 --- a/src/apis/networkconnectivity/v1.ts +++ b/src/apis/networkconnectivity/v1.ts @@ -629,6 +629,72 @@ export namespace networkconnectivity_v1 { */ srcRange?: string | null; } + /** + * A gateway that can apply specialized traffic processing. + */ + export interface Schema$Gateway { + /** + * Optional. The aggregate processing capacity of this gateway. + */ + capacity?: string | null; + /** + * Output only. The list of Cloud Routers that are connected to this gateway. Should be in the form: https://www.googleapis.com/compute/v1/projects/{project\}/regions/{region\}/routers/{router\} + */ + cloudRouters?: string[] | null; + /** + * Optional. A list of IP ranges that are reserved for this gateway's internal intfrastructure. + */ + ipRangeReservations?: Schema$IpRangeReservation[]; + /** + * Output only. The URI of the connected SACAttachment. Should be in the form: projects/{project\}/locations/{location\}/sacAttachments/{sac_attachment\} + */ + sacAttachment?: string | null; + } + /** + * A gateway advertised route is a route that a gateway spoke advertises somewhere. + */ + export interface Schema$GatewayAdvertisedRoute { + /** + * Output only. The time the gateway advertised route was created. + */ + createTime?: string | null; + /** + * An optional description of the gateway advertised route. + */ + description?: string | null; + /** + * Immutable. This route's advertised IP address range. Must be a valid CIDR-formatted prefix. If an IP address is provided without a subnet mask, it is interpreted as, for IPv4, a `/32` singular IP address range, and, for IPv6, `/128`. + */ + ipRange?: string | null; + /** + * Optional labels in key-value pair format. For more information about labels, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements). + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. The name of the gateway advertised route. Route names must be unique and use the following form: `projects/{project_number\}/locations/{region\}/spokes/{spoke\}/gatewayAdvertisedRoutes/{gateway_advertised_route_id\}` + */ + name?: string | null; + /** + * Optional. The priority of this advertised route. You can choose a value from `0` to `65335`. If you don't provide a value, Google Cloud assigns a priority of `100` to the ranges. + */ + priority?: number | null; + /** + * Optional. The recipient of this advertised route. + */ + recipient?: string | null; + /** + * Output only. The current lifecycle state of this gateway advertised route. + */ + state?: string | null; + /** + * Output only. The Google-generated UUID for the gateway advertised route. This value is unique across all gateway advertised route resources. If a gateway advertised route is deleted and another with the same name is created, the new route is assigned a different `unique_id`. + */ + uniqueId?: string | null; + /** + * Output only. The time the gateway advertised route was last updated. + */ + updateTime?: string | null; + } /** * The request message for Operations.CancelOperation. */ @@ -906,6 +972,15 @@ export namespace networkconnectivity_v1 { */ users?: string[] | null; } + /** + * A list of IP ranges that are reserved for this gateway's internal intfrastructure. + */ + export interface Schema$IpRangeReservation { + /** + * Required. A block of IP addresses used to allocate supporting infrastructure for this gateway. This block must not overlap with subnets in any spokes or peer VPC networks that the gateway can communicate with. Example: "10.1.2.0/24" + */ + ipRange?: string | null; + } /** * A collection of VLAN attachment resources. These resources should be redundant attachments that all advertise the same prefixes to Google Cloud. Alternatively, in active/passive configurations, all attachments should be capable of advertising the same prefixes. */ @@ -1102,6 +1177,23 @@ export namespace networkconnectivity_v1 { */ unreachable?: string[] | null; } + /** + * Response for HubService.ListGatewayAdvertisedRoutes method. + */ + export interface Schema$ListGatewayAdvertisedRoutesResponse { + /** + * The requested gateway advertised routes. + */ + gatewayAdvertisedRoutes?: Schema$GatewayAdvertisedRoute[]; + /** + * The token for the next page of the response. To see more results, use this value as the page_token for your next request. If this value is empty, there are no more results. + */ + nextPageToken?: string | null; + /** + * Hubs that could not be reached. + */ + unreachable?: string[] | null; + } /** * Response for HubService.ListGroups method. */ @@ -2339,6 +2431,10 @@ export namespace networkconnectivity_v1 { * Optional. The list of fields waiting for hub administrator's approval. */ fieldPathsPendingUpdate?: string[] | null; + /** + * Optional. This is a gateway that can apply specialized processing to traffic going through it. + */ + gateway?: Schema$Gateway; /** * Optional. The name of the group that this spoke is associated with. */ @@ -17468,8 +17564,13 @@ export namespace networkconnectivity_v1 { export class Resource$Projects$Locations$Spokes { context: APIRequestContext; + gatewayAdvertisedRoutes: Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes; constructor(context: APIRequestContext) { this.context = context; + this.gatewayAdvertisedRoutes = + new Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes( + this.context + ); } /** @@ -17518,6 +17619,7 @@ export namespace networkconnectivity_v1 { * // "description": "my_description", * // "etag": "my_etag", * // "fieldPathsPendingUpdate": [], + * // "gateway": {}, * // "group": "my_group", * // "hub": "my_hub", * // "labels": {}, @@ -17834,6 +17936,7 @@ export namespace networkconnectivity_v1 { * // "description": "my_description", * // "etag": "my_etag", * // "fieldPathsPendingUpdate": [], + * // "gateway": {}, * // "group": "my_group", * // "hub": "my_hub", * // "labels": {}, @@ -18281,6 +18384,7 @@ export namespace networkconnectivity_v1 { * // "description": "my_description", * // "etag": "my_etag", * // "fieldPathsPendingUpdate": [], + * // "gateway": {}, * // "group": "my_group", * // "hub": "my_hub", * // "labels": {}, @@ -18819,6 +18923,890 @@ export namespace networkconnectivity_v1 { requestBody?: Schema$TestIamPermissionsRequest; } + export class Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Create a GatewayAdvertisedRoute + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkconnectivity.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const networkconnectivity = google.networkconnectivity('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await networkconnectivity.projects.locations.spokes.gatewayAdvertisedRoutes.create( + * { + * // Required. Unique id for the route to create. + * gatewayAdvertisedRouteId: 'placeholder-value', + * // Required. The parent resource. + * parent: 'projects/my-project/locations/my-location/spokes/my-spoke', + * // Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "ipRange": "my_ipRange", + * // "labels": {}, + * // "name": "my_name", + * // "priority": 0, + * // "recipient": "my_recipient", + * // "state": "my_state", + * // "uniqueId": "my_uniqueId", + * // "updateTime": "my_updateTime" + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkconnectivity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/gatewayAdvertisedRoutes').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); + } + } + + /** + * Delete a GatewayAdvertisedRoute + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkconnectivity.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const networkconnectivity = google.networkconnectivity('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await networkconnectivity.projects.locations.spokes.gatewayAdvertisedRoutes.delete( + * { + * // Required. The name of the gateway advertised route to delete. + * name: 'projects/my-project/locations/my-location/spokes/my-spoke/gatewayAdvertisedRoutes/my-gatewayAdvertisedRoute', + * // Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkconnectivity.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); + } + } + + /** + * Get a GatewayAdvertisedRoute + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkconnectivity.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const networkconnectivity = google.networkconnectivity('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await networkconnectivity.projects.locations.spokes.gatewayAdvertisedRoutes.get( + * { + * // Required. The name of the gateway advertised route to get. + * name: 'projects/my-project/locations/my-location/spokes/my-spoke/gatewayAdvertisedRoutes/my-gatewayAdvertisedRoute', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "ipRange": "my_ipRange", + * // "labels": {}, + * // "name": "my_name", + * // "priority": 0, + * // "recipient": "my_recipient", + * // "state": "my_state", + * // "uniqueId": "my_uniqueId", + * // "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$Spokes$Gatewayadvertisedroutes$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkconnectivity.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); + } + } + + /** + * List GatewayAdvertisedRoutes + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkconnectivity.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const networkconnectivity = google.networkconnectivity('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await networkconnectivity.projects.locations.spokes.gatewayAdvertisedRoutes.list( + * { + * // An expression that filters the list of results. + * filter: 'placeholder-value', + * // Sort the results by a certain order. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of results per page that should be returned. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous `ListGatewayAdvertisedRoutes` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGatewayAdvertisedRoutes` must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The parent resource's name. + * parent: 'projects/my-project/locations/my-location/spokes/my-spoke', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "gatewayAdvertisedRoutes": [], + * // "nextPageToken": "my_nextPageToken", + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkconnectivity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/gatewayAdvertisedRoutes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Update a GatewayAdvertisedRoute + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkconnectivity.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const networkconnectivity = google.networkconnectivity('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await networkconnectivity.projects.locations.spokes.gatewayAdvertisedRoutes.patch( + * { + * // Identifier. The name of the gateway advertised route. Route names must be unique and use the following form: `projects/{project_number\}/locations/{region\}/spokes/{spoke\}/gatewayAdvertisedRoutes/{gateway_advertised_route_id\}` + * name: 'projects/my-project/locations/my-location/spokes/my-spoke/gatewayAdvertisedRoutes/my-gatewayAdvertisedRoute', + * // Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Optional. In the case of an update to an existing group, field mask is used to specify the fields to be overwritten. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not provide a mask, then all fields are overwritten. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "ipRange": "my_ipRange", + * // "labels": {}, + * // "name": "my_name", + * // "priority": 0, + * // "recipient": "my_recipient", + * // "state": "my_state", + * // "uniqueId": "my_uniqueId", + * // "updateTime": "my_updateTime" + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkconnectivity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Create extends StandardParameters { + /** + * Required. Unique id for the route to create. + */ + gatewayAdvertisedRouteId?: string; + /** + * Required. The parent resource. + */ + parent?: string; + /** + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GatewayAdvertisedRoute; + } + export interface Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Delete extends StandardParameters { + /** + * Required. The name of the gateway advertised route to delete. + */ + name?: string; + /** + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Get extends StandardParameters { + /** + * Required. The name of the gateway advertised route to get. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$List extends StandardParameters { + /** + * An expression that filters the list of results. + */ + filter?: string; + /** + * Sort the results by a certain order. + */ + orderBy?: string; + /** + * Optional. The maximum number of results per page that should be returned. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListGatewayAdvertisedRoutes` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGatewayAdvertisedRoutes` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent resource's name. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Spokes$Gatewayadvertisedroutes$Patch extends StandardParameters { + /** + * Identifier. The name of the gateway advertised route. Route names must be unique and use the following form: `projects/{project_number\}/locations/{region\}/spokes/{spoke\}/gatewayAdvertisedRoutes/{gateway_advertised_route_id\}` + */ + name?: string; + /** + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. In the case of an update to an existing group, field mask is used to specify the fields to be overwritten. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not provide a mask, then all fields are overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GatewayAdvertisedRoute; + } + export class Resource$Projects$Locations$Transports { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/networkmanagement/v1beta1.ts b/src/apis/networkmanagement/v1beta1.ts index c217e9f5cfe..d5c53c12f76 100644 --- a/src/apis/networkmanagement/v1beta1.ts +++ b/src/apis/networkmanagement/v1beta1.ts @@ -551,6 +551,10 @@ export namespace networkmanagement_v1beta1 { * A [Cloud Function](https://cloud.google.com/functions). Applicable only to source endpoint. */ cloudFunction?: Schema$CloudFunctionEndpoint; + /** + * A [Cloud Run](https://cloud.google.com/run) [job](https://docs.cloud.google.com/run/docs/reference/rest/v2/projects.locations.jobs#Job) URI. Applicable only to source endpoint. The format is: projects/{project\}/locations/{location\}/jobs/{job\} + */ + cloudRunJob?: string | null; /** * A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) Applicable only to source endpoint. */ diff --git a/src/apis/networkservices/v1beta1.ts b/src/apis/networkservices/v1beta1.ts index b2fe88a8dab..13254acc7f3 100644 --- a/src/apis/networkservices/v1beta1.ts +++ b/src/apis/networkservices/v1beta1.ts @@ -250,10 +250,6 @@ export namespace networkservices_v1beta1 { * Optional. A supported Google Cloud networking proxy in the Project and Location */ resourceUri?: string | null; - /** - * Optional. List of supported Google Cloud networking proxies in the Project and Location. resource_uris is mutually exclusive with resource_uri. - */ - resourceUris?: string[] | null; } /** * `AuthzExtension` is a resource that allows traffic forwarding to a callout backend service to make an authorization decision. @@ -2255,11 +2251,11 @@ export namespace networkservices_v1beta1 { */ description?: string | null; /** - * Optional. The name of the customer managed Cloud KMS key to be used to encrypt the `WasmPlugin` image (provided by image_uri) and configuration (provided by plugin_config_data or plugin_config_uri) that are stored by the `Service Extensions` product at rest. Format: "projects/{project\}/locations/{location\}/keyRings/{keyring\}/cryptoKeys/{key\}" By default, Google Cloud automatically encrypts all data at rest using Google-owned and Google-managed encryption keys. If you need ownership and control of the keys that protect your data at rest, you can specify a customer-managed encryption key (CMEK) to encrypt your `WasmPlugin` data. For more information, see [Using customer-managed encryption keys](https://cloud.google.com/kms/docs/cmek). + * Optional. The name of the customer-managed [CryptoKey](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys) to be used to encrypt the `WasmPlugin` image (provided by image_uri) and configuration (provided by plugin_config_data or plugin_config_uri) that are stored by the `Service Extensions` product at rest. Format: `projects/{project\}/locations/{location\}/keyRings/{keyring\}/cryptoKeys/{key\}` By default, Google Cloud automatically encrypts all data at rest using Google-owned and Google-managed encryption keys. If you need ownership and control of the keys that protect your data at rest, you can specify a customer-managed encryption key (CMEK) to encrypt your `WasmPlugin` data. For more information, see [Using customer-managed encryption keys](https://cloud.google.com/service-extensions/docs/cmek). */ kmsKeyName?: string | null; /** - * Output only. The name of the specific CryptoKeyVersion used to encrypt the `WasmPlugin` data, if the kms_key_name field is set. Format: "projects/{project\}/locations/{location\}/keyRings/{keyring\}/cryptoKeys/{key\}/cryptoKeyVersions/{version\}" This is a read-only field. `WasmPlugin` data is automatically encrypted using the most recent `CryptoKeyVersion` of the `CryptoKey` provided in the `kms_key_name` field. See [Cloud KMS resources](https://cloud.google.com/kms/docs/resource-hierarchy) for more information. + * Output only. The name of the specific [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions) used to encrypt the `WasmPlugin` data, if the kms_key_name field is set. Format: `projects/{project\}/locations/{location\}/keyRings/{keyring\}/cryptoKeys/{key\}/cryptoKeyVersions/{version\}` This is a read-only field. `WasmPlugin` data is automatically encrypted using the most recent `CryptoKeyVersion` of the `CryptoKey` provided in the `kms_key_name` field. See [Cloud KMS resources](https://cloud.google.com/kms/docs/resource-hierarchy) for more information. */ kmsKeyVersion?: string | null; /** diff --git a/src/apis/ondemandscanning/v1.ts b/src/apis/ondemandscanning/v1.ts index 926a0257ada..27fbe4fd1df 100644 --- a/src/apis/ondemandscanning/v1.ts +++ b/src/apis/ondemandscanning/v1.ts @@ -496,24 +496,76 @@ export namespace ondemandscanning_v1 { * Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. */ export interface Schema$CVSS { + /** + * Attack Complexity (AC). Defined in CVSS v2, v3, v4. + */ attackComplexity?: string | null; /** - * Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. + * Attack Requirements (AT). Defined in CVSS v4. + */ + attackRequirements?: string | null; + /** + * Attack Vector (AV). Defined in CVSS v2, v3, v4. */ attackVector?: string | null; + /** + * Authentication (Au). Defined in CVSS v2. + */ authentication?: string | null; + /** + * Availability Impact (A). Defined in CVSS v2, v3. + */ availabilityImpact?: string | null; /** * The base score is a function of the base metric scores. */ baseScore?: number | null; + /** + * Confidentiality Impact (C). Defined in CVSS v2, v3. + */ confidentialityImpact?: string | null; exploitabilityScore?: number | null; impactScore?: number | null; + /** + * Integrity Impact (I). Defined in CVSS v2, v3. + */ integrityImpact?: string | null; + /** + * Privileges Required (PR). Defined in CVSS v3, v4. + */ privilegesRequired?: string | null; + /** + * Scope (S). Defined in CVSS v3. + */ scope?: string | null; + /** + * Subsequent System Availability Impact (SA). Defined in CVSS v4. + */ + subsequentSystemAvailabilityImpact?: string | null; + /** + * Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + */ + subsequentSystemConfidentialityImpact?: string | null; + /** + * Subsequent System Integrity Impact (SI). Defined in CVSS v4. + */ + subsequentSystemIntegrityImpact?: string | null; + /** + * User Interaction (UI). Defined in CVSS v3, v4. + */ userInteraction?: string | null; + /** + * Vulnerable System Availability Impact (VA). Defined in CVSS v4. + */ + vulnerableSystemAvailabilityImpact?: string | null; + /** + * Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + */ + vulnerableSystemConfidentialityImpact?: string | null; + /** + * Vulnerable System Integrity Impact (VI). Defined in CVSS v4. + */ + vulnerableSystemIntegrityImpact?: string | null; } /** * The period during which some deployable was active in a runtime. diff --git a/src/apis/ondemandscanning/v1beta1.ts b/src/apis/ondemandscanning/v1beta1.ts index ce7a7d37890..7bd2938918e 100644 --- a/src/apis/ondemandscanning/v1beta1.ts +++ b/src/apis/ondemandscanning/v1beta1.ts @@ -492,24 +492,76 @@ export namespace ondemandscanning_v1beta1 { * Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. */ export interface Schema$CVSS { + /** + * Attack Complexity (AC). Defined in CVSS v2, v3, v4. + */ attackComplexity?: string | null; /** - * Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. + * Attack Requirements (AT). Defined in CVSS v4. + */ + attackRequirements?: string | null; + /** + * Attack Vector (AV). Defined in CVSS v2, v3, v4. */ attackVector?: string | null; + /** + * Authentication (Au). Defined in CVSS v2. + */ authentication?: string | null; + /** + * Availability Impact (A). Defined in CVSS v2, v3. + */ availabilityImpact?: string | null; /** * The base score is a function of the base metric scores. */ baseScore?: number | null; + /** + * Confidentiality Impact (C). Defined in CVSS v2, v3. + */ confidentialityImpact?: string | null; exploitabilityScore?: number | null; impactScore?: number | null; + /** + * Integrity Impact (I). Defined in CVSS v2, v3. + */ integrityImpact?: string | null; + /** + * Privileges Required (PR). Defined in CVSS v3, v4. + */ privilegesRequired?: string | null; + /** + * Scope (S). Defined in CVSS v3. + */ scope?: string | null; + /** + * Subsequent System Availability Impact (SA). Defined in CVSS v4. + */ + subsequentSystemAvailabilityImpact?: string | null; + /** + * Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + */ + subsequentSystemConfidentialityImpact?: string | null; + /** + * Subsequent System Integrity Impact (SI). Defined in CVSS v4. + */ + subsequentSystemIntegrityImpact?: string | null; + /** + * User Interaction (UI). Defined in CVSS v3, v4. + */ userInteraction?: string | null; + /** + * Vulnerable System Availability Impact (VA). Defined in CVSS v4. + */ + vulnerableSystemAvailabilityImpact?: string | null; + /** + * Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + */ + vulnerableSystemConfidentialityImpact?: string | null; + /** + * Vulnerable System Integrity Impact (VI). Defined in CVSS v4. + */ + vulnerableSystemIntegrityImpact?: string | null; } /** * The period during which some deployable was active in a runtime. diff --git a/src/apis/oracledatabase/v1.ts b/src/apis/oracledatabase/v1.ts index 0e94166609f..e30d91fdb04 100644 --- a/src/apis/oracledatabase/v1.ts +++ b/src/apis/oracledatabase/v1.ts @@ -141,6 +141,35 @@ export namespace oracledatabase_v1 { */ medium?: string | null; } + /** + * The Amazon S3 Iceberg storage. + */ + export interface Schema$AmazonS3IcebergStorage { + /** + * Required. The access key ID of Amazon S3. + */ + accessKeyId?: string | null; + /** + * Required. The bucket of Amazon S3. + */ + bucket?: string | null; + /** + * Optional. The endpoint of Amazon S3. + */ + endpoint?: string | null; + /** + * Required. The region of Amazon S3. + */ + region?: string | null; + /** + * Required. The scheme type of Amazon S3. + */ + schemeType?: string | null; + /** + * Optional. The secret access key of Amazon S3. + */ + secretAccessKeySecret?: string | null; + } /** * Details of the Autonomous Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/ */ @@ -727,6 +756,27 @@ export namespace oracledatabase_v1 { */ workloadUri?: string | null; } + /** + * The Azure Data Lake Storage Iceberg storage. + */ + export interface Schema$AzureDataLakeStorageIcebergStorage { + /** + * Optional. The account key of Azure Data Lake Storage. + */ + accountKeySecret?: string | null; + /** + * Required. The account of Azure Data Lake Storage. + */ + azureAccount?: string | null; + /** + * Required. The container of Azure Data Lake Storage. + */ + container?: string | null; + /** + * Optional. The endpoint of Azure Data Lake Storage. + */ + endpoint?: string | null; + } /** * The details of the database backup destination. */ @@ -1789,6 +1839,35 @@ export namespace oracledatabase_v1 { */ tags?: {[key: string]: string} | null; } + /** + * The deployment diagnostic data. + */ + export interface Schema$DeploymentDiagnosticData { + /** + * Output only. The bucket name. + */ + bucket?: string | null; + /** + * Output only. The time diagnostic end. + */ + diagnosticEndTime?: string | null; + /** + * Output only. The time diagnostic start. + */ + diagnosticStartTime?: string | null; + /** + * Output only. The diagnostic state. + */ + diagnosticState?: string | null; + /** + * Output only. The namespace name. + */ + namespace?: string | null; + /** + * Output only. The object name. + */ + object?: string | null; + } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} */ @@ -2119,849 +2198,3116 @@ export namespace oracledatabase_v1 { version?: string | null; } /** - * The identity connector details which will allow OCI to securely access the resources in the customer project. + * The Glue Iceberg catalog. */ - export interface Schema$IdentityConnector { - /** - * Output only. The connection state of the identity connector. - */ - connectionState?: string | null; + export interface Schema$GlueIcebergCatalog { /** - * Output only. A google managed service account on which customers can grant roles to access resources in the customer project. Example: `p176944527254-55-75119d87fd8f@gcp-sa-oci.iam.gserviceaccount.com` + * Required. The catalog ID of Glue. */ - serviceAgentEmail?: string | null; + glueId?: string | null; } /** - * The response for `AutonomousDatabaseBackup.List`. + * The properties of GoldengateAmazonKinesisConnection. */ - export interface Schema$ListAutonomousDatabaseBackupsResponse { + export interface Schema$GoldengateAmazonKinesisConnectionProperties { /** - * The list of Autonomous Database Backups. + * Optional. Access key ID to access the Amazon Kinesis. */ - autonomousDatabaseBackups?: Schema$AutonomousDatabaseBackup[]; + accessKeyId?: string | null; /** - * A token identifying a page of results the server should return. + * Optional. The name of the AWS region. If not provided, Goldengate will default to 'us-west-1'. */ - nextPageToken?: string | null; - } - /** - * The response for `AutonomousDatabaseCharacterSet.List`. - */ - export interface Schema$ListAutonomousDatabaseCharacterSetsResponse { + awsRegion?: string | null; /** - * The list of Autonomous Database Character Sets. + * Optional. The endpoint URL of the Amazon Kinesis service. e.g.: 'https://kinesis.us-east-1.amazonaws.com' If not provided, Goldengate will default to 'https://kinesis..amazonaws.com'. */ - autonomousDatabaseCharacterSets?: Schema$AutonomousDatabaseCharacterSet[]; + endpoint?: string | null; /** - * A token identifying a page of results the server should return. + * Optional. Secret access key to access the Amazon Kinesis. */ - nextPageToken?: string | null; + secretAccessKeySecret?: string | null; + /** + * Optional. The technology type of AmazonKinesisConnection. + */ + technologyType?: string | null; } /** - * The response for `AutonomousDatabase.List`. + * The properties of GoldengateAmazonRedshiftConnection. */ - export interface Schema$ListAutonomousDatabasesResponse { + export interface Schema$GoldengateAmazonRedshiftConnectionProperties { /** - * The list of Autonomous Databases. + * Optional. Connection URL. e.g.: 'jdbc:redshift://aws-redshift-instance.aaaaaaaaaaaa.us-east-2.redshift.amazonaws.com:5439/mydb' */ - autonomousDatabases?: Schema$AutonomousDatabase[]; + connectionUrl?: string | null; /** - * A token identifying a page of results the server should return. + * Optional. Input only. The password Oracle Goldengate uses for Amazon Redshift connection in plain text. */ - nextPageToken?: string | null; + password?: string | null; /** - * Unreachable locations when listing resources across all locations using wildcard location '-'. + * Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses for Amazon Redshift connection. Format: projects/{project\}/secrets/{secret\}/versions/{version\}. */ - unreachable?: string[] | null; - } - /** - * The response for `AutonomousDbVersion.List`. - */ - export interface Schema$ListAutonomousDbVersionsResponse { + passwordSecretVersion?: string | null; /** - * The list of Autonomous Database versions. + * Optional. The technology type of AmazonRedshiftConnection. */ - autonomousDbVersions?: Schema$AutonomousDbVersion[]; + technologyType?: string | null; /** - * A token identifying a page of results the server should return. + * Optional. The username Oracle Goldengate uses to connect the associated system of the given technology. */ - nextPageToken?: string | null; + username?: string | null; } /** - * The response for `CloudExadataInfrastructures.list`. + * The properties of GoldengateAmazonS3Connection. */ - export interface Schema$ListCloudExadataInfrastructuresResponse { + export interface Schema$GoldengateAmazonS3ConnectionProperties { /** - * The list of Exadata Infrastructures. + * Optional. Access key ID to access the Amazon S3 bucket. */ - cloudExadataInfrastructures?: Schema$CloudExadataInfrastructure[]; + accessKeyId?: string | null; /** - * A token for fetching next page of response. + * Optional. The Amazon Endpoint for S3. */ - nextPageToken?: string | null; + endpoint?: string | null; /** - * Unreachable locations when listing resources across all locations using wildcard location '-'. + * Optional. The name of the AWS region where the bucket is created. */ - unreachable?: string[] | null; + region?: string | null; + /** + * Optional. Secret access key to access the Amazon S3 bucket. + */ + secretAccessKeySecret?: string | null; + /** + * Optional. The technology type of AmazonS3Connection. + */ + technologyType?: string | null; } /** - * The response for `CloudVmCluster.List`. + * The properties of GoldengateAzureDataLakeStorageConnection. */ - export interface Schema$ListCloudVmClustersResponse { + export interface Schema$GoldengateAzureDataLakeStorageConnectionProperties { /** - * The list of VM Clusters. + * Optional. Sets the Azure storage account name. */ - cloudVmClusters?: Schema$CloudVmCluster[]; + account?: string | null; /** - * A token to fetch the next page of results. + * Optional. Azure storage account key. This property is required when 'authentication_type' is set to 'SHARED_KEY'. */ - nextPageToken?: string | null; + accountKeySecret?: string | null; /** - * Unreachable locations when listing resources across all locations using wildcard location '-'. + * Optional. Authentication mechanism to access Azure Data Lake Storage. */ - unreachable?: string[] | null; - } - /** - * The response for `DatabaseCharacterSet.List`. - */ - export interface Schema$ListDatabaseCharacterSetsResponse { + authenticationType?: string | null; /** - * The list of DatabaseCharacterSets. + * Optional. The endpoint used for authentication with Microsoft Entra ID (formerly Azure Active Directory). Default value: https://login.microsoftonline.com */ - databaseCharacterSets?: Schema$DatabaseCharacterSet[]; + azureAuthorityHost?: string | null; /** - * A token identifying a page of results the server should return. + * Optional. Azure tenant ID of the application. This property is required when 'authentication_type' is set to 'AZURE_ACTIVE_DIRECTORY'. */ - nextPageToken?: string | null; - } - /** - * The response for `Database.List`. - */ - export interface Schema$ListDatabasesResponse { + azureTenantId?: string | null; /** - * The list of Databases. + * Optional. Azure client ID of the application. This property is required when 'authentication_type' is set to 'AZURE_ACTIVE_DIRECTORY'. */ - databases?: Schema$Database[]; + clientId?: string | null; /** - * A token identifying a page of results the server should return. + * Optional. Azure client secret (aka application password) for authentication. */ - nextPageToken?: string | null; - } - /** - * The response for `DbNode.List`. - */ - export interface Schema$ListDbNodesResponse { + clientSecret?: string | null; /** - * The list of DB Nodes + * Optional. Azure Storage service endpoint. e.g: https://test.blob.core.windows.net */ - dbNodes?: Schema$DbNode[]; + endpoint?: string | null; /** - * A token identifying a page of results the node should return. + * Optional. Credential that uses a shared access signature (SAS) to authenticate to an Azure Service. */ - nextPageToken?: string | null; + sasTokenSecret?: string | null; + /** + * Optional. The technology type of AzureDataLakeStorageConnection. + */ + technologyType?: string | null; } /** - * The response for `DbServer.List`. + * The properties of GoldengateAzureSynapseAnalyticsConnection. */ - export interface Schema$ListDbServersResponse { + export interface Schema$GoldengateAzureSynapseAnalyticsConnectionProperties { /** - * The list of database servers. + * Optional. JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;' */ - dbServers?: Schema$DbServer[]; + connectionString?: string | null; /** - * A token identifying a page of results the server should return. + * Optional. Input only. The password Oracle Goldengate uses for Azure Synapse Analytics connection in plain text. */ - nextPageToken?: string | null; - } - /** - * The response for `DbSystemInitialStorageSizes.List`. - */ - export interface Schema$ListDbSystemInitialStorageSizesResponse { + password?: string | null; /** - * The list of DbSystemInitialStorageSizes. + * Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses for Azure Synapse Analytics connection. Format: projects/{project\}/secrets/{secret\}/versions/{version\}. */ - dbSystemInitialStorageSizes?: Schema$DbSystemInitialStorageSize[]; + passwordSecretVersion?: string | null; /** - * A token identifying a page of results the server should return. + * Optional. The technology type of AzureSynapseAnalyticsConnection. */ - nextPageToken?: string | null; + technologyType?: string | null; + /** + * Optional. The username Oracle Goldengate uses to connect the associated system of the given technology. + */ + username?: string | null; } /** - * The response for `DbSystemShape.List`. + * The backup schedule of the GoldengateDeployment. */ - export interface Schema$ListDbSystemShapesResponse { + export interface Schema$GoldengateBackupSchedule { /** - * The list of Database System shapes. + * Output only. The timestamp of when the backup was scheduled. */ - dbSystemShapes?: Schema$DbSystemShape[]; + backupScheduledTime?: string | null; /** - * A token identifying a page of results the server should return. + * Output only. The bucket name. */ - nextPageToken?: string | null; - } - /** - * The response for `DbSystem.List`. - */ - export interface Schema$ListDbSystemsResponse { + bucket?: string | null; /** - * The list of DbSystems. + * Output only. The compartment id. */ - dbSystems?: Schema$DbSystem[]; + compartmentId?: string | null; /** - * A token identifying a page of results the server should return. + * Output only. The frequency backup scheduled. */ - nextPageToken?: string | null; + frequencyBackupScheduled?: string | null; /** - * Unreachable locations when listing resources across all locations using wildcard location '-'. + * Output only. If metadata only. */ - unreachable?: string[] | null; + metadataOnly?: boolean | null; + /** + * Output only. The namespace name. + */ + namespace?: string | null; } /** - * The response for `DbVersions.List`. + * Details of the GoldengateConnection resource. */ - export interface Schema$ListDbVersionsResponse { + export interface Schema$GoldengateConnection { /** - * The list of DbVersions. + * Output only. The date and time that the GoldengateConnection was created. */ - dbVersions?: Schema$DbVersion[]; + createTime?: string | null; /** - * A token identifying a page of results the server should return. + * Output only. The ID of the subscription entitlement associated with the GoldengateConnection. */ - nextPageToken?: string | null; - } - /** - * The response for `Entitlement.List`. - */ - export interface Schema$ListEntitlementsResponse { + entitlementId?: string | null; /** - * The list of Entitlements + * Optional. The GCP Oracle zone where Oracle GoldengateConnection is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability. */ - entitlements?: Schema$Entitlement[]; + gcpOracleZone?: string | null; /** - * A token identifying a page of results the server should return. + * Optional. The labels or tags associated with the GoldengateConnection. */ - nextPageToken?: string | null; - } - /** - * The response for `ExadbVmCluster.List`. - */ - export interface Schema$ListExadbVmClustersResponse { + labels?: {[key: string]: string} | null; /** - * The list of ExadbVmClusters. + * Identifier. The name of the GoldengateConnection resource in the following format: projects/{project\}/locations/{region\}/goldengateConnections/{goldengate_connection\} */ - exadbVmClusters?: Schema$ExadbVmCluster[]; + name?: string | null; /** - * A token identifying a page of results the server should return. + * Output only. HTTPS link to OCI resources exposed to Customer via UI Interface. */ - nextPageToken?: string | null; + ociUrl?: string | null; /** - * Unreachable locations when listing resources across all locations using wildcard location '-'. + * Optional. The name of the OdbNetwork associated with the GoldengateConnection. The format is projects/{project\}/locations/{location\}/odbNetworks/{odb_network\}. It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet. */ - unreachable?: string[] | null; + odbNetwork?: string | null; + /** + * Optional. The name of the OdbSubnet associated with the GoldengateConnection for IP allocation. Format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\}/odbSubnets/{odb_subnet\} + */ + odbSubnet?: string | null; + /** + * Required. The properties of the GoldengateConnection. + */ + properties?: Schema$GoldengateConnectionProperties; } /** - * The response for `ExascaleDbStorageVault.List`. + * Represents the metadata of a Goldengate Connection Assignment. */ - export interface Schema$ListExascaleDbStorageVaultsResponse { + export interface Schema$GoldengateConnectionAssignment { /** - * The ExascaleDbStorageVaults. + * Output only. The time when the connection assignment was created. */ - exascaleDbStorageVaults?: Schema$ExascaleDbStorageVault[]; + createTime?: string | null; /** - * A token identifying a page of results the server should return. If present, the next page token can be provided to a subsequent ListExascaleDbStorageVaults call to list the next page. If empty, there are no more pages. + * Optional. The display name for the GoldengateConnectionAssignment. */ - nextPageToken?: string | null; + displayName?: string | null; /** - * Unreachable locations when listing resources across all locations using wildcard location '-'. + * Output only. The OCID of the entitlement linked to this resource. */ - unreachable?: string[] | null; - } - /** - * The response for `GiVersion.List`. - */ - export interface Schema$ListGiVersionsResponse { + entitlementId?: string | null; /** - * The list of Oracle Grid Infrastructure (GI) versions. + * Optional. The labels or tags associated with the GoldengateConnectionAssignment. */ - giVersions?: Schema$GiVersion[]; + labels?: {[key: string]: string} | null; /** - * A token identifying a page of results the server should return. + * Identifier. The name of the GoldengateConnectionAssignment resource in the following format: projects/{project\}/locations/{region\}/goldengateConnectionAssignments/{goldengate_connection_assignment\} */ - nextPageToken?: string | null; + name?: string | null; + /** + * Required. The properties of the GoldengateConnectionAssignment. + */ + properties?: Schema$GoldengateConnectionAssignmentProperties; } /** - * The response message for Locations.ListLocations. + * The properties of a GoldengateConnectionAssignment. */ - export interface Schema$ListLocationsResponse { + export interface Schema$GoldengateConnectionAssignmentProperties { /** - * A list of locations that matches the specified filter in the request. + * Output only. Credential store alias. */ - locations?: Schema$Location[]; + alias?: string | null; /** - * The standard List next-page token. + * Required. The GoldengateConnection resource to be assigned. Format: projects/{project\}/locations/{location\}/goldengateConnections/{goldengate_connection\} */ - nextPageToken?: string | null; - } - /** - * The response for `MinorVersion.List`. - */ - export interface Schema$ListMinorVersionsResponse { + goldengateConnection?: string | null; /** - * The list of MinorVersions. + * Required. The GoldenGateDeployment to assign the connection to. Format: projects/{project\}/locations/{location\}/goldengateDeployments/{goldengate_deployment\} */ - minorVersions?: Schema$MinorVersion[]; + goldengateDeployment?: string | null; /** - * A token identifying a page of results the server should return. + * Output only. The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the connection assignment being referenced. */ - nextPageToken?: string | null; + ocid?: string | null; + /** + * Output only. The lifecycle state of the connection assignment. + */ + state?: string | null; } /** - * The response for `OdbNetwork.List`. + * The properties of a GoldengateConnection. */ - export interface Schema$ListOdbNetworksResponse { + export interface Schema$GoldengateConnectionProperties { /** - * A token identifying a page of results the server should return. + * Properties for an Amazon Kinesis connection. */ - nextPageToken?: string | null; + amazonKinesisConnectionProperties?: Schema$GoldengateAmazonKinesisConnectionProperties; /** - * The list of ODB Networks. + * Properties for an Amazon Redshift connection. */ - odbNetworks?: Schema$OdbNetwork[]; + amazonRedshiftConnectionProperties?: Schema$GoldengateAmazonRedshiftConnectionProperties; /** - * Unreachable locations when listing resources across all locations using wildcard location '-'. + * Properties for an Amazon S3 connection. */ - unreachable?: string[] | null; - } - /** - * The response for `OdbSubnet.List`. - */ - export interface Schema$ListOdbSubnetsResponse { + amazonS3ConnectionProperties?: Schema$GoldengateAmazonS3ConnectionProperties; /** - * A token identifying a page of results the server should return. + * Properties for an Azure Data Lake Storage Connection. */ - nextPageToken?: string | null; + azureDataLakeStorageConnectionProperties?: Schema$GoldengateAzureDataLakeStorageConnectionProperties; /** - * The list of ODB Subnets. + * Properties for an Azure Synapse Analytics connection. */ - odbSubnets?: Schema$OdbSubnet[]; + azureSynapseAnalyticsConnectionProperties?: Schema$GoldengateAzureSynapseAnalyticsConnectionProperties; /** - * Unreachable locations when listing resources across all locations using wildcard location '-'. + * Required. The connection type. */ - unreachable?: string[] | null; - } - /** - * The response message for Operations.ListOperations. - */ - export interface Schema$ListOperationsResponse { + connectionType?: string | null; /** - * The standard List next-page token. + * Properties for a Databricks connection. */ - nextPageToken?: string | null; + databricksConnectionProperties?: Schema$GoldengateDatabricksConnectionProperties; /** - * A list of operations that matches the specified filter in the request. + * Properties for a DB2 connection. */ - operations?: Schema$Operation[]; + db2ConnectionProperties?: Schema$GoldengateDb2ConnectionProperties; /** - * 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. + * Optional. Metadata about this specific object. */ - unreachable?: string[] | null; - } - /** - * The response for `PluggableDatabase.List`. - */ - export interface Schema$ListPluggableDatabasesResponse { + description?: string | null; /** - * A token identifying a page of results the server should return. + * Required. An object's Display Name. */ - nextPageToken?: string | null; + displayName?: string | null; /** - * The list of PluggableDatabases. + * Properties for an Elasticsearch connection. */ - pluggableDatabases?: Schema$PluggableDatabase[]; - } - /** - * A resource that represents a Google Cloud location. - */ - export interface Schema$Location { + elasticsearchConnectionProperties?: Schema$GoldengateElasticsearchConnectionProperties; /** - * The friendly name for this location, typically a nearby city name. For example, "Tokyo". + * Properties for a Generic Connection. */ - displayName?: string | null; + genericConnectionProperties?: Schema$GoldengateGenericConnectionProperties; /** - * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\} + * Properties for a Goldengate Connection. */ - labels?: {[key: string]: string} | null; + goldengateConnectionProperties?: Schema$GoldengateGoldengateConnectionProperties; /** - * The canonical id for this location. For example: `"us-east1"`. + * Properties for a Google BigQuery Connection. */ - locationId?: string | null; + googleBigQueryConnectionProperties?: Schema$GoldengateGoogleBigQueryConnectionProperties; /** - * Service-specific metadata. For example the available capacity at the given location. + * Properties for a Google Cloud Storage Connection. */ - metadata?: {[key: string]: any} | null; + googleCloudStorageConnectionProperties?: Schema$GoldengateGoogleCloudStorageConnectionProperties; /** - * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` + * Properties for a Google Pub/Sub connection. */ - name?: string | null; - } - /** - * Metadata for a given Location. - */ - export interface Schema$LocationMetadata { + googlePubsubConnectionProperties?: Schema$GoldengateGooglePubsubConnectionProperties; /** - * Output only. Google Cloud Platform Oracle zones in a location. + * Properties for an HDFS connection. */ - gcpOracleZones?: string[] | null; - } - /** - * Maintenance window as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/MaintenanceWindow - */ - export interface Schema$MaintenanceWindow { + hdfsConnectionProperties?: Schema$GoldengateHdfsConnectionProperties; /** - * Optional. Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). + * Properties for an Iceberg connection. */ - customActionTimeoutMins?: number | null; + icebergConnectionProperties?: Schema$GoldengateIcebergConnectionProperties; /** - * Optional. Days during the week when maintenance should be performed. + * Output only. The Ingress IPs of the GoldengateConnection. */ - daysOfWeek?: string[] | null; + ingressIpAddresses?: string[] | null; /** - * Optional. The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are: 0 - represents time slot 0:00 - 3:59 UTC 4 - represents time slot 4:00 - 7:59 UTC 8 - represents time slot 8:00 - 11:59 UTC 12 - represents time slot 12:00 - 15:59 UTC 16 - represents time slot 16:00 - 19:59 UTC 20 - represents time slot 20:00 - 23:59 UTC + * Properties for a Java Message Service connection. */ - hoursOfDay?: number[] | null; + javaMessageServiceConnectionProperties?: Schema$GoldengateJavaMessageServiceConnectionProperties; /** - * Optional. If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. + * Properties for a Kafka Connection. */ - isCustomActionTimeoutEnabled?: boolean | null; + kafkaConnectionProperties?: Schema$GoldengateKafkaConnectionProperties; /** - * Optional. Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. + * Properties for a Kafka Schema Registry Connection. */ - leadTimeWeek?: number | null; + kafkaSchemaRegistryConnectionProperties?: Schema$GoldengateKafkaSchemaRegistryConnectionProperties; /** - * Optional. Months during the year when maintenance should be performed. + * Output only. Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state. */ - months?: string[] | null; + lifecycleDetails?: string | null; /** - * Optional. Cloud CloudExadataInfrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. + * Output only. The lifecycle state of the connection. */ - patchingMode?: string | null; + lifecycleState?: string | null; /** - * Optional. The maintenance window scheduling preference. + * Properties for a Microsoft Fabric connection. */ - preference?: string | null; + microsoftFabricConnectionProperties?: Schema$GoldengateMicrosoftFabricConnectionProperties; /** - * Optional. Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. + * Properties for a Microsoft SQL Server connection. */ - weeksOfMonth?: number[] | null; - } - /** - * MinorVersion represents a minor version of a GI. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/GiMinorVersionSummary/ - */ - export interface Schema$MinorVersion { + microsoftSqlserverConnectionProperties?: Schema$GoldengateMicrosoftSqlserverConnectionProperties; /** - * Optional. The ID of the Grid Image. + * Properties for a MongoDB connection. */ - gridImageId?: string | null; + mongodbConnectionProperties?: Schema$GoldengateMongodbConnectionProperties; /** - * Identifier. The name of the MinorVersion resource with the format: projects/{project\}/locations/{region\}/giVersions/{gi_version\}/minorVersions/{minor_version\} + * Properties for a Mysql Connection. */ - name?: string | null; + mysqlConnectionProperties?: Schema$GoldengateMysqlConnectionProperties; /** - * Optional. The valid Oracle grid infrastructure software version. + * Output only. The [OCID] of the connection being referenced. */ - version?: string | null; - } - /** - * Represents OdbNetwork resource. - */ - export interface Schema$OdbNetwork { + ocid?: string | null; /** - * Output only. The date and time that the OdbNetwork was created. + * Properties for an OCI Object Storage Connection. */ - createTime?: string | null; + ociObjectStorageConnectionProperties?: Schema$GoldengateOciObjectStorageConnectionProperties; /** - * Output only. The ID of the subscription entitlement associated with the OdbNetwork. + * Properties for an Oracle AI Data Platform connection. */ - entitlementId?: string | null; + oracleAiDataPlatformConnectionProperties?: Schema$GoldengateOracleAIDataPlatformConnectionProperties; /** - * Optional. The GCP Oracle zone where OdbNetwork is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability. + * Properties for an Oracle Database Connection. */ - gcpOracleZone?: string | null; + oracleConnectionProperties?: Schema$GoldengateOracleConnectionProperties; /** - * Optional. Labels or tags associated with the resource. + * Properties for an Oracle NoSQL connection. */ - labels?: {[key: string]: string} | null; + oracleNosqlConnectionProperties?: Schema$GoldengateOracleNosqlConnectionProperties; /** - * Identifier. The name of the OdbNetwork resource in the following format: projects/{project\}/locations/{region\}/odbNetworks/{odb_network\} + * Properties for a PostgreSQL connection. */ - name?: string | null; + postgresqlConnectionProperties?: Schema$GoldengatePostgresqlConnectionProperties; /** - * Required. The name of the VPC network in the following format: projects/{project\}/global/networks/{network\} + * Properties for a Redis connection. */ - network?: string | null; + redisConnectionProperties?: Schema$GoldengateRedisConnectionProperties; /** - * Output only. State of the ODB Network. + * Optional. The routing method for the GoldengateConnection. */ - state?: string | null; + routingMethod?: string | null; + /** + * Properties for a Snowflake connection. + */ + snowflakeConnectionProperties?: Schema$GoldengateSnowflakeConnectionProperties; + /** + * Output only. The time the resource was last updated. + */ + updateTime?: string | null; } /** - * Represents OdbSubnet resource. + * Details of the Goldengate Connection Type resource. */ - export interface Schema$OdbSubnet { + export interface Schema$GoldengateConnectionType { /** - * Required. The CIDR range of the subnet. + * Output only. The connection type of the Goldengate Connection Type resource. */ - cidrRange?: string | null; + connectionType?: string | null; /** - * Output only. The date and time that the OdbNetwork was created. + * Identifier. The name of the Goldengate Connection Type resource with the format: projects/{project\}/locations/{region\}/goldengateConnectionTypes/{goldengate_connection_type\} */ - createTime?: string | null; + name?: string | null; /** - * Optional. Labels or tags associated with the resource. + * Output only. The technology type of the Goldengate Connection Type resource. */ - labels?: {[key: string]: string} | null; + technologyTypes?: string[] | null; + } + /** + * The properties of GoldengateDatabricksConnection. + */ + export interface Schema$GoldengateDatabricksConnectionProperties { /** - * Identifier. The name of the OdbSubnet resource in the following format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\}/odbSubnets/{odb_subnet\} + * Optional. Authentication type for Databricks. */ - name?: string | null; + authenticationType?: string | null; /** - * Required. Purpose of the subnet. + * Optional. OAuth client id, only applicable for authentication_type == OAUTH_M2M */ - purpose?: string | null; + clientId?: string | null; /** - * Output only. State of the ODB Subnet. + * Optional. OAuth client secret, only applicable for authentication_type == OAUTH_M2M */ - state?: string | null; - } - /** - * This resource represents a long-running operation that is the result of a network API call. - */ - export interface Schema$Operation { + clientSecret?: string | null; /** - * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. + * Optional. Connection URL. e.g.: 'jdbc:databricks://adb-33934.4.azuredatabricks.net:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/3393########44/0##3-7-hlrb' */ - done?: boolean | null; + connectionUrl?: string | null; /** - * The error result of the operation in case of failure or cancellation. + * Optional. Input only. The password used to connect to Databricks in plain text. */ - error?: Schema$Status; + password?: string | null; /** - * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + * Optional. Input only. The resource name of a secret version in Secret Manager which contains the password used to connect to Databricks. Format: projects/{project\}/secrets/{secret\}/versions/{version\}. */ - metadata?: {[key: string]: any} | null; + passwordSecretVersion?: string | null; /** - * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id\}`. + * Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or Cloud Storage. */ - name?: string | null; + storageCredential?: string | null; /** - * The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * Optional. The technology type of DatabricksConnection. */ - response?: {[key: string]: any} | null; + technologyType?: string | null; } /** - * Represents the metadata of the long-running operation. + * The properties of GoldengateDb2Connection. */ - export interface Schema$OperationMetadata { + export interface Schema$GoldengateDb2ConnectionProperties { /** - * Output only. API version used to start the operation. + * Optional. An array of name-value pair attribute entries. Used as additional parameters in connection string. */ - apiVersion?: string | null; + additionalAttributes?: Schema$NameValuePair[]; /** - * Output only. The time the operation was created. + * Optional. The name of the database. */ - createTime?: string | null; + database?: string | null; /** - * Output only. The time the operation finished running. + * Optional. The name or address of a host. */ - endTime?: string | null; + host?: string | null; /** - * Output only. An estimated percentage of the operation that has been completed at a given moment of time, between 0 and 100. + * Optional. Input only. The password Oracle Goldengate uses for Db2 connection in plain text. */ - percentComplete?: number | null; + password?: string | null; /** - * Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses for Db2 connection. Format: projects/{project\}/secrets/{secret\}/versions/{version\}. */ - requestedCancellation?: boolean | null; + passwordSecretVersion?: string | null; /** - * Output only. The status of the operation. + * Optional. The port of an endpoint usually specified for a connection. */ - statusMessage?: string | null; + port?: number | null; /** - * Output only. Server-defined resource path for the target of the operation. + * Optional. Security protocol for the DB2 database. */ - target?: string | null; + securityProtocol?: string | null; /** - * Output only. Name of the verb executed by the operation. + * Optional. The keystash file which contains the encrypted password to the key database file. Not supported for IBM Db2 for i. */ - verb?: string | null; + sslClientKeystashFile?: string | null; + /** + * Optional. The keystore file created at the client containing the server certificate / CA root certificate. Not supported for IBM Db2 for i. + */ + sslClientKeystoredbFile?: string | null; + /** + * Optional. The file which contains the self-signed server certificate / Certificate Authority (CA) certificate. + */ + sslServerCertificateFile?: string | null; + /** + * Optional. The technology type of Db2Connection. + */ + technologyType?: string | null; + /** + * Optional. The username Oracle Goldengate uses to connect to the DB2 database. + */ + username?: string | null; } /** - * The PluggableDatabase resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/PluggableDatabase/ + * GoldengateDeployment Goldengate Deployment resource model. */ - export interface Schema$PluggableDatabase { + export interface Schema$GoldengateDeployment { /** - * Output only. The date and time that the PluggableDatabase was created. + * Output only. The date and time that the GoldengateDeployment was created. */ createTime?: string | null; /** - * Identifier. The name of the PluggableDatabase resource in the following format: projects/{project\}/locations/{region\}/pluggableDatabases/{pluggable_database\} + * Required. The display name for the GoldengateDeployment. */ - name?: string | null; + displayName?: string | null; /** - * Output only. HTTPS link to OCI resources exposed to Customer via UI Interface. + * Output only. The ID of the subscription entitlement associated with the GoldengateDeployment */ - ociUrl?: string | null; + entitlementId?: string | null; /** - * Optional. The properties of the PluggableDatabase. + * Optional. The GCP Oracle zone where Oracle GoldengateDeployment is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability. */ - properties?: Schema$PluggableDatabaseProperties; - } - /** - * The connection strings used to connect to the Oracle Database. - */ - export interface Schema$PluggableDatabaseConnectionStrings { + gcpOracleZone?: string | null; /** - * Optional. All connection strings to use to connect to the pluggable database. + * Optional. The labels or tags associated with the GoldengateDeployment. */ - allConnectionStrings?: {[key: string]: string} | null; + labels?: {[key: string]: string} | null; /** - * Optional. The default connection string to use to connect to the pluggable database. + * Identifier. The name of the GoldengateDeployment resource in the following format: projects/{project\}/locations/{region\}/goldengateDeployments/{goldengate_deployment\} */ - pdbDefault?: string | null; + name?: string | null; /** - * Optional. The default connection string to use to connect to the pluggable database using IP. + * Output only. HTTPS link to OCI resources exposed to Customer via UI Interface. */ - pdbIpDefault?: string | null; - } - /** - * The Pluggable Database Node Level Details. - */ - export interface Schema$PluggableDatabaseNodeLevelDetails { + ociUrl?: string | null; /** - * Required. The Node name of the Database home. + * Optional. The name of the OdbNetwork associated with the GoldengateDeployment. */ - nodeName?: string | null; + odbNetwork?: string | null; /** - * Required. The mode that the pluggable database is in to open it. + * Required. The name of the OdbSubnet associated with the GoldengateDeployment for IP allocation. */ - openMode?: string | null; + odbSubnet?: string | null; /** - * Required. The OCID of the Pluggable Database. + * Required. The properties of the GoldengateDeployment. */ - pluggableDatabaseId?: string | null; + properties?: Schema$GoldengateDeploymentProperties; } /** - * The properties of a PluggableDatabase. + * Details of the Goldengate Deployment Environment resource. */ - export interface Schema$PluggableDatabaseProperties { + export interface Schema$GoldengateDeploymentEnvironment { /** - * Required. The OCID of the compartment. + * Output only. Whether auto scaling is enabled by default for the Goldengate Deployment Environment resource. */ - compartmentId?: string | null; + autoScalingEnabled?: boolean | null; /** - * Optional. The Connection strings used to connect to the Oracle Database. + * Output only. The category of the Goldengate Deployment Environment resource. */ - connectionStrings?: Schema$PluggableDatabaseConnectionStrings; + category?: string | null; /** - * Required. The OCID of the CDB. + * Output only. The default CPU core count of the Goldengate Deployment Environment resource. */ - containerDatabaseOcid?: string | null; + defaultCpuCoreCount?: number | null; /** - * Output only. The configuration of the Database Management service. + * The display name of the Goldengate Deployment Environment resource. */ - databaseManagementConfig?: Schema$DatabaseManagementConfig; + displayName?: string | null; /** - * Optional. Defined tags for this resource. Each key is predefined and scoped to a namespace. + * Output only. The environment type of the Goldengate Deployment Environment resource. */ - definedTags?: {[key: string]: Schema$DefinedTagValue} | null; + environmentType?: string | null; /** - * Optional. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. + * Output only. The max CPU core count of the Goldengate Deployment Environment resource. */ - freeformTags?: {[key: string]: string} | null; + maxCpuCoreCount?: number | null; /** - * Optional. The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it. + * Output only. The memory per CPU core in GBs of the Goldengate Deployment Environment resource. */ - isRestricted?: boolean | null; + memoryGbPerCpuCore?: number | null; /** - * Output only. Additional information about the current lifecycle state. + * Output only. The min CPU core count of the Goldengate Deployment Environment resource. */ - lifecycleDetails?: string | null; + minCpuCoreCount?: number | null; /** - * Output only. The current state of the pluggable database. + * Identifier. The name of the Goldengate Deployment Environment resource with the format: projects/{project\}/locations/{location\}/goldengateDeploymentEnvironments/{goldengate_deployment_environment\} */ - lifecycleState?: string | null; + name?: string | null; /** - * Output only. The OCID of the pluggable database. + * Output only. The network bandwidth per CPU core in Gbps of the Goldengate Deployment Environment resource. */ - ocid?: string | null; + networkBandwidthGbpsPerCpuCore?: number | null; /** - * Output only. The status of Operations Insights for this Database. + * Output only. The storage usage limit per CPU core in GBs of the Goldengate Deployment Environment resource. */ - operationsInsightsState?: string | null; + storageUsageLimitGbPerCpuCore?: number | null; + } + /** + * The lock of the GoldengateDeployment. + */ + export interface Schema$GoldengateDeploymentLock { /** - * Required. The database name. + * Output only. The compartment id. */ - pdbName?: string | null; + compartmentId?: string | null; /** - * Optional. Pluggable Database Node Level Details + * Output only. The time created. */ - pdbNodeLevelDetails?: Schema$PluggableDatabaseNodeLevelDetails[]; + createTime?: string | null; + /** + * Output only. The message. + */ + message?: string | null; + /** + * Output only. The related resource id. + */ + relatedResourceId?: string | null; + /** + * Output only. The type of lock. + */ + type?: string | null; } /** - * The request for `ExadbVmCluster.RemoveVirtualMachine`. + * Properties of GoldengateDeployment. */ - export interface Schema$RemoveVirtualMachineExadbVmClusterRequest { + export interface Schema$GoldengateDeploymentProperties { /** - * Required. The list of host names of db nodes to be removed from the ExadbVmCluster. + * Output only. The backup schedule of the GoldengateDeployment. */ - hostnames?: string[] | null; + backupSchedule?: Schema$GoldengateBackupSchedule; /** - * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * Output only. The category of the GoldengateDeployment. */ - requestId?: string | null; + category?: string | null; + /** + * Optional. The Minimum number of OCPUs to be made available for this Deployment. + */ + cpuCoreCount?: number | null; + /** + * Output only. The deployment backup id of the GoldengateDeployment. + */ + deploymentBackupId?: string | null; + /** + * Output only. The deployment diagnostic data of the GoldengateDeployment. + */ + deploymentDiagnosticData?: Schema$DeploymentDiagnosticData; + /** + * Output only. The deployment role of the GoldengateDeployment. + */ + deploymentRole?: string | null; + /** + * Required. A valid Goldengate Deployment type. For a list of supported types, use the `ListGoldengateDeploymentTypes` operation. + */ + deploymentType?: string | null; + /** + * Output only. The deployment url of the GoldengateDeployment. + */ + deploymentUrl?: string | null; + /** + * Optional. The description of the GoldengateDeployment. + */ + description?: string | null; + /** + * Optional. The environment type of the GoldengateDeployment. + */ + environmentType?: string | null; + /** + * Output only. The Fully Qualified Domain Name of the GoldengateDeployment. + */ + fqdn?: string | null; + /** + * Output only. Whether the GoldengateDeployment is healthy. + */ + healthy?: boolean | null; + /** + * Output only. The ingress ips of the GoldengateDeployment. + */ + ingressIps?: Schema$IngressIp[]; + /** + * Optional. Indicates if auto scaling is enabled for the Deployment's CPU core count. + */ + isAutoScalingEnabled?: boolean | null; + /** + * Output only. Whether the GoldengateDeployment is of the latest version. + */ + isLatestVersion?: boolean | null; + /** + * Output only. Whether the GoldengateDeployment is public. + */ + isPublic?: boolean | null; + /** + * Output only. Whether storage utilization limit is exceeded of the GoldengateDeployment. + */ + isStorageUtilizationLimitExceeded?: boolean | null; + /** + * Output only. The time last backup scheduled of the GoldengateDeployment. + */ + lastBackupScheduleTime?: string | null; + /** + * Optional. The Oracle license model that applies to a Deployment. + */ + licenseModel?: string | null; + /** + * Output only. The lifecycle details of the GoldengateDeployment. + */ + lifecycleDetails?: string | null; + /** + * Output only. State of the GoldengateDeployment. + */ + lifecycleState?: string | null; + /** + * Output only. The lifecycle sub-state of the GoldengateDeployment. + */ + lifecycleSubState?: string | null; + /** + * Output only. The load balancer id of the GoldengateDeployment. + */ + loadBalancerId?: string | null; + /** + * Output only. The load balancer subnet id of the GoldengateDeployment. + */ + loadBalancerSubnetId?: string | null; + /** + * Output only. The locks of the GoldengateDeployment. + */ + locks?: Schema$GoldengateDeploymentLock[]; + /** + * Optional. The maintenance configuration of the GoldengateDeployment. + */ + maintenanceConfig?: Schema$GoldengateMaintenanceConfig; + /** + * Optional. The maintenance window of the GoldengateDeployment. + */ + maintenanceWindow?: Schema$GoldengateMaintenanceWindow; + /** + * Output only. The time next backup scheduled of the GoldengateDeployment. + */ + nextBackupScheduleTime?: string | null; + /** + * Output only. The next maintenance action type of the GoldengateDeployment. + */ + nextMaintenanceActionType?: string | null; + /** + * Output only. The next maintenance description of the GoldengateDeployment. + */ + nextMaintenanceDescription?: string | null; + /** + * Output only. The time of next maintenance of the GoldengateDeployment. + */ + nextMaintenanceTime?: string | null; + /** + * Output only. The nsg ids of the GoldengateDeployment. + */ + nsgIds?: string[] | null; + /** + * Output only. OCID of the GoldengateDeployment. + */ + ocid?: string | null; + /** + * Required. The ogg data of the GoldengateDeployment. + */ + oggData?: Schema$GoldengateOggDeployment; + /** + * Output only. The time ogg version supported until of the GoldengateDeployment. + */ + oggVersionSupportEndTime?: string | null; + /** + * Output only. The placements of the GoldengateDeployment. + */ + placements?: Schema$GoldengatePlacement[]; + /** + * Output only. The private ip address of the GoldengateDeployment. + */ + privateIpAddress?: string | null; + /** + * Output only. The public ip address of the GoldengateDeployment. + */ + publicIpAddress?: string | null; + /** + * Output only. The time when the role of the GoldengateDeployment was changed. + */ + roleChangeTime?: string | null; + /** + * Output only. The storage utilization in bytes of the GoldengateDeployment. + */ + storageUtilizationBytes?: string | null; + /** + * Output only. The time the GoldengateDeployment was updated. + */ + updateTime?: string | null; + /** + * Output only. The time upgrade required of the GoldengateDeployment. + */ + upgradeRequiredTime?: string | null; } /** - * The request for `AutonomousDatabase.Restart`. + * Details of the Goldengate Deployment Type resource. */ - export interface Schema$RestartAutonomousDatabaseRequest {} + export interface Schema$GoldengateDeploymentType { + /** + * Output only. The category of the Goldengate Deployment Type resource. + */ + category?: string | null; + /** + * Output only. The connection types of the Goldengate Deployment Type resource. + */ + connectionTypes?: string[] | null; + /** + * Output only. The default username of the Goldengate Deployment Type resource. + */ + defaultUsername?: string | null; + /** + * Output only. The deployment type of the Goldengate Deployment Type resource. + */ + deploymentType?: string | null; + /** + * Output only. The display name of the Goldengate Deployment Type resource. + */ + displayName?: string | null; + /** + * Identifier. The name of the Goldengate Deployment Type resource with the format: projects/{project\}/locations/{region\}/goldengateDeploymentTypes/{goldengate_deployment_type\} + */ + name?: string | null; + /** + * Output only. The Ogg version of the Goldengate Deployment Type resource. + */ + oggVersion?: string | null; + /** + * Output only. The source technologies of the Goldengate Deployment Type resource. + */ + sourceTechnologies?: string[] | null; + /** + * Output only. The supported capabilities of the Goldengate Deployment Type resource. + */ + supportedCapabilities?: string[] | null; + /** + * Output only. The supported technologies URL of the Goldengate Deployment Type resource. + */ + supportedTechnologiesUrl?: string | null; + /** + * Output only. The target technologies of the Goldengate Deployment Type resource. + */ + targetTechnologies?: string[] | null; + } /** - * The request for `AutonomousDatabase.Restore`. + * Details of the Goldengate Deployment Version resource. */ - export interface Schema$RestoreAutonomousDatabaseRequest { + export interface Schema$GoldengateDeploymentVersion { /** - * Required. The time and date to restore the database to. + * Identifier. The name of the Goldengate Deployment Version resource with the format: projects/{project\}/locations/{location\}/goldengateDeploymentVersions/{goldengate_deployment_version\} */ - restoreTime?: string | null; + name?: string | null; + /** + * Output only. The deployment version ocid of the Goldengate Deployment Version resource. + */ + ocid?: string | null; + /** + * Output only. The technology type of the Goldengate Deployment Version resource. + */ + properties?: Schema$GoldengateDeploymentVersionProperties; } /** - * Details of scheduled operation. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/ScheduledOperationDetails + * Properties of GoldengateDeploymentVersion. */ - export interface Schema$ScheduledOperationDetails { + export interface Schema$GoldengateDeploymentVersionProperties { /** - * Output only. Day of week. + * Output only. The deployment type of the Goldengate Deployment Version resource. */ - dayOfWeek?: string | null; + deploymentType?: string | null; /** - * Output only. Auto start time. + * Output only. The OGG version of the Goldengate Deployment Version resource. */ - startTime?: Schema$TimeOfDay; + oggVersion?: string | null; /** - * Output only. Auto stop time. + * Output only. The release time of the Goldengate Deployment Version resource. */ - stopTime?: Schema$TimeOfDay; + releaseTime?: string | null; + /** + * Output only. The release type of the Goldengate Deployment Version resource. + */ + releaseType?: string | null; + /** + * Optional. Whether the Goldengate Deployment Version resource is a security fix. + */ + securityFix?: boolean | null; + /** + * Output only. The support end time of the Goldengate Deployment Version resource. + */ + supportEndTime?: string | null; } /** - * The source configuration for the standby Autonomous Database. + * The properties of GoldengateElasticsearchConnection. */ - export interface Schema$SourceConfig { + export interface Schema$GoldengateElasticsearchConnectionProperties { /** - * Optional. This field specifies if the replication of automatic backups is enabled when creating a Data Guard. + * Optional. Authentication type for Elasticsearch. */ - automaticBackupsReplicationEnabled?: boolean | null; + authenticationType?: string | null; /** - * Optional. The name of the primary Autonomous Database that is used to create a Peer Autonomous Database from a source. + * Optional. Fingerprint required by TLS security protocol. Eg.: '6152b2dfbff200f973c5074a5b91d06ab3b472c07c09a1ea57bb7fd406cdce9c' */ - autonomousDatabase?: string | null; + fingerprint?: string | null; + /** + * Optional. Input only. The password Oracle Goldengate uses for Elastic Search connection in plain text. + */ + password?: string | null; + /** + * Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses for Elastic Search connection. Format: projects/{project\}/secrets/{secret\}/versions/{version\}. + */ + passwordSecretVersion?: string | null; + /** + * Optional. Security protocol for Elasticsearch. + */ + securityProtocol?: string | null; + /** + * Optional. Comma separated list of Elasticsearch server addresses, specified as host:port entries, where :port is optional. If port is not specified, it defaults to 9200. Example: "server1.example.com:4000,server2.example.com:4000" + */ + servers?: string | null; + /** + * Optional. The technology type of ElasticsearchConnection. + */ + technologyType?: string | null; + /** + * Optional. The username Oracle Goldengate uses to connect the associated system of the given technology. + */ + username?: string | null; } /** - * The request for `AutonomousDatabase.Start`. + * The properties of GoldengateGenericConnectionProperties. */ - export interface Schema$StartAutonomousDatabaseRequest {} + export interface Schema$GoldengateGenericConnectionProperties { + /** + * Optional. The host of the GenericConnection. + */ + host?: string | null; + /** + * Optional. The technology type. + */ + technologyType?: 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). + * The properties of GoldengateGoldengateConnectionProperties. */ - export interface Schema$Status { + export interface Schema$GoldengateGoldengateConnectionProperties { /** - * The status code, which should be an enum value of google.rpc.Code. + * Optional. The name of the GoldengateDeployment associated with the GoldengateConnection. Format: projects/{project\}/locations/{location\}/goldengateDeployments/{goldengate_deployment\} */ - code?: number | null; + goldengateDeploymentId?: string | null; /** - * A list of messages that carry the error details. There is a common set of message types for APIs to use. + * Optional. The host of the GoldengateConnection. */ - details?: Array<{[key: string]: any}> | null; + host?: string | null; /** - * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + * Optional. Input only. The password used to connect to the Oracle Goldengate in plain text. */ - message?: string | null; + password?: string | null; + /** + * Optional. Input only. The resource name of a secret version in Secret Manager which contains the password used to connect to the Oracle Goldengate. Format: projects/{project\}/secrets/{secret\}/versions/{version\}. + */ + passwordSecretVersion?: string | null; + /** + * Optional. The port of the GoldengateConnection. + */ + port?: number | null; + /** + * Optional. The technology type. + */ + technologyType?: string | null; + /** + * Optional. The username credential. + */ + username?: string | null; } /** - * The request for `AutonomousDatabase.Stop`. + * The properties of GoldengateGoogleBigQueryConnectionProperties. */ - export interface Schema$StopAutonomousDatabaseRequest {} + export interface Schema$GoldengateGoogleBigQueryConnectionProperties { + /** + * Optional. The service account key file Cloud Storage containing the credentials required to use Google BigQuery. + */ + serviceAccountKeyFile?: string | null; + /** + * Optional. The technology type. + */ + technologyType?: string | null; + } /** - * The initial storage size, in gigabytes, that is applicable for virtual machine DBSystem. + * The properties of GoldengateGoogleCloudStorageConnectionProperties. */ - export interface Schema$StorageSizeDetails { + export interface Schema$GoldengateGoogleCloudStorageConnectionProperties { /** - * Output only. The data storage size, in gigabytes, that is applicable for virtual machine DBSystem. + * Optional. The service account key Cloud Storage file containing the credentials required to use Google Cloud Storage. */ - dataStorageSizeInGbs?: number | null; + serviceAccountKeyFile?: string | null; /** - * Output only. The RECO/REDO storage size, in gigabytes, that is applicable for virtual machine DBSystem. + * Optional. The technology type. */ - recoStorageSizeInGbs?: number | null; + technologyType?: string | null; } /** - * The request for `OracleDatabase.SwitchoverAutonomousDatabase`. + * The properties of GoldengateGooglePubsubConnection. */ - export interface Schema$SwitchoverAutonomousDatabaseRequest { + export interface Schema$GoldengateGooglePubsubConnectionProperties { /** - * Optional. The peer database name to switch over to. Required for cross-region standby, and must be omitted for in-region Data Guard. + * Optional. The content of the service account key file containing the credentials required to use Google Pub/Sub. */ - peerAutonomousDatabase?: string | null; + serviceAccountKeyFile?: string | null; + /** + * Optional. The technology type of GooglePubsubConnection. + */ + technologyType?: string | null; } /** - * Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. + * The group to roles mapping of the GoldengateDeployment. */ - export interface Schema$TimeOfDay { + export interface Schema$GoldengateGroupToRolesMapping { /** - * Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + * Output only. The administrator group id. */ - hours?: number | null; + administratorGroupId?: string | null; /** - * Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + * Output only. The operator group id. */ - minutes?: number | null; + operatorGroupId?: string | null; /** - * Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + * Output only. The security group id. */ - nanos?: number | null; + securityGroupId?: string | null; /** - * Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + * Output only. The user group id. */ - seconds?: number | null; + userGroupId?: string | null; } /** - * Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). + * The properties of GoldengateHdfsConnection. */ - export interface Schema$TimeZone { + export interface Schema$GoldengateHdfsConnectionProperties { /** - * IANA Time Zone Database time zone. For example "America/New_York". + * Optional. The content of the Hadoop Distributed File System configuration file (core-site.xml). */ - id?: string | null; + coreSiteXml?: string | null; /** - * Optional. IANA Time Zone Database version number. For example "2019a". + * Optional. The technology type of HdfsConnection. */ - version?: string | null; + technologyType?: string | null; } - - export class Resource$Projects { - context: APIRequestContext; - locations: Resource$Projects$Locations; - constructor(context: APIRequestContext) { - this.context = context; - this.locations = new Resource$Projects$Locations(this.context); - } + /** + * The properties of GoldengateIcebergConnection. + */ + export interface Schema$GoldengateIcebergConnectionProperties { + /** + * Required. The Iceberg catalog. + */ + catalog?: Schema$IcebergCatalog; + /** + * Required. The Iceberg storage. + */ + storage?: Schema$IcebergStorage; + /** + * Required. The technology type of Iceberg connection. + */ + technologyType?: string | null; } - - export class Resource$Projects$Locations { - context: APIRequestContext; - autonomousDatabaseBackups: Resource$Projects$Locations$Autonomousdatabasebackups; - autonomousDatabaseCharacterSets: Resource$Projects$Locations$Autonomousdatabasecharactersets; - autonomousDatabases: Resource$Projects$Locations$Autonomousdatabases; - autonomousDbVersions: Resource$Projects$Locations$Autonomousdbversions; - cloudExadataInfrastructures: Resource$Projects$Locations$Cloudexadatainfrastructures; - cloudVmClusters: Resource$Projects$Locations$Cloudvmclusters; + /** + * The properties of GoldengateJavaMessageServiceConnection. + */ + export interface Schema$GoldengateJavaMessageServiceConnectionProperties { + /** + * Optional. Authentication type for Java Message Service. + */ + authenticationType?: string | null; + /** + * Optional. The Java class implementing javax.jms.ConnectionFactory interface supplied by the JMS provider. + */ + connectionFactory?: string | null; + /** + * Optional. Connection URL of the Java Message Service, specifying the protocol, host, and port. e.g.: 'mq://myjms.host.domain:7676' + */ + connectionUrl?: string | null; + /** + * Optional. The Connection Factory can be looked up using this name. e.g.: 'ConnectionFactory' + */ + jndiConnectionFactory?: string | null; + /** + * Optional. The implementation of javax.naming.spi.InitialContextFactory interface used to obtain initial naming context. + */ + jndiInitialContextFactory?: string | null; + /** + * Optional. The URL that Java Message Service will use to contact the JNDI provider. e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000' + */ + jndiProviderUrl?: string | null; + /** + * Optional. The password associated to the principal. + */ + jndiSecurityCredentialsSecret?: string | null; + /** + * Optional. Specifies the identity of the principal (user) to be authenticated. + */ + jndiSecurityPrincipal?: string | null; + /** + * Optional. The content of the KeyStore file. + */ + keyStoreFile?: string | null; + /** + * Optional. Input only. The KeyStore password in plain text. + */ + keyStorePassword?: string | null; + /** + * Optional. Input only. The resource name of a secret version in Secret Manager which contains the KeyStore password. Format: projects/{project\}/secrets/{secret\}/versions/{version\}. + */ + keyStorePasswordSecretVersion?: string | null; + /** + * Optional. Input only. The password Oracle Goldengate uses to connect the Java Message Service in plain text. + */ + password?: string | null; + /** + * Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses to connect the associated Java Message Service. Format: projects/{project\}/secrets/{secret\}/versions/{version\}. + */ + passwordSecretVersion?: string | null; + /** + * Optional. Security protocol for Java Message Service. + */ + securityProtocol?: string | null; + /** + * Optional. Input only. The password for the cert inside of the KeyStore in plain text. + */ + sslKeyPassword?: string | null; + /** + * Optional. Input only. The resource name of a secret version in Secret Manager which contains the password for the cert inside of the KeyStore. Format: projects/{project\}/secrets/{secret\}/versions/{version\}. + */ + sslKeyPasswordSecretVersion?: string | null; + /** + * Optional. The technology type of JavaMessageServiceConnection. + */ + technologyType?: string | null; + /** + * Optional. The content of the TrustStore file. + */ + trustStoreFile?: string | null; + /** + * Optional. Input only. The TrustStore password in plain text. + */ + trustStorePassword?: string | null; + /** + * Optional. Input only. The resource name of a secret version in Secret Manager which contains the TrustStore password. Format: projects/{project\}/secrets/{secret\}/versions/{version\}. + */ + trustStorePasswordSecretVersion?: string | null; + /** + * Optional. If set to true, Java Naming and Directory Interface (JNDI) properties should be provided. + */ + useJndi?: boolean | null; + /** + * Optional. The username Oracle Goldengate uses to connect to the Java Message Service. + */ + username?: string | null; + } + /** + * The properties of GoldengateKafkaConnection. + */ + export interface Schema$GoldengateKafkaConnectionProperties { + /** + * Optional. Kafka bootstrap. Equivalent of bootstrap.servers configuration property in Kafka: list of KafkaBootstrapServer objects specified by host/port. Used for establishing the initial connection to the Kafka cluster. Example: "server1.example.com:9092,server2.example.com:9092" + */ + bootstrapServers?: Schema$KafkaBootstrapServer[]; + /** + * Optional. The OCID of the Kafka cluster being referenced from OCI Streaming with Apache Kafka. + */ + clusterId?: string | null; + /** + * Optional. The content of the consumer.properties file. + */ + consumerPropertiesFile?: string | null; + /** + * Optional. The content of the KeyStore file. + */ + keyStoreFile?: string | null; + /** + * Optional. Input only. The KeyStore password in plain text. + */ + keyStorePassword?: string | null; + /** + * Optional. Input only. The resource name of a secret version in Secret Manager which contains the KeyStore password. Format: projects/{project\}/secrets/{secret\}/versions/{version\}. + */ + keyStorePasswordSecretVersion?: string | null; + /** + * Optional. Input only. The password for Kafka basic/SASL auth in plain text. + */ + password?: string | null; + /** + * Optional. Input only. The resource name of a secret version in Secret Manager which contains the password for Kafka basic/SASL auth. Format: projects/{project\}/secrets/{secret\}/versions/{version\}. + */ + passwordSecretVersion?: string | null; + /** + * Optional. The content of the producer.properties file. + */ + producerPropertiesFile?: string | null; + /** + * Optional. Security Type for Kafka. + */ + securityProtocol?: string | null; + /** + * Optional. Input only. The password for the cert inside of the KeyStore in plain text. + */ + sslKeyPassword?: string | null; + /** + * Optional. Input only. The resource name of a secret version in Secret Manager which contains the password for the cert inside of the KeyStore. Format: projects/{project\}/secrets/{secret\}/versions/{version\}. + */ + sslKeyPasswordSecretVersion?: string | null; + /** + * Optional. The OCID of the stream pool being referenced. + */ + streamPoolId?: string | null; + /** + * Optional. The technology type of KafkaConnection. + */ + technologyType?: string | null; + /** + * Optional. The content of the TrustStore file. + */ + trustStoreFile?: string | null; + /** + * Optional. Input only. The TrustStore password in plain text. + */ + trustStorePassword?: string | null; + /** + * Optional. Input only. The resource name of a secret version in Secret Manager which contains the TrustStore password. Format: projects/{project\}/secrets/{secret\}/versions/{version\}. + */ + trustStorePasswordSecretVersion?: string | null; + /** + * Optional. Specifies that the user intends to authenticate to the instance using a resource principal. Applicable only for OCI Streaming connections. + */ + useResourcePrincipal?: boolean | null; + /** + * Optional. The username Oracle Goldengate uses to connect the associated system of the given technology. + */ + username?: string | null; + } + /** + * The properties of GoldengateKafkaSchemaRegistryConnection. + */ + export interface Schema$GoldengateKafkaSchemaRegistryConnectionProperties { + /** + * Optional. Used authentication mechanism to access Schema Registry. + */ + authenticationType?: string | null; + /** + * Optional. The content of the KeyStore file. + */ + keyStoreFile?: string | null; + /** + * Optional. Input only. The KeyStore password in plain text. + */ + keyStorePassword?: string | null; + /** + * Optional. Input only. The resource name of a secret version in Secret Manager which contains the KeyStore password. Format: projects/{project\}/secrets/{secret\}/versions/{version\}. + */ + keyStorePasswordSecretVersion?: string | null; + /** + * Optional. Input only. The password to access Schema Registry in plain text. + */ + password?: string | null; + /** + * Optional. Input only. The resource name of a secret version in Secret Manager which contains the password to access Schema Registry using basic authentication. Format: projects/{project\}/secrets/{secret\}/versions/{version\}. + */ + passwordSecretVersion?: string | null; + /** + * Optional. Input only. The password for the cert inside the KeyStore in plain text. + */ + sslKeyPassword?: string | null; + /** + * Optional. Input only. The resource name of a secret version in Secret Manager which contains the password for the cert inside the KeyStore. Format: projects/{project\}/secrets/{secret\}/versions/{version\}. + */ + sslKeyPasswordSecretVersion?: string | null; + /** + * Optional. The technology type of KafkaSchemaRegistryConnection. + */ + technologyType?: string | null; + /** + * Optional. The content of the TrustStore file. + */ + trustStoreFile?: string | null; + /** + * Optional. Input only. The TrustStore password in plain text. + */ + trustStorePassword?: string | null; + /** + * Optional. Input only. The resource name of a secret version in Secret Manager which contains the TrustStore password. Format: projects/{project\}/secrets/{secret\}/versions/{version\}. + */ + trustStorePasswordSecretVersion?: string | null; + /** + * Optional. Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081' + */ + url?: string | null; + /** + * Optional. The username to access Schema Registry using basic authentication. This value is injected into 'schema.registry.basic.auth.user.info=user:password' configuration property. + */ + username?: string | null; + } + /** + * The maintenance configuration of the GoldengateDeployment. + */ + export interface Schema$GoldengateMaintenanceConfig { + /** + * Optional. Defines auto upgrade period for bundle releases. Manually configured period cannot be longer than service defined period for bundle releases. This period must be shorter or equal to major release upgrade period. Not passing this field during create will equate to using the service default. + */ + bundleReleaseUpgradePeriodDays?: number | null; + /** + * Optional. Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period. + */ + interimReleaseUpgradePeriodDays?: number | null; + /** + * Optional. By default auto upgrade for interim releases are not enabled. If auto-upgrade is enabled for interim release, you have to specify interim_release_upgrade_period_days too. + */ + isInterimReleaseAutoUpgradeEnabled?: boolean | null; + /** + * Optional. Defines auto upgrade period for major releases. Manually configured period cannot be longer than service defined period for major releases. Not passing this field during create will equate to using the service default. + */ + majorReleaseUpgradePeriodDays?: number | null; + /** + * Optional. Defines auto upgrade period for releases with security fix. Manually configured period cannot be longer than service defined period for security releases. Not passing this field during create will equate to using the service default. + */ + securityPatchUpgradePeriodDays?: number | null; + } + /** + * The maintenance window of the GoldengateDeployment. + */ + export interface Schema$GoldengateMaintenanceWindow { + /** + * Required. Days of the week. + */ + day?: string | null; + /** + * Required. Start hour for maintenance period. Hour is in UTC. + */ + startHour?: number | null; + } + /** + * The properties of GoldengateMicrosoftFabricConnection. + */ + export interface Schema$GoldengateMicrosoftFabricConnectionProperties { + /** + * Optional. Azure client ID of the application. + */ + clientId?: string | null; + /** + * Optional. Client secret associated with the client id. + */ + clientSecret?: string | null; + /** + * Optional. Optional Microsoft Fabric service endpoint. Default value: https://onelake.dfs.fabric.microsoft.com + */ + endpoint?: string | null; + /** + * Optional. The technology type of MicrosoftFabricConnection. + */ + technologyType?: string | null; + /** + * Optional. Azure tenant ID of the application. + */ + tenantId?: string | null; + } + /** + * The properties of GoldengateMicrosoftSqlserverConnection. + */ + export interface Schema$GoldengateMicrosoftSqlserverConnectionProperties { + /** + * Optional. An array of name-value pair attribute entries. Used as additional parameters in connection string. + */ + additionalAttributes?: Schema$NameValuePair[]; + /** + * Optional. The name of the database. + */ + database?: string | null; + /** + * Optional. The name or address of a host. + */ + host?: string | null; + /** + * Optional. Input only. The password Oracle Goldengate uses for Microsoft SQL Server connection in plain text. + */ + password?: string | null; + /** + * Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses for Microsoft SQL Server connection. Format: projects/{project\}/secrets/{secret\}/versions/{version\}. + */ + passwordSecretVersion?: string | null; + /** + * Optional. The port of an endpoint usually specified for a connection. + */ + port?: number | null; + /** + * Optional. Security Type for Microsoft SQL Server. + */ + securityProtocol?: string | null; + /** + * Optional. If set to true, the driver validates the certificate that is sent by the database server. + */ + serverCertificateValidationRequired?: boolean | null; + /** + * Optional. Database Certificate - The content of a .pem or .crt file containing the server public key (for 1-way SSL). + */ + sslCaFile?: string | null; + /** + * Optional. The technology type of MicrosoftSqlserverConnection. + */ + technologyType?: string | null; + /** + * Optional. The username Oracle Goldengate uses to connect to the Microsoft SQL Server. + */ + username?: string | null; + } + /** + * The properties of GoldengateMongodbConnection. + */ + export interface Schema$GoldengateMongodbConnectionProperties { + /** + * Optional. MongoDB connection string. e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords' + */ + connectionString?: string | null; + /** + * Optional. The OCID of the Oracle Autonomous Json Database. + */ + databaseId?: string | null; + /** + * Optional. Input only. The password Oracle Goldengate uses to connect the Mongodb connection in plain text. + */ + password?: string | null; + /** + * Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses to connect the Mongodb connection. Format: projects/{project\}/secrets/{secret\}/versions/{version\}. + */ + passwordSecretVersion?: string | null; + /** + * Optional. Security Type for MongoDB. + */ + securityProtocol?: string | null; + /** + * Optional. The technology type of MongodbConnection. + */ + technologyType?: string | null; + /** + * Optional. Database Certificate - The content of a .pem file, containing the server public key (for 1 and 2-way SSL). + */ + tlsCaFile?: string | null; + /** + * Optional. Client Certificate - The content of a .pem file, containing the client public key (for 2-way SSL). + */ + tlsCertificateKeyFile?: string | null; + /** + * Optional. Input only. The Client Certificate key file password in plain text. + */ + tlsCertificateKeyFilePassword?: string | null; + /** + * Optional. Input only. The resource name of a secret version in Secret Manager which contains the Client Certificate key file password in Secret Manager. Format: projects/{project\}/secrets/{secret\}/versions/{version\}. + */ + tlsCertificateKeyFilePasswordSecretVersion?: string | null; + /** + * Optional. The username Oracle Goldengate uses to connect to the database. + */ + username?: string | null; + } + /** + * Properties of GoldengateMysqlConnection. + */ + export interface Schema$GoldengateMysqlConnectionProperties { + /** + * Optional. An array of name-value pair attribute entries. Used as additional parameters in connection string. + */ + additionalAttributes?: Schema$NameValuePair[]; + /** + * Optional. The name of the database. + */ + database?: string | null; + /** + * Optional. The OCID of the database system being referenced. + */ + dbSystemId?: string | null; + /** + * Optional. The name or address of a host. + */ + host?: string | null; + /** + * Optional. Input only. The password Oracle Goldengate uses to connect to MySQL in plain text. + */ + password?: string | null; + /** + * Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses to connect to MySQL. Format: projects/{project\}/secrets/{secret\}/versions/{version\}. + */ + passwordSecretVersion?: string | null; + /** + * Optional. The port of an endpoint usually specified for a connection. + */ + port?: number | null; + /** + * Optional. Security Type for MySQL. + */ + securityProtocol?: string | null; + /** + * Optional. Database Certificate - The content of a .pem or .crt file containing the server public key (for 1 and 2-way SSL). + */ + sslCaFile?: string | null; + /** + * Optional. Client Certificate - The content of a .pem or .crt file containing the client public key (for 2-way SSL). + */ + sslCertFile?: string | null; + /** + * Optional. The list of certificates revoked by the trusted certificate authorities (Trusted CA). + */ + sslCrlFile?: string | null; + /** + * Optional. Client Key - The content of a .pem or .crt file containing the client private key (for 2-way SSL). + */ + sslKeyFile?: string | null; + /** + * Optional. SSL modes for MySQL. + */ + sslMode?: string | null; + /** + * Optional. The technology type of MysqlConnection. + */ + technologyType?: string | null; + /** + * Optional. The username Oracle Goldengate uses to connect the associated system of the given technology. + */ + username?: string | null; + } + /** + * The properties of GoldengateOciObjectStorageConnection. + */ + export interface Schema$GoldengateOciObjectStorageConnectionProperties { + /** + * Optional. The content of the private key file (PEM file) corresponding to the API key of the fingerprint. + */ + privateKeyFile?: string | null; + /** + * Optional. The passphrase of the private key. + */ + privateKeyPassphraseSecret?: string | null; + /** + * Optional. The fingerprint of the API Key of the user specified by the userId. + */ + publicKeyFingerprint?: string | null; + /** + * Optional. The name of the region of OCI Object Storage. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region. + */ + region?: string | null; + /** + * Optional. The technology type of OciObjectStorageConnection. + */ + technologyType?: string | null; + /** + * Optional. The OCID of the related OCI tenancy. + */ + tenancyId?: string | null; + /** + * Optional. Specifies that the user intends to authenticate to the instance using a resource principal. + */ + useResourcePrincipal?: boolean | null; + /** + * Optional. The OCID of the OCI user who will access the Object Storage. The user must have write access to the bucket they want to connect to. + */ + userId?: string | null; + } + /** + * The Ogg data of the GoldengateDeployment. + */ + export interface Schema$GoldengateOggDeployment { + /** + * Optional. The Goldengate deployment console password in plain text. + */ + adminPassword?: string | null; + /** + * Optional. Input only. The Goldengate deployment console password secret version. + */ + adminPasswordSecretVersion?: string | null; + /** + * Required. The Goldengate deployment console username. + */ + adminUsername?: string | null; + /** + * Output only. The certificate of the GoldengateDeployment. + */ + certificate?: string | null; + /** + * Output only. The credential store of the GoldengateDeployment. + */ + credentialStore?: string | null; + /** + * Required. The name given to the Goldengate service deployment. The name must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter. + */ + deployment?: string | null; + /** + * Output only. The group to roles mapping of the GoldengateDeployment. + */ + groupRolesMapping?: Schema$GoldengateGroupToRolesMapping; + /** + * Output only. The identity domain id of the GoldengateDeployment. + */ + identityDomainId?: string | null; + /** + * Optional. Version of OGG + */ + oggVersion?: string | null; + /** + * Output only. The password secret id of the GoldengateDeployment. + */ + passwordSecretId?: string | null; + } + /** + * The properties of GoldengateOracleAIDataPlatformConnection. + */ + export interface Schema$GoldengateOracleAIDataPlatformConnectionProperties { + /** + * Optional. Connection URL. It must start with 'jdbc:spark://' + */ + connectionUrl?: string | null; + /** + * Optional. The content of the private key file (PEM file) corresponding to the API key of the fingerprint. + */ + privateKeyFile?: string | null; + /** + * Optional. The passphrase of the private key. + */ + privateKeyPassphraseSecret?: string | null; + /** + * Optional. The fingerprint of the API Key of the user specified by the user_id. + */ + publicKeyFingerprint?: string | null; + /** + * Optional. The name of the region. e.g.: us-ashburn-1 + */ + region?: string | null; + /** + * Optional. The technology type of OracleAiDataPlatformConnection. + */ + technologyType?: string | null; + /** + * Optional. The OCID of the related OCI tenancy. + */ + tenancyId?: string | null; + /** + * Optional. Specifies that the user intends to authenticate to the instance using a resource principal. + */ + useResourcePrincipal?: boolean | null; + /** + * Optional. The OCID of the OCI user who will access. + */ + userId?: string | null; + } + /** + * The properties of Goldengate Oracle Database Connection. + */ + export interface Schema$GoldengateOracleConnectionProperties { + /** + * Optional. Authentication mode. + */ + authenticationMode?: string | null; + /** + * Optional. Connect descriptor or Easy Connect Naming method used to connect to a database. + */ + connectionString?: string | null; + /** + * Optional. Database instance id of database in Oracle Database @ Google Cloud. If gcp_oracle_database_id is provided, connection_string must be empty. + */ + gcpOracleDatabaseId?: string | null; + /** + * Optional. Input only. The password Oracle Goldengate uses in plain text. + */ + password?: string | null; + /** + * Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses. Format: projects/{project\}/secrets/{secret\}/versions/{version\}. + */ + passwordSecretVersion?: string | null; + /** + * Optional. The mode of the database connection session to be established by the data client. + */ + sessionMode?: string | null; + /** + * Optional. The technology type. + */ + technologyType?: string | null; + /** + * Optional. The username Oracle Goldengate uses to connect. + */ + username?: string | null; + /** + * Optional. The wallet contents Oracle Goldengate uses to make connections to a database. + */ + walletFile?: string | null; + } + /** + * The properties of GoldengateOracleNosqlConnection. + */ + export interface Schema$GoldengateOracleNosqlConnectionProperties { + /** + * Optional. The content of the private key file (PEM file) corresponding to the API key of the fingerprint. + */ + privateKeyFile?: string | null; + /** + * Optional. The passphrase of the private key. + */ + privateKeyPassphraseSecret?: string | null; + /** + * Optional. The fingerprint of the API Key of the user specified by the userId. + */ + publicKeyFingerprint?: string | null; + /** + * Optional. The name of the region. e.g.: us-ashburn-1 + */ + region?: string | null; + /** + * Optional. The technology type of OracleNosqlConnection. + */ + technologyType?: string | null; + /** + * Optional. The OCID of the OCI tenancy. + */ + tenancyId?: string | null; + /** + * Optional. Specifies that the user intends to authenticate to the instance using a resource principal. + */ + useResourcePrincipal?: boolean | null; + /** + * Optional. The OCID of the OCI user who will access the Oracle NoSQL database. + */ + userId?: string | null; + } + /** + * The placement of the GoldengateDeployment. + */ + export interface Schema$GoldengatePlacement { + /** + * Output only. The availability domain. + */ + availabilityDomain?: string | null; + /** + * Output only. The fault domain. + */ + faultDomain?: string | null; + } + /** + * The properties of GoldengatePostgresqlConnection. + */ + export interface Schema$GoldengatePostgresqlConnectionProperties { + /** + * Optional. An array of name-value pair attribute entries. Used as additional parameters in connection string. + */ + additionalAttributes?: Schema$NameValuePair[]; + /** + * Optional. The name of the database. + */ + database?: string | null; + /** + * Optional. The OCID of the database system being referenced. + */ + dbSystemId?: string | null; + /** + * Optional. The name or address of a host. + */ + host?: string | null; + /** + * Optional. Input only. The password Oracle Goldengate uses for PostgreSQL connection in plain text. + */ + password?: string | null; + /** + * Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses for PostgreSQL connection. Format: projects/{project\}/secrets/{secret\}/versions/{version\}. + */ + passwordSecretVersion?: string | null; + /** + * Optional. The port of an endpoint usually specified for a connection. + */ + port?: number | null; + /** + * Optional. Security protocol for PostgreSQL. + */ + securityProtocol?: string | null; + /** + * Optional. The certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. + */ + sslCaFile?: string | null; + /** + * Optional. The certificate of the PostgreSQL server. + */ + sslCertFile?: string | null; + /** + * Optional. The list of certificates revoked by the trusted certificate authorities (Trusted CA). + */ + sslCrlFile?: string | null; + /** + * Optional. The private key of the PostgreSQL server. + */ + sslKeyFile?: string | null; + /** + * Optional. SSL modes for PostgreSQL. + */ + sslMode?: string | null; + /** + * Optional. The technology type of PostgresqlConnection. + */ + technologyType?: string | null; + /** + * Optional. The username Oracle Goldengate uses to connect the associated system of the given technology. + */ + username?: string | null; + } + /** + * The properties of GoldengateRedisConnection. + */ + export interface Schema$GoldengateRedisConnectionProperties { + /** + * Optional. Authentication type for Redis. + */ + authenticationType?: string | null; + /** + * Optional. The content of the KeyStore file. + */ + keyStoreFile?: string | null; + /** + * Optional. Input only. The KeyStore password in plain text. + */ + keyStorePassword?: string | null; + /** + * Optional. Input only. The resource name of a secret version in Secret Manager which contains the KeyStore password. Format: projects/{project\}/secrets/{secret\}/versions/{version\}. + */ + keyStorePasswordSecretVersion?: string | null; + /** + * Optional. Input only. The password Oracle Goldengate uses for Redis connection in plain text. + */ + password?: string | null; + /** + * Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses for Redis connection. Format: projects/{project\}/secrets/{secret\}/versions/{version\}. + */ + passwordSecretVersion?: string | null; + /** + * Optional. The OCID of the Redis cluster. + */ + redisClusterId?: string | null; + /** + * Optional. Security protocol for Redis. + */ + securityProtocol?: string | null; + /** + * Optional. Comma separated list of Redis server addresses, specified as host:port entries, where :port is optional. If port is not specified, it defaults to 6379. Example: "server1.example.com:6379,server2.example.com:6379" + */ + servers?: string | null; + /** + * Optional. The technology type of RedisConnection. + */ + technologyType?: string | null; + /** + * Optional. The content of the TrustStore file. + */ + trustStoreFile?: string | null; + /** + * Optional. Input only. The TrustStore password in plain text. + */ + trustStorePassword?: string | null; + /** + * Optional. Input only. The resource name of a secret version in Secret Manager which contains the TrustStore password. Format: projects/{project\}/secrets/{secret\}/versions/{version\}. + */ + trustStorePasswordSecretVersion?: string | null; + /** + * Optional. The username Oracle Goldengate uses to connect the associated system of the given technology. + */ + username?: string | null; + } + /** + * The properties of GoldengateSnowflakeConnection. + */ + export interface Schema$GoldengateSnowflakeConnectionProperties { + /** + * Optional. Used authentication mechanism to access Snowflake. + */ + authenticationType?: string | null; + /** + * Optional. JDBC connection URL. e.g.: 'jdbc:snowflake://.snowflakecomputing.com/?warehouse=&db=' + */ + connectionUrl?: string | null; + /** + * Optional. Input only. The password Oracle Goldengate uses to connect to Snowflake platform in plain text. + */ + password?: string | null; + /** + * Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses to connect to Snowflake platform. Format: projects/{project\}/secrets/{secret\}/versions/{version\}. + */ + passwordSecretVersion?: string | null; + /** + * Optional. The content of private key file in PEM format. + */ + privateKeyFile?: string | null; + /** + * Optional. Password if the private key file is encrypted. + */ + privateKeyPassphraseSecret?: string | null; + /** + * Optional. The technology type of SnowflakeConnection. + */ + technologyType?: string | null; + /** + * Optional. The username Oracle Goldengate uses to connect to Snowflake. + */ + username?: string | null; + } + /** + * The Google Cloud Storage Iceberg storage. + */ + export interface Schema$GoogleCloudStorageIcebergStorage { + /** + * Required. The bucket of Google Cloud Storage. + */ + bucket?: string | null; + /** + * Required. The project ID of Google Cloud Storage. + */ + projectId?: string | null; + /** + * Optional. The service account key file of Google Cloud Storage. + */ + serviceAccountKeyFile?: string | null; + } + /** + * The Iceberg catalog details. + */ + export interface Schema$IcebergCatalog { + /** + * Required. The type of Iceberg catalog. + */ + catalogType?: string | null; + /** + * The Glue Iceberg catalog. + */ + glueIcebergCatalog?: Schema$GlueIcebergCatalog; + /** + * The Nessie Iceberg catalog. + */ + nessieIcebergCatalog?: Schema$NessieIcebergCatalog; + /** + * The Polaris Iceberg catalog. + */ + polarisIcebergCatalog?: Schema$PolarisIcebergCatalog; + /** + * The REST Iceberg catalog. + */ + restIcebergCatalog?: Schema$RestIcebergCatalog; + } + /** + * The Iceberg storage details. + */ + export interface Schema$IcebergStorage { + /** + * The Amazon S3 Iceberg storage. + */ + amazonS3IcebergStorage?: Schema$AmazonS3IcebergStorage; + /** + * The Azure Data Lake Storage Iceberg storage. + */ + azureDataLakeStorageIcebergStorage?: Schema$AzureDataLakeStorageIcebergStorage; + /** + * The Google Cloud Storage Iceberg storage. + */ + googleCloudStorageIcebergStorage?: Schema$GoogleCloudStorageIcebergStorage; + /** + * Required. The type of Iceberg storage. + */ + storageType?: string | null; + } + /** + * The identity connector details which will allow OCI to securely access the resources in the customer project. + */ + export interface Schema$IdentityConnector { + /** + * Output only. The connection state of the identity connector. + */ + connectionState?: string | null; + /** + * Output only. A google managed service account on which customers can grant roles to access resources in the customer project. Example: `p176944527254-55-75119d87fd8f@gcp-sa-oci.iam.gserviceaccount.com` + */ + serviceAgentEmail?: string | null; + } + /** + * The ingress IPs of the GoldengateDeployment. + */ + export interface Schema$IngressIp { + /** + * Output only. The ingress IP. + */ + ingressIpAddress?: string | null; + } + /** + * Represents a Kafka bootstrap server with host name, optional port defaults to 9092, and an optional private ip. + */ + export interface Schema$KafkaBootstrapServer { + /** + * Required. The name or address of a host. + */ + host?: string | null; + /** + * Optional. The port of an endpoint usually specified for a connection. + */ + port?: number | null; + /** + * Optional. The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection. + */ + privateIpAddress?: string | null; + } + /** + * The response for `AutonomousDatabaseBackup.List`. + */ + export interface Schema$ListAutonomousDatabaseBackupsResponse { + /** + * The list of Autonomous Database Backups. + */ + autonomousDatabaseBackups?: Schema$AutonomousDatabaseBackup[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } + /** + * The response for `AutonomousDatabaseCharacterSet.List`. + */ + export interface Schema$ListAutonomousDatabaseCharacterSetsResponse { + /** + * The list of Autonomous Database Character Sets. + */ + autonomousDatabaseCharacterSets?: Schema$AutonomousDatabaseCharacterSet[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } + /** + * The response for `AutonomousDatabase.List`. + */ + export interface Schema$ListAutonomousDatabasesResponse { + /** + * The list of Autonomous Databases. + */ + autonomousDatabases?: Schema$AutonomousDatabase[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Unreachable locations when listing resources across all locations using wildcard location '-'. + */ + unreachable?: string[] | null; + } + /** + * The response for `AutonomousDbVersion.List`. + */ + export interface Schema$ListAutonomousDbVersionsResponse { + /** + * The list of Autonomous Database versions. + */ + autonomousDbVersions?: Schema$AutonomousDbVersion[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } + /** + * The response for `CloudExadataInfrastructures.list`. + */ + export interface Schema$ListCloudExadataInfrastructuresResponse { + /** + * The list of Exadata Infrastructures. + */ + cloudExadataInfrastructures?: Schema$CloudExadataInfrastructure[]; + /** + * A token for fetching next page of response. + */ + nextPageToken?: string | null; + /** + * Unreachable locations when listing resources across all locations using wildcard location '-'. + */ + unreachable?: string[] | null; + } + /** + * The response for `CloudVmCluster.List`. + */ + export interface Schema$ListCloudVmClustersResponse { + /** + * The list of VM Clusters. + */ + cloudVmClusters?: Schema$CloudVmCluster[]; + /** + * A token to fetch the next page of results. + */ + nextPageToken?: string | null; + /** + * Unreachable locations when listing resources across all locations using wildcard location '-'. + */ + unreachable?: string[] | null; + } + /** + * The response for `DatabaseCharacterSet.List`. + */ + export interface Schema$ListDatabaseCharacterSetsResponse { + /** + * The list of DatabaseCharacterSets. + */ + databaseCharacterSets?: Schema$DatabaseCharacterSet[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } + /** + * The response for `Database.List`. + */ + export interface Schema$ListDatabasesResponse { + /** + * The list of Databases. + */ + databases?: Schema$Database[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } + /** + * The response for `DbNode.List`. + */ + export interface Schema$ListDbNodesResponse { + /** + * The list of DB Nodes + */ + dbNodes?: Schema$DbNode[]; + /** + * A token identifying a page of results the node should return. + */ + nextPageToken?: string | null; + } + /** + * The response for `DbServer.List`. + */ + export interface Schema$ListDbServersResponse { + /** + * The list of database servers. + */ + dbServers?: Schema$DbServer[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } + /** + * The response for `DbSystemInitialStorageSizes.List`. + */ + export interface Schema$ListDbSystemInitialStorageSizesResponse { + /** + * The list of DbSystemInitialStorageSizes. + */ + dbSystemInitialStorageSizes?: Schema$DbSystemInitialStorageSize[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } + /** + * The response for `DbSystemShape.List`. + */ + export interface Schema$ListDbSystemShapesResponse { + /** + * The list of Database System shapes. + */ + dbSystemShapes?: Schema$DbSystemShape[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } + /** + * The response for `DbSystem.List`. + */ + export interface Schema$ListDbSystemsResponse { + /** + * The list of DbSystems. + */ + dbSystems?: Schema$DbSystem[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Unreachable locations when listing resources across all locations using wildcard location '-'. + */ + unreachable?: string[] | null; + } + /** + * The response for `DbVersions.List`. + */ + export interface Schema$ListDbVersionsResponse { + /** + * The list of DbVersions. + */ + dbVersions?: Schema$DbVersion[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } + /** + * The response for `Entitlement.List`. + */ + export interface Schema$ListEntitlementsResponse { + /** + * The list of Entitlements + */ + entitlements?: Schema$Entitlement[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } + /** + * The response for `ExadbVmCluster.List`. + */ + export interface Schema$ListExadbVmClustersResponse { + /** + * The list of ExadbVmClusters. + */ + exadbVmClusters?: Schema$ExadbVmCluster[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Unreachable locations when listing resources across all locations using wildcard location '-'. + */ + unreachable?: string[] | null; + } + /** + * The response for `ExascaleDbStorageVault.List`. + */ + export interface Schema$ListExascaleDbStorageVaultsResponse { + /** + * The ExascaleDbStorageVaults. + */ + exascaleDbStorageVaults?: Schema$ExascaleDbStorageVault[]; + /** + * A token identifying a page of results the server should return. If present, the next page token can be provided to a subsequent ListExascaleDbStorageVaults call to list the next page. If empty, there are no more pages. + */ + nextPageToken?: string | null; + /** + * Unreachable locations when listing resources across all locations using wildcard location '-'. + */ + unreachable?: string[] | null; + } + /** + * The response for `GiVersion.List`. + */ + export interface Schema$ListGiVersionsResponse { + /** + * The list of Oracle Grid Infrastructure (GI) versions. + */ + giVersions?: Schema$GiVersion[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } + /** + * Response message for listing GoldengateConnectionAssignments. + */ + export interface Schema$ListGoldengateConnectionAssignmentsResponse { + /** + * The list of GoldengateConnectionAssignments. + */ + goldengateConnectionAssignments?: Schema$GoldengateConnectionAssignment[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * Unreachable locations when listing resources across all locations using wildcard location '-'. + */ + unreachable?: string[] | null; + } + /** + * The response for `GoldengateConnection.List`. + */ + export interface Schema$ListGoldengateConnectionsResponse { + /** + * The list of GoldengateConnections. + */ + goldengateConnections?: Schema$GoldengateConnection[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Optional. Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Message for response to listing GoldengateConnectionTypes + */ + export interface Schema$ListGoldengateConnectionTypesResponse { + /** + * The list of GoldengateConnectionType + */ + goldengateConnectionTypes?: Schema$GoldengateConnectionType[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * Unordered list. Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Message for response to listing GoldengateDeploymentEnvironments + */ + export interface Schema$ListGoldengateDeploymentEnvironmentsResponse { + /** + * The list of GoldengateDeploymentEnvironment + */ + goldengateDeploymentEnvironments?: Schema$GoldengateDeploymentEnvironment[]; + /** + * A token identifying a page of results the server should return. If this field is empty, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * Unordered list. Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * The response for `GoldengateDeployment.List`. + */ + export interface Schema$ListGoldengateDeploymentsResponse { + /** + * The list of GoldengateDeployments. + */ + goldengateDeployments?: Schema$GoldengateDeployment[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Optional. Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Message for response to listing GoldengateDeploymentTypes + */ + export interface Schema$ListGoldengateDeploymentTypesResponse { + /** + * The list of GoldengateDeploymentType + */ + goldengateDeploymentTypes?: Schema$GoldengateDeploymentType[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * Unordered list. The resource names of locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Message for response to listing GoldengateDeploymentVersions + */ + export interface Schema$ListGoldengateDeploymentVersionsResponse { + /** + * The list of GoldengateDeploymentVersion + */ + goldengateDeploymentVersions?: Schema$GoldengateDeploymentVersion[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * Unordered list. Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * The response message for Locations.ListLocations. + */ + export interface Schema$ListLocationsResponse { + /** + * A list of locations that matches the specified filter in the request. + */ + locations?: Schema$Location[]; + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + } + /** + * The response for `MinorVersion.List`. + */ + export interface Schema$ListMinorVersionsResponse { + /** + * The list of MinorVersions. + */ + minorVersions?: Schema$MinorVersion[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } + /** + * The response for `OdbNetwork.List`. + */ + export interface Schema$ListOdbNetworksResponse { + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * The list of ODB Networks. + */ + odbNetworks?: Schema$OdbNetwork[]; + /** + * Unreachable locations when listing resources across all locations using wildcard location '-'. + */ + unreachable?: string[] | null; + } + /** + * The response for `OdbSubnet.List`. + */ + export interface Schema$ListOdbSubnetsResponse { + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * The list of ODB Subnets. + */ + odbSubnets?: Schema$OdbSubnet[]; + /** + * Unreachable locations when listing resources across all locations using wildcard location '-'. + */ + unreachable?: string[] | null; + } + /** + * The response message for Operations.ListOperations. + */ + export interface Schema$ListOperationsResponse { + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + /** + * A list of operations that matches the specified filter in the request. + */ + operations?: Schema$Operation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; + } + /** + * The response for `PluggableDatabase.List`. + */ + export interface Schema$ListPluggableDatabasesResponse { + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * The list of PluggableDatabases. + */ + pluggableDatabases?: Schema$PluggableDatabase[]; + } + /** + * A resource that represents a Google Cloud location. + */ + export interface Schema$Location { + /** + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". + */ + displayName?: string | null; + /** + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\} + */ + labels?: {[key: string]: string} | null; + /** + * The canonical id for this location. For example: `"us-east1"`. + */ + locationId?: string | null; + /** + * Service-specific metadata. For example the available capacity at the given location. + */ + metadata?: {[key: string]: any} | null; + /** + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` + */ + name?: string | null; + } + /** + * Metadata for a given Location. + */ + export interface Schema$LocationMetadata { + /** + * Output only. Google Cloud Platform Oracle zones in a location. + */ + gcpOracleZones?: string[] | null; + } + /** + * Maintenance window as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/MaintenanceWindow + */ + export interface Schema$MaintenanceWindow { + /** + * Optional. Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). + */ + customActionTimeoutMins?: number | null; + /** + * Optional. Days during the week when maintenance should be performed. + */ + daysOfWeek?: string[] | null; + /** + * Optional. The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are: 0 - represents time slot 0:00 - 3:59 UTC 4 - represents time slot 4:00 - 7:59 UTC 8 - represents time slot 8:00 - 11:59 UTC 12 - represents time slot 12:00 - 15:59 UTC 16 - represents time slot 16:00 - 19:59 UTC 20 - represents time slot 20:00 - 23:59 UTC + */ + hoursOfDay?: number[] | null; + /** + * Optional. If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. + */ + isCustomActionTimeoutEnabled?: boolean | null; + /** + * Optional. Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. + */ + leadTimeWeek?: number | null; + /** + * Optional. Months during the year when maintenance should be performed. + */ + months?: string[] | null; + /** + * Optional. Cloud CloudExadataInfrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. + */ + patchingMode?: string | null; + /** + * Optional. The maintenance window scheduling preference. + */ + preference?: string | null; + /** + * Optional. Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. + */ + weeksOfMonth?: number[] | null; + } + /** + * MinorVersion represents a minor version of a GI. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/GiMinorVersionSummary/ + */ + export interface Schema$MinorVersion { + /** + * Optional. The ID of the Grid Image. + */ + gridImageId?: string | null; + /** + * Identifier. The name of the MinorVersion resource with the format: projects/{project\}/locations/{region\}/giVersions/{gi_version\}/minorVersions/{minor_version\} + */ + name?: string | null; + /** + * Optional. The valid Oracle grid infrastructure software version. + */ + version?: string | null; + } + /** + * A name-value pair representing an attribute entry usable in a list of attributes. + */ + export interface Schema$NameValuePair { + /** + * Required. The name of the property entry. + */ + key?: string | null; + /** + * Required. The value of the property entry. + */ + value?: string | null; + } + /** + * The Nessie Iceberg catalog. + */ + export interface Schema$NessieIcebergCatalog { + /** + * Required. The Nessie branch. + */ + branch?: string | null; + /** + * Required. The Nessie uri. + */ + uri?: string | null; + } + /** + * Represents OdbNetwork resource. + */ + export interface Schema$OdbNetwork { + /** + * Output only. The date and time that the OdbNetwork was created. + */ + createTime?: string | null; + /** + * Output only. The ID of the subscription entitlement associated with the OdbNetwork. + */ + entitlementId?: string | null; + /** + * Optional. The GCP Oracle zone where OdbNetwork is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability. + */ + gcpOracleZone?: string | null; + /** + * Optional. Labels or tags associated with the resource. + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. The name of the OdbNetwork resource in the following format: projects/{project\}/locations/{region\}/odbNetworks/{odb_network\} + */ + name?: string | null; + /** + * Required. The name of the VPC network in the following format: projects/{project\}/global/networks/{network\} + */ + network?: string | null; + /** + * Output only. State of the ODB Network. + */ + state?: string | null; + } + /** + * Represents OdbSubnet resource. + */ + export interface Schema$OdbSubnet { + /** + * Required. The CIDR range of the subnet. + */ + cidrRange?: string | null; + /** + * Output only. The date and time that the OdbNetwork was created. + */ + createTime?: string | null; + /** + * Optional. Labels or tags associated with the resource. + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. The name of the OdbSubnet resource in the following format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\}/odbSubnets/{odb_subnet\} + */ + name?: string | null; + /** + * Required. Purpose of the subnet. + */ + purpose?: string | null; + /** + * Output only. State of the ODB Subnet. + */ + state?: string | null; + } + /** + * This resource represents a long-running operation that is the result of a network API call. + */ + export interface Schema$Operation { + /** + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. + */ + done?: boolean | null; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$Status; + /** + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + */ + metadata?: {[key: string]: any} | null; + /** + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id\}`. + */ + name?: string | null; + /** + * The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + */ + response?: {[key: string]: any} | null; + } + /** + * Represents the metadata of the long-running operation. + */ + export interface Schema$OperationMetadata { + /** + * Output only. API version used to start the operation. + */ + apiVersion?: string | null; + /** + * Output only. The time the operation was created. + */ + createTime?: string | null; + /** + * Output only. The time the operation finished running. + */ + endTime?: string | null; + /** + * Output only. An estimated percentage of the operation that has been completed at a given moment of time, between 0 and 100. + */ + percentComplete?: number | null; + /** + * Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + */ + requestedCancellation?: boolean | null; + /** + * Output only. The status of the operation. + */ + statusMessage?: string | null; + /** + * Output only. Server-defined resource path for the target of the operation. + */ + target?: string | null; + /** + * Output only. Name of the verb executed by the operation. + */ + verb?: string | null; + } + /** + * The PluggableDatabase resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/PluggableDatabase/ + */ + export interface Schema$PluggableDatabase { + /** + * Output only. The date and time that the PluggableDatabase was created. + */ + createTime?: string | null; + /** + * Identifier. The name of the PluggableDatabase resource in the following format: projects/{project\}/locations/{region\}/pluggableDatabases/{pluggable_database\} + */ + name?: string | null; + /** + * Output only. HTTPS link to OCI resources exposed to Customer via UI Interface. + */ + ociUrl?: string | null; + /** + * Optional. The properties of the PluggableDatabase. + */ + properties?: Schema$PluggableDatabaseProperties; + } + /** + * The connection strings used to connect to the Oracle Database. + */ + export interface Schema$PluggableDatabaseConnectionStrings { + /** + * Optional. All connection strings to use to connect to the pluggable database. + */ + allConnectionStrings?: {[key: string]: string} | null; + /** + * Optional. The default connection string to use to connect to the pluggable database. + */ + pdbDefault?: string | null; + /** + * Optional. The default connection string to use to connect to the pluggable database using IP. + */ + pdbIpDefault?: string | null; + } + /** + * The Pluggable Database Node Level Details. + */ + export interface Schema$PluggableDatabaseNodeLevelDetails { + /** + * Required. The Node name of the Database home. + */ + nodeName?: string | null; + /** + * Required. The mode that the pluggable database is in to open it. + */ + openMode?: string | null; + /** + * Required. The OCID of the Pluggable Database. + */ + pluggableDatabaseId?: string | null; + } + /** + * The properties of a PluggableDatabase. + */ + export interface Schema$PluggableDatabaseProperties { + /** + * Required. The OCID of the compartment. + */ + compartmentId?: string | null; + /** + * Optional. The Connection strings used to connect to the Oracle Database. + */ + connectionStrings?: Schema$PluggableDatabaseConnectionStrings; + /** + * Required. The OCID of the CDB. + */ + containerDatabaseOcid?: string | null; + /** + * Output only. The configuration of the Database Management service. + */ + databaseManagementConfig?: Schema$DatabaseManagementConfig; + /** + * Optional. Defined tags for this resource. Each key is predefined and scoped to a namespace. + */ + definedTags?: {[key: string]: Schema$DefinedTagValue} | null; + /** + * Optional. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. + */ + freeformTags?: {[key: string]: string} | null; + /** + * Optional. The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it. + */ + isRestricted?: boolean | null; + /** + * Output only. Additional information about the current lifecycle state. + */ + lifecycleDetails?: string | null; + /** + * Output only. The current state of the pluggable database. + */ + lifecycleState?: string | null; + /** + * Output only. The OCID of the pluggable database. + */ + ocid?: string | null; + /** + * Output only. The status of Operations Insights for this Database. + */ + operationsInsightsState?: string | null; + /** + * Required. The database name. + */ + pdbName?: string | null; + /** + * Optional. Pluggable Database Node Level Details + */ + pdbNodeLevelDetails?: Schema$PluggableDatabaseNodeLevelDetails[]; + } + /** + * The Polaris Iceberg catalog. + */ + export interface Schema$PolarisIcebergCatalog { + /** + * Required. The Polaris client ID. + */ + clientId?: string | null; + /** + * Optional. The Polaris client secret. + */ + clientSecret?: string | null; + /** + * Required. The catalog name within Polaris. + */ + polarisCatalog?: string | null; + /** + * Required. The Polaris principal role. + */ + principalRole?: string | null; + /** + * Required. The Polaris uri. + */ + uri?: string | null; + } + /** + * The request for `ExadbVmCluster.RemoveVirtualMachine`. + */ + export interface Schema$RemoveVirtualMachineExadbVmClusterRequest { + /** + * Required. The list of host names of db nodes to be removed from the ExadbVmCluster. + */ + hostnames?: string[] | null; + /** + * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string | null; + } + /** + * The request for `AutonomousDatabase.Restart`. + */ + export interface Schema$RestartAutonomousDatabaseRequest {} + /** + * The REST Iceberg catalog. + */ + export interface Schema$RestIcebergCatalog { + /** + * Optional. The content of the configuration file containing additional properties for the REST catalog. + */ + properties?: string | null; + /** + * Required. The REST uri. + */ + uri?: string | null; + } + /** + * The request for `AutonomousDatabase.Restore`. + */ + export interface Schema$RestoreAutonomousDatabaseRequest { + /** + * Required. The time and date to restore the database to. + */ + restoreTime?: string | null; + } + /** + * Details of scheduled operation. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/ScheduledOperationDetails + */ + export interface Schema$ScheduledOperationDetails { + /** + * Output only. Day of week. + */ + dayOfWeek?: string | null; + /** + * Output only. Auto start time. + */ + startTime?: Schema$TimeOfDay; + /** + * Output only. Auto stop time. + */ + stopTime?: Schema$TimeOfDay; + } + /** + * The source configuration for the standby Autonomous Database. + */ + export interface Schema$SourceConfig { + /** + * Optional. This field specifies if the replication of automatic backups is enabled when creating a Data Guard. + */ + automaticBackupsReplicationEnabled?: boolean | null; + /** + * Optional. The name of the primary Autonomous Database that is used to create a Peer Autonomous Database from a source. + */ + autonomousDatabase?: string | null; + } + /** + * The request for `AutonomousDatabase.Start`. + */ + export interface Schema$StartAutonomousDatabaseRequest {} + /** + * The request for `GoldengateDeployment.Start`. + */ + export interface Schema$StartGoldengateDeploymentRequest {} + /** + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + */ + export interface Schema$Status { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number | null; + /** + * A list of messages that carry the error details. There is a common set of message types for APIs to use. + */ + details?: Array<{[key: string]: any}> | null; + /** + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + */ + message?: string | null; + } + /** + * The request for `AutonomousDatabase.Stop`. + */ + export interface Schema$StopAutonomousDatabaseRequest {} + /** + * The request for `GoldengateDeployment.Stop`. + */ + export interface Schema$StopGoldengateDeploymentRequest {} + /** + * The initial storage size, in gigabytes, that is applicable for virtual machine DBSystem. + */ + export interface Schema$StorageSizeDetails { + /** + * Output only. The data storage size, in gigabytes, that is applicable for virtual machine DBSystem. + */ + dataStorageSizeInGbs?: number | null; + /** + * Output only. The RECO/REDO storage size, in gigabytes, that is applicable for virtual machine DBSystem. + */ + recoStorageSizeInGbs?: number | null; + } + /** + * The request for `OracleDatabase.SwitchoverAutonomousDatabase`. + */ + export interface Schema$SwitchoverAutonomousDatabaseRequest { + /** + * Optional. The peer database name to switch over to. Required for cross-region standby, and must be omitted for in-region Data Guard. + */ + peerAutonomousDatabase?: string | null; + } + /** + * Error details for TestGoldengateConnectionAssignment. + */ + export interface Schema$TestConnectionAssignmentError { + /** + * The text describing the action required to fix the issue. + */ + action?: string | null; + /** + * A short error code that defines the error, meant for programmatic parsing. + */ + code?: string | null; + /** + * The text describing the root cause of the reported issue. + */ + issue?: string | null; + /** + * A human-readable error message. + */ + message?: string | null; + } + /** + * Request message for TestGoldengateConnectionAssignment. + */ + export interface Schema$TestGoldengateConnectionAssignmentRequest { + /** + * Optional. The type of the test of the assigned connection. The only type actually supported is DEFAULT. + */ + type?: string | null; + } + /** + * The result of the connectivity test performed between the Goldengate deployment and the associated database / service. + */ + export interface Schema$TestGoldengateConnectionAssignmentResponse { + /** + * Error details if test connection failed. + */ + error?: Schema$TestConnectionAssignmentError; + /** + * List of test connection assignment error objects. + */ + errors?: Schema$TestConnectionAssignmentError[]; + /** + * Type of the result i.e. Success, Failure or Timeout. + */ + resultType?: string | null; + } + /** + * Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. + */ + export interface Schema$TimeOfDay { + /** + * Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + */ + hours?: number | null; + /** + * Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + */ + minutes?: number | null; + /** + * Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + */ + nanos?: number | null; + /** + * Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + */ + seconds?: number | null; + } + /** + * Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). + */ + export interface Schema$TimeZone { + /** + * IANA Time Zone Database time zone. For example "America/New_York". + */ + id?: string | null; + /** + * Optional. IANA Time Zone Database version number. For example "2019a". + */ + version?: string | null; + } + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + } + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + autonomousDatabaseBackups: Resource$Projects$Locations$Autonomousdatabasebackups; + autonomousDatabaseCharacterSets: Resource$Projects$Locations$Autonomousdatabasecharactersets; + autonomousDatabases: Resource$Projects$Locations$Autonomousdatabases; + autonomousDbVersions: Resource$Projects$Locations$Autonomousdbversions; + cloudExadataInfrastructures: Resource$Projects$Locations$Cloudexadatainfrastructures; + cloudVmClusters: Resource$Projects$Locations$Cloudvmclusters; databaseCharacterSets: Resource$Projects$Locations$Databasecharactersets; databases: Resource$Projects$Locations$Databases; dbSystemInitialStorageSizes: Resource$Projects$Locations$Dbsysteminitialstoragesizes; @@ -2972,65 +5318,3833 @@ export namespace oracledatabase_v1 { exadbVmClusters: Resource$Projects$Locations$Exadbvmclusters; exascaleDbStorageVaults: Resource$Projects$Locations$Exascaledbstoragevaults; giVersions: Resource$Projects$Locations$Giversions; + goldengateConnectionAssignments: Resource$Projects$Locations$Goldengateconnectionassignments; + goldengateConnections: Resource$Projects$Locations$Goldengateconnections; + goldengateConnectionTypes: Resource$Projects$Locations$Goldengateconnectiontypes; + goldengateDeploymentEnvironments: Resource$Projects$Locations$Goldengatedeploymentenvironments; + goldengateDeployments: Resource$Projects$Locations$Goldengatedeployments; + goldengateDeploymentTypes: Resource$Projects$Locations$Goldengatedeploymenttypes; + goldengateDeploymentVersions: Resource$Projects$Locations$Goldengatedeploymentversions; odbNetworks: Resource$Projects$Locations$Odbnetworks; operations: Resource$Projects$Locations$Operations; pluggableDatabases: Resource$Projects$Locations$Pluggabledatabases; constructor(context: APIRequestContext) { this.context = context; - this.autonomousDatabaseBackups = - new Resource$Projects$Locations$Autonomousdatabasebackups(this.context); - this.autonomousDatabaseCharacterSets = - new Resource$Projects$Locations$Autonomousdatabasecharactersets( - this.context - ); - this.autonomousDatabases = - new Resource$Projects$Locations$Autonomousdatabases(this.context); - this.autonomousDbVersions = - new Resource$Projects$Locations$Autonomousdbversions(this.context); - this.cloudExadataInfrastructures = - new Resource$Projects$Locations$Cloudexadatainfrastructures( - this.context - ); - this.cloudVmClusters = new Resource$Projects$Locations$Cloudvmclusters( - this.context - ); - this.databaseCharacterSets = - new Resource$Projects$Locations$Databasecharactersets(this.context); - this.databases = new Resource$Projects$Locations$Databases(this.context); - this.dbSystemInitialStorageSizes = - new Resource$Projects$Locations$Dbsysteminitialstoragesizes( - this.context + this.autonomousDatabaseBackups = + new Resource$Projects$Locations$Autonomousdatabasebackups(this.context); + this.autonomousDatabaseCharacterSets = + new Resource$Projects$Locations$Autonomousdatabasecharactersets( + this.context + ); + this.autonomousDatabases = + new Resource$Projects$Locations$Autonomousdatabases(this.context); + this.autonomousDbVersions = + new Resource$Projects$Locations$Autonomousdbversions(this.context); + this.cloudExadataInfrastructures = + new Resource$Projects$Locations$Cloudexadatainfrastructures( + this.context + ); + this.cloudVmClusters = new Resource$Projects$Locations$Cloudvmclusters( + this.context + ); + this.databaseCharacterSets = + new Resource$Projects$Locations$Databasecharactersets(this.context); + this.databases = new Resource$Projects$Locations$Databases(this.context); + this.dbSystemInitialStorageSizes = + new Resource$Projects$Locations$Dbsysteminitialstoragesizes( + this.context + ); + this.dbSystems = new Resource$Projects$Locations$Dbsystems(this.context); + this.dbSystemShapes = new Resource$Projects$Locations$Dbsystemshapes( + this.context + ); + this.dbVersions = new Resource$Projects$Locations$Dbversions( + this.context + ); + this.entitlements = new Resource$Projects$Locations$Entitlements( + this.context + ); + this.exadbVmClusters = new Resource$Projects$Locations$Exadbvmclusters( + this.context + ); + this.exascaleDbStorageVaults = + new Resource$Projects$Locations$Exascaledbstoragevaults(this.context); + this.giVersions = new Resource$Projects$Locations$Giversions( + this.context + ); + this.goldengateConnectionAssignments = + new Resource$Projects$Locations$Goldengateconnectionassignments( + this.context + ); + this.goldengateConnections = + new Resource$Projects$Locations$Goldengateconnections(this.context); + this.goldengateConnectionTypes = + new Resource$Projects$Locations$Goldengateconnectiontypes(this.context); + this.goldengateDeploymentEnvironments = + new Resource$Projects$Locations$Goldengatedeploymentenvironments( + this.context + ); + this.goldengateDeployments = + new Resource$Projects$Locations$Goldengatedeployments(this.context); + this.goldengateDeploymentTypes = + new Resource$Projects$Locations$Goldengatedeploymenttypes(this.context); + this.goldengateDeploymentVersions = + new Resource$Projects$Locations$Goldengatedeploymentversions( + this.context + ); + this.odbNetworks = new Resource$Projects$Locations$Odbnetworks( + this.context + ); + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + this.pluggableDatabases = + new Resource$Projects$Locations$Pluggabledatabases(this.context); + } + + /** + * Gets information about a location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const oracledatabase = google.oracledatabase('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await oracledatabase.projects.locations.get({ + * // Resource name for the location. + * name: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "displayName": "my_displayName", + * // "labels": {}, + * // "locationId": "my_locationId", + * // "metadata": {}, + * // "name": "my_name" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const oracledatabase = google.oracledatabase('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await oracledatabase.projects.locations.list({ + * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. + * extraLocationTypes: 'placeholder-value', + * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). + * filter: 'placeholder-value', + * // The resource that owns the locations collection, if applicable. + * name: 'projects/my-project', + * // The maximum number of results to return. If not set, the service selects a default. + * pageSize: 'placeholder-value', + * // A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + * pageToken: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "locations": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/locations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Get extends StandardParameters { + /** + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. + */ + extraLocationTypes?: string[]; + /** + * A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Autonomousdatabasebackups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists the long-term and automatic backups of an Autonomous Database. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const oracledatabase = google.oracledatabase('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await oracledatabase.projects.locations.autonomousDatabaseBackups.list({ + * // Optional. An expression for filtering the results of the request. Only the **autonomous_database_id** field is supported in the following format: `autonomous_database_id="{autonomous_database_id\}"`. The accepted values must be a valid Autonomous Database ID, limited to the naming restrictions of the ID: ^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$). The ID must start with a letter, end with a letter or a number, and be a maximum of 63 characters. + * filter: 'placeholder-value', + * // Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Backups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. The parent value for ListAutonomousDatabaseBackups in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "autonomousDatabaseBackups": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Autonomousdatabasebackups$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Autonomousdatabasebackups$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Autonomousdatabasebackups$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Autonomousdatabasebackups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Autonomousdatabasebackups$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabasebackups$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabasebackups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabasebackups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/autonomousDatabaseBackups').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$Autonomousdatabasebackups$List extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. Only the **autonomous_database_id** field is supported in the following format: `autonomous_database_id="{autonomous_database_id\}"`. The accepted values must be a valid Autonomous Database ID, limited to the naming restrictions of the ID: ^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$). The ID must start with a letter, end with a letter or a number, and be a maximum of 63 characters. + */ + filter?: string; + /** + * Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Backups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The parent value for ListAutonomousDatabaseBackups in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Autonomousdatabasecharactersets { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists Autonomous Database Character Sets in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const oracledatabase = google.oracledatabase('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await oracledatabase.projects.locations.autonomousDatabaseCharacterSets.list( + * { + * // Optional. An expression for filtering the results of the request. Only the **character_set_type** field is supported in the following format: `character_set_type="{characterSetType\}"`. Accepted values include `DATABASE` and `NATIONAL`. + * filter: 'placeholder-value', + * // Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Character Sets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. The parent value for the Autonomous Database in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "autonomousDatabaseCharacterSets": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+parent}/autonomousDatabaseCharacterSets' + ).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$Autonomousdatabasecharactersets$List extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. Only the **character_set_type** field is supported in the following format: `character_set_type="{characterSetType\}"`. Accepted values include `DATABASE` and `NATIONAL`. + */ + filter?: string; + /** + * Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Character Sets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The parent value for the Autonomous Database in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Autonomousdatabases { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new Autonomous Database in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const oracledatabase = google.oracledatabase('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await oracledatabase.projects.locations.autonomousDatabases.create({ + * // Required. The ID of the Autonomous Database to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + * autonomousDatabaseId: 'placeholder-value', + * // Required. The name of the parent in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "adminPassword": "my_adminPassword", + * // "adminPasswordSecretVersion": "my_adminPasswordSecretVersion", + * // "cidr": "my_cidr", + * // "createTime": "my_createTime", + * // "database": "my_database", + * // "disasterRecoverySupportedLocations": [], + * // "displayName": "my_displayName", + * // "entitlementId": "my_entitlementId", + * // "labels": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "odbNetwork": "my_odbNetwork", + * // "odbSubnet": "my_odbSubnet", + * // "peerAutonomousDatabases": [], + * // "properties": {}, + * // "sourceConfig": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Autonomousdatabases$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabases$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabases$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/autonomousDatabases').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single Autonomous Database. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const oracledatabase = google.oracledatabase('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await oracledatabase.projects.locations.autonomousDatabases.delete({ + * // Required. The name of the resource in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', + * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Autonomousdatabases$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabases$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabases$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.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); + } + } + + /** + * Initiates a failover to target autonomous database from the associated primary database. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const oracledatabase = google.oracledatabase('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await oracledatabase.projects.locations.autonomousDatabases.failover({ + * // Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "peerAutonomousDatabase": "my_peerAutonomousDatabase" + * // } + * }, + * }); + * 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. + */ + failover( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Failover, + options: StreamMethodOptions + ): Promise>; + failover( + params?: Params$Resource$Projects$Locations$Autonomousdatabases$Failover, + options?: MethodOptions + ): Promise>; + failover( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Failover, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + failover( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Failover, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + failover( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Failover, + callback: BodyResponseCallback + ): void; + failover(callback: BodyResponseCallback): void; + failover( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabases$Failover + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Failover; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabases$Failover; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:failover').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); + } + } + + /** + * Generates a wallet for an Autonomous Database. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const oracledatabase = google.oracledatabase('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await oracledatabase.projects.locations.autonomousDatabases.generateWallet({ + * // Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "isRegional": false, + * // "password": "my_password", + * // "type": "my_type" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "archiveContent": "my_archiveContent" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + generateWallet( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet, + options: StreamMethodOptions + ): Promise>; + generateWallet( + params?: Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + generateWallet( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateWallet( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateWallet( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet, + callback: BodyResponseCallback + ): void; + generateWallet( + callback: BodyResponseCallback + ): void; + generateWallet( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:generateWallet').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets the details of a single Autonomous Database. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const oracledatabase = google.oracledatabase('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await oracledatabase.projects.locations.autonomousDatabases.get({ + * // Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "adminPassword": "my_adminPassword", + * // "adminPasswordSecretVersion": "my_adminPasswordSecretVersion", + * // "cidr": "my_cidr", + * // "createTime": "my_createTime", + * // "database": "my_database", + * // "disasterRecoverySupportedLocations": [], + * // "displayName": "my_displayName", + * // "entitlementId": "my_entitlementId", + * // "labels": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "odbNetwork": "my_odbNetwork", + * // "odbSubnet": "my_odbSubnet", + * // "peerAutonomousDatabases": [], + * // "properties": {}, + * // "sourceConfig": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Autonomousdatabases$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Autonomousdatabases$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabases$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabases$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.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 the Autonomous Databases in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const oracledatabase = google.oracledatabase('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await oracledatabase.projects.locations.autonomousDatabases.list({ + * // Optional. An expression for filtering the results of the request. + * filter: 'placeholder-value', + * // Optional. An expression for ordering the results of the request. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous Database will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. The parent value for the Autonomous Database in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "autonomousDatabases": [], + * // "nextPageToken": "my_nextPageToken", + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Autonomousdatabases$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Autonomousdatabases$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Autonomousdatabases$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Autonomousdatabases$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Autonomousdatabases$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabases$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabases$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabases$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/autonomousDatabases').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates the parameters of a single Autonomous Database. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const oracledatabase = google.oracledatabase('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await oracledatabase.projects.locations.autonomousDatabases.patch( + * { + * // Identifier. The name of the Autonomous Database resource in the following format: projects/{project\}/locations/{region\}/autonomousDatabases/{autonomous_database\} + * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', + * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Optional. Field mask is used to specify the fields to be overwritten in the Exadata resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "adminPassword": "my_adminPassword", + * // "adminPasswordSecretVersion": "my_adminPasswordSecretVersion", + * // "cidr": "my_cidr", + * // "createTime": "my_createTime", + * // "database": "my_database", + * // "disasterRecoverySupportedLocations": [], + * // "displayName": "my_displayName", + * // "entitlementId": "my_entitlementId", + * // "labels": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "odbNetwork": "my_odbNetwork", + * // "odbSubnet": "my_odbSubnet", + * // "peerAutonomousDatabases": [], + * // "properties": {}, + * // "sourceConfig": {} + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Autonomousdatabases$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabases$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabases$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Restarts an Autonomous Database. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const oracledatabase = google.oracledatabase('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await oracledatabase.projects.locations.autonomousDatabases.restart({ + * // Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + restart( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Restart, + options: StreamMethodOptions + ): Promise>; + restart( + params?: Params$Resource$Projects$Locations$Autonomousdatabases$Restart, + options?: MethodOptions + ): Promise>; + restart( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Restart, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restart( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Restart, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restart( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Restart, + callback: BodyResponseCallback + ): void; + restart(callback: BodyResponseCallback): void; + restart( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabases$Restart + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Restart; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabases$Restart; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:restart').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); + } + } + + /** + * Restores a single Autonomous Database. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const oracledatabase = google.oracledatabase('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await oracledatabase.projects.locations.autonomousDatabases.restore({ + * // Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "restoreTime": "my_restoreTime" + * // } + * }, + * }); + * 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. + */ + restore( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Restore, + options: StreamMethodOptions + ): Promise>; + restore( + params?: Params$Resource$Projects$Locations$Autonomousdatabases$Restore, + options?: MethodOptions + ): Promise>; + restore( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Restore, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restore( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Restore, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restore( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Restore, + callback: BodyResponseCallback + ): void; + restore(callback: BodyResponseCallback): void; + restore( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabases$Restore + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Restore; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabases$Restore; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:restore').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); + } + } + + /** + * Starts an Autonomous Database. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const oracledatabase = google.oracledatabase('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await oracledatabase.projects.locations.autonomousDatabases.start( + * { + * // Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + start( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Start, + options: StreamMethodOptions + ): Promise>; + start( + params?: Params$Resource$Projects$Locations$Autonomousdatabases$Start, + options?: MethodOptions + ): Promise>; + start( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Start, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + start( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Start, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + start( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Start, + callback: BodyResponseCallback + ): void; + start(callback: BodyResponseCallback): void; + start( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabases$Start + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Start; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabases$Start; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:start').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Stops an Autonomous Database. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const oracledatabase = google.oracledatabase('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await oracledatabase.projects.locations.autonomousDatabases.stop({ + * // Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + stop( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Stop, + options: StreamMethodOptions + ): Promise>; + stop( + params?: Params$Resource$Projects$Locations$Autonomousdatabases$Stop, + options?: MethodOptions + ): Promise>; + stop( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Stop, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + stop( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Stop, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + stop( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Stop, + callback: BodyResponseCallback + ): void; + stop(callback: BodyResponseCallback): void; + stop( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabases$Stop + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Stop; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabases$Stop; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:stop').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Initiates a switchover of specified autonomous database to the associated peer database. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const oracledatabase = google.oracledatabase('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await oracledatabase.projects.locations.autonomousDatabases.switchover({ + * // Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "peerAutonomousDatabase": "my_peerAutonomousDatabase" + * // } + * }, + * }); + * 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. + */ + switchover( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Switchover, + options: StreamMethodOptions + ): Promise>; + switchover( + params?: Params$Resource$Projects$Locations$Autonomousdatabases$Switchover, + options?: MethodOptions + ): Promise>; + switchover( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Switchover, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + switchover( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Switchover, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + switchover( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Switchover, + callback: BodyResponseCallback + ): void; + switchover(callback: BodyResponseCallback): void; + switchover( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabases$Switchover + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Switchover; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabases$Switchover; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:switchover').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$Autonomousdatabases$Create extends StandardParameters { + /** + * Required. The ID of the Autonomous Database to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + */ + autonomousDatabaseId?: string; + /** + * Required. The name of the parent in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + /** + * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AutonomousDatabase; + } + export interface Params$Resource$Projects$Locations$Autonomousdatabases$Delete extends StandardParameters { + /** + * Required. The name of the resource in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + */ + name?: string; + /** + * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Autonomousdatabases$Failover extends StandardParameters { + /** + * Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FailoverAutonomousDatabaseRequest; + } + export interface Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet extends StandardParameters { + /** + * Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GenerateAutonomousDatabaseWalletRequest; + } + export interface Params$Resource$Projects$Locations$Autonomousdatabases$Get extends StandardParameters { + /** + * Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Autonomousdatabases$List extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. + */ + filter?: string; + /** + * Optional. An expression for ordering the results of the request. + */ + orderBy?: string; + /** + * Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous Database will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The parent value for the Autonomous Database in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Autonomousdatabases$Patch extends StandardParameters { + /** + * Identifier. The name of the Autonomous Database resource in the following format: projects/{project\}/locations/{region\}/autonomousDatabases/{autonomous_database\} + */ + name?: string; + /** + * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the Exadata resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AutonomousDatabase; + } + export interface Params$Resource$Projects$Locations$Autonomousdatabases$Restart extends StandardParameters { + /** + * Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RestartAutonomousDatabaseRequest; + } + export interface Params$Resource$Projects$Locations$Autonomousdatabases$Restore extends StandardParameters { + /** + * Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RestoreAutonomousDatabaseRequest; + } + export interface Params$Resource$Projects$Locations$Autonomousdatabases$Start extends StandardParameters { + /** + * Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$StartAutonomousDatabaseRequest; + } + export interface Params$Resource$Projects$Locations$Autonomousdatabases$Stop extends StandardParameters { + /** + * Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$StopAutonomousDatabaseRequest; + } + export interface Params$Resource$Projects$Locations$Autonomousdatabases$Switchover extends StandardParameters { + /** + * Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SwitchoverAutonomousDatabaseRequest; + } + + export class Resource$Projects$Locations$Autonomousdbversions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists all the available Autonomous Database versions for a project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const oracledatabase = google.oracledatabase('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await oracledatabase.projects.locations.autonomousDbVersions.list( + * { + * // Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. The parent value for the Autonomous Database in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "autonomousDbVersions": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Autonomousdbversions$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Autonomousdbversions$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Autonomousdbversions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Autonomousdbversions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Autonomousdbversions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdbversions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdbversions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdbversions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/autonomousDbVersions').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$Autonomousdbversions$List extends StandardParameters { + /** + * Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The parent value for the Autonomous Database in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Cloudexadatainfrastructures { + context: APIRequestContext; + dbServers: Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers; + constructor(context: APIRequestContext) { + this.context = context; + this.dbServers = + new Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers( + this.context + ); + } + + /** + * Creates a new Exadata Infrastructure in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const oracledatabase = google.oracledatabase('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await oracledatabase.projects.locations.cloudExadataInfrastructures.create({ + * // Required. The ID of the Exadata Infrastructure to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + * cloudExadataInfrastructureId: 'placeholder-value', + * // Required. The parent value for CloudExadataInfrastructure in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "entitlementId": "my_entitlementId", + * // "gcpOracleZone": "my_gcpOracleZone", + * // "labels": {}, + * // "name": "my_name", + * // "properties": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+parent}/cloudExadataInfrastructures' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single Exadata Infrastructure. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const oracledatabase = google.oracledatabase('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await oracledatabase.projects.locations.cloudExadataInfrastructures.delete({ + * // Optional. If set to true, all VM clusters for this Exadata Infrastructure will be deleted. An Exadata Infrastructure can only be deleted once all its VM clusters have been deleted. + * force: 'placeholder-value', + * // Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project\}/locations/{location\}/cloudExadataInfrastructures/{cloud_exadata_infrastructure\}. + * name: 'projects/my-project/locations/my-location/cloudExadataInfrastructures/my-cloudExadataInfrastructure', + * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single Exadata Infrastructure. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const oracledatabase = google.oracledatabase('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await oracledatabase.projects.locations.cloudExadataInfrastructures.get({ + * // Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project\}/locations/{location\}/cloudExadataInfrastructures/{cloud_exadata_infrastructure\}. + * name: 'projects/my-project/locations/my-location/cloudExadataInfrastructures/my-cloudExadataInfrastructure', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "entitlementId": "my_entitlementId", + * // "gcpOracleZone": "my_gcpOracleZone", + * // "labels": {}, + * // "name": "my_name", + * // "properties": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Cloudexadatainfrastructures$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.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 Exadata Infrastructures in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const oracledatabase = google.oracledatabase('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await oracledatabase.projects.locations.cloudExadataInfrastructures.list({ + * // Optional. An expression for filtering the results of the request. + * filter: 'placeholder-value', + * // Optional. An expression for ordering the results of the request. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of items to return. If unspecified, at most 50 Exadata infrastructures will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. The parent value for CloudExadataInfrastructure in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "cloudExadataInfrastructures": [], + * // "nextPageToken": "my_nextPageToken", + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+parent}/cloudExadataInfrastructures' + ).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$Cloudexadatainfrastructures$Create extends StandardParameters { + /** + * Required. The ID of the Exadata Infrastructure to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + */ + cloudExadataInfrastructureId?: string; + /** + * Required. The parent value for CloudExadataInfrastructure in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + /** + * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CloudExadataInfrastructure; + } + export interface Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete extends StandardParameters { + /** + * Optional. If set to true, all VM clusters for this Exadata Infrastructure will be deleted. An Exadata Infrastructure can only be deleted once all its VM clusters have been deleted. + */ + force?: boolean; + /** + * Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project\}/locations/{location\}/cloudExadataInfrastructures/{cloud_exadata_infrastructure\}. + */ + name?: string; + /** + * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get extends StandardParameters { + /** + * Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project\}/locations/{location\}/cloudExadataInfrastructures/{cloud_exadata_infrastructure\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. + */ + filter?: string; + /** + * Optional. An expression for ordering the results of the request. + */ + orderBy?: string; + /** + * Optional. The maximum number of items to return. If unspecified, at most 50 Exadata infrastructures will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The parent value for CloudExadataInfrastructure in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists the database servers of an Exadata Infrastructure instance. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const oracledatabase = google.oracledatabase('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await oracledatabase.projects.locations.cloudExadataInfrastructures.dbServers.list( + * { + * // Optional. The maximum number of items to return. If unspecified, a maximum of 50 db servers will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. The parent value for database server in the following format: projects/{project\}/locations/{location\}/cloudExadataInfrastructures/{cloudExadataInfrastructure\}. + * parent: + * 'projects/my-project/locations/my-location/cloudExadataInfrastructures/my-cloudExadataInfrastructure', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "dbServers": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/dbServers').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback ); - this.dbSystems = new Resource$Projects$Locations$Dbsystems(this.context); - this.dbSystemShapes = new Resource$Projects$Locations$Dbsystemshapes( - this.context - ); - this.dbVersions = new Resource$Projects$Locations$Dbversions( - this.context - ); - this.entitlements = new Resource$Projects$Locations$Entitlements( - this.context - ); - this.exadbVmClusters = new Resource$Projects$Locations$Exadbvmclusters( - this.context - ); - this.exascaleDbStorageVaults = - new Resource$Projects$Locations$Exascaledbstoragevaults(this.context); - this.giVersions = new Resource$Projects$Locations$Giversions( - this.context - ); - this.odbNetworks = new Resource$Projects$Locations$Odbnetworks( - this.context - ); - this.operations = new Resource$Projects$Locations$Operations( + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List extends StandardParameters { + /** + * Optional. The maximum number of items to return. If unspecified, a maximum of 50 db servers will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The parent value for database server in the following format: projects/{project\}/locations/{location\}/cloudExadataInfrastructures/{cloudExadataInfrastructure\}. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Cloudvmclusters { + context: APIRequestContext; + dbNodes: Resource$Projects$Locations$Cloudvmclusters$Dbnodes; + constructor(context: APIRequestContext) { + this.context = context; + this.dbNodes = new Resource$Projects$Locations$Cloudvmclusters$Dbnodes( this.context ); - this.pluggableDatabases = - new Resource$Projects$Locations$Pluggabledatabases(this.context); } /** - * Gets information about a location. + * Creates a new VM Cluster in a given project and location. * @example * ```js * // Before running the sample: @@ -3059,19 +9173,44 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.get({ - * // Resource name for the location. - * name: 'projects/my-project/locations/my-location', + * const res = await oracledatabase.projects.locations.cloudVmClusters.create({ + * // Required. The ID of the VM Cluster to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + * cloudVmClusterId: 'placeholder-value', + * // Required. The name of the parent in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "backupOdbSubnet": "my_backupOdbSubnet", + * // "backupSubnetCidr": "my_backupSubnetCidr", + * // "cidr": "my_cidr", + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "exadataInfrastructure": "my_exadataInfrastructure", + * // "gcpOracleZone": "my_gcpOracleZone", + * // "identityConnector": {}, + * // "labels": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "odbNetwork": "my_odbNetwork", + * // "odbSubnet": "my_odbSubnet", + * // "properties": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "displayName": "my_displayName", - * // "labels": {}, - * // "locationId": "my_locationId", + * // "done": false, + * // "error": {}, * // "metadata": {}, - * // "name": "my_name" + * // "name": "my_name", + * // "response": {} * // } * } * @@ -3087,53 +9226,54 @@ export namespace oracledatabase_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Get, + create( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Create, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Get, + create( + params?: Params$Resource$Projects$Locations$Cloudvmclusters$Create, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Get, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Create, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Cloudvmclusters$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$Get; + {}) as Params$Resource$Projects$Locations$Cloudvmclusters$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Get; + params = + {} as Params$Resource$Projects$Locations$Cloudvmclusters$Create; options = {}; } @@ -3147,29 +9287,32 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/cloudVmClusters').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. + * Deletes a single VM Cluster. * @example * ```js * // Before running the sample: @@ -3198,24 +9341,23 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.list({ - * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. - * extraLocationTypes: 'placeholder-value', - * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). - * filter: 'placeholder-value', - * // The resource that owns the locations collection, if applicable. - * name: 'projects/my-project', - * // The maximum number of results to return. If not set, the service selects a default. - * pageSize: 'placeholder-value', - * // A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. - * pageToken: 'placeholder-value', + * const res = await oracledatabase.projects.locations.cloudVmClusters.delete({ + * // Optional. If set to true, all child resources for the VM Cluster will be deleted. A VM Cluster can only be deleted once all its child resources have been deleted. + * force: 'placeholder-value', + * // Required. The name of the Cloud VM Cluster in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloud_vm_cluster\}. + * name: 'projects/my-project/locations/my-location/cloudVmClusters/my-cloudVmCluster', + * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "locations": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -3231,55 +9373,54 @@ export namespace oracledatabase_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$List, + delete( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$List, + delete( + params?: Params$Resource$Projects$Locations$Cloudvmclusters$Delete, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Delete, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Cloudvmclusters$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$List; + {}) as Params$Resource$Projects$Locations$Cloudvmclusters$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$List; + params = + {} as Params$Resource$Projects$Locations$Cloudvmclusters$Delete; options = {}; } @@ -3293,11 +9434,8 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/locations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -3308,53 +9446,17 @@ export namespace oracledatabase_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$Get extends StandardParameters { - /** - * Resource name for the location. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$List extends StandardParameters { - /** - * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. - */ - extraLocationTypes?: string[]; - /** - * A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). - */ - filter?: string; - /** - * The resource that owns the locations collection, if applicable. - */ - name?: string; - /** - * The maximum number of results to return. If not set, the service selects a default. - */ - pageSize?: number; - /** - * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Autonomousdatabasebackups { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Lists the long-term and automatic backups of an Autonomous Database. + * Gets details of a single VM Cluster. * @example * ```js * // Before running the sample: @@ -3383,23 +9485,28 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await oracledatabase.projects.locations.autonomousDatabaseBackups.list({ - * // Optional. An expression for filtering the results of the request. Only the **autonomous_database_id** field is supported in the following format: `autonomous_database_id="{autonomous_database_id\}"`. The accepted values must be a valid Autonomous Database ID, limited to the naming restrictions of the ID: ^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$). The ID must start with a letter, end with a letter or a number, and be a maximum of 63 characters. - * filter: 'placeholder-value', - * // Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Backups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // Optional. A token identifying a page of results the server should return. - * pageToken: 'placeholder-value', - * // Required. The parent value for ListAutonomousDatabaseBackups in the following format: projects/{project\}/locations/{location\}. - * parent: 'projects/my-project/locations/my-location', - * }); + * const res = await oracledatabase.projects.locations.cloudVmClusters.get({ + * // Required. The name of the Cloud VM Cluster in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloud_vm_cluster\}. + * name: 'projects/my-project/locations/my-location/cloudVmClusters/my-cloudVmCluster', + * }); * console.log(res.data); * * // Example response * // { - * // "autonomousDatabaseBackups": [], - * // "nextPageToken": "my_nextPageToken" + * // "backupOdbSubnet": "my_backupOdbSubnet", + * // "backupSubnetCidr": "my_backupSubnetCidr", + * // "cidr": "my_cidr", + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "exadataInfrastructure": "my_exadataInfrastructure", + * // "gcpOracleZone": "my_gcpOracleZone", + * // "identityConnector": {}, + * // "labels": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "odbNetwork": "my_odbNetwork", + * // "odbSubnet": "my_odbSubnet", + * // "properties": {} * // } * } * @@ -3415,62 +9522,53 @@ export namespace oracledatabase_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$Autonomousdatabasebackups$List, + get( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Autonomousdatabasebackups$List, + get( + params?: Params$Resource$Projects$Locations$Cloudvmclusters$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Autonomousdatabasebackups$List, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Autonomousdatabasebackups$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Autonomousdatabasebackups$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Get, + callback: BodyResponseCallback ): void; - list( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Autonomousdatabasebackups$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Cloudvmclusters$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$Autonomousdatabasebackups$List; + {}) as Params$Resource$Projects$Locations$Cloudvmclusters$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Autonomousdatabasebackups$List; + params = {} as Params$Resource$Projects$Locations$Cloudvmclusters$Get; options = {}; } @@ -3484,60 +9582,29 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/autonomousDatabaseBackups').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); } } - } - - export interface Params$Resource$Projects$Locations$Autonomousdatabasebackups$List extends StandardParameters { - /** - * Optional. An expression for filtering the results of the request. Only the **autonomous_database_id** field is supported in the following format: `autonomous_database_id="{autonomous_database_id\}"`. The accepted values must be a valid Autonomous Database ID, limited to the naming restrictions of the ID: ^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$). The ID must start with a letter, end with a letter or a number, and be a maximum of 63 characters. - */ - filter?: string; - /** - * Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Backups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * Optional. A token identifying a page of results the server should return. - */ - pageToken?: string; - /** - * Required. The parent value for ListAutonomousDatabaseBackups in the following format: projects/{project\}/locations/{location\}. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Autonomousdatabasecharactersets { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Lists Autonomous Database Character Sets in a given project and location. + * Lists the VM Clusters in a given project and location. * @example * ```js * // Before running the sample: @@ -3566,25 +9633,23 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await oracledatabase.projects.locations.autonomousDatabaseCharacterSets.list( - * { - * // Optional. An expression for filtering the results of the request. Only the **character_set_type** field is supported in the following format: `character_set_type="{characterSetType\}"`. Accepted values include `DATABASE` and `NATIONAL`. - * filter: 'placeholder-value', - * // Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Character Sets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // Optional. A token identifying a page of results the server should return. - * pageToken: 'placeholder-value', - * // Required. The parent value for the Autonomous Database in the following format: projects/{project\}/locations/{location\}. - * parent: 'projects/my-project/locations/my-location', - * }, - * ); + * const res = await oracledatabase.projects.locations.cloudVmClusters.list({ + * // Optional. An expression for filtering the results of the request. + * filter: 'placeholder-value', + * // Optional. The number of VM clusters to return. If unspecified, at most 50 VM clusters will be returned. The maximum value is 1,000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying the page of results the server returns. + * pageToken: 'placeholder-value', + * // Required. The name of the parent in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "autonomousDatabaseCharacterSets": [], - * // "nextPageToken": "my_nextPageToken" + * // "cloudVmClusters": [], + * // "nextPageToken": "my_nextPageToken", + * // "unreachable": [] * // } * } * @@ -3601,61 +9666,56 @@ export namespace oracledatabase_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List, + params: Params$Resource$Projects$Locations$Cloudvmclusters$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List, + params?: Params$Resource$Projects$Locations$Cloudvmclusters$List, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; list( - params: Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List, + params: Params$Resource$Projects$Locations$Cloudvmclusters$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List, + params: Params$Resource$Projects$Locations$Cloudvmclusters$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Cloudvmclusters$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Cloudvmclusters$List + | 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$Autonomousdatabasecharactersets$List; + {}) as Params$Resource$Projects$Locations$Cloudvmclusters$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List; + params = {} as Params$Resource$Projects$Locations$Cloudvmclusters$List; options = {}; } @@ -3669,9 +9729,10 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+parent}/autonomousDatabaseCharacterSets' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/cloudVmClusters').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -3683,45 +9744,82 @@ export namespace oracledatabase_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$Autonomousdatabasecharactersets$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Cloudvmclusters$Create extends StandardParameters { /** - * Optional. An expression for filtering the results of the request. Only the **character_set_type** field is supported in the following format: `character_set_type="{characterSetType\}"`. Accepted values include `DATABASE` and `NATIONAL`. + * Required. The ID of the VM Cluster to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + */ + cloudVmClusterId?: string; + /** + * Required. The name of the parent in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + /** + * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CloudVmCluster; + } + export interface Params$Resource$Projects$Locations$Cloudvmclusters$Delete extends StandardParameters { + /** + * Optional. If set to true, all child resources for the VM Cluster will be deleted. A VM Cluster can only be deleted once all its child resources have been deleted. + */ + force?: boolean; + /** + * Required. The name of the Cloud VM Cluster in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloud_vm_cluster\}. + */ + name?: string; + /** + * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Cloudvmclusters$Get extends StandardParameters { + /** + * Required. The name of the Cloud VM Cluster in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloud_vm_cluster\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Cloudvmclusters$List extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. */ filter?: string; /** - * Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Character Sets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. The number of VM clusters to return. If unspecified, at most 50 VM clusters will be returned. The maximum value is 1,000. */ pageSize?: number; /** - * Optional. A token identifying a page of results the server should return. + * Optional. A token identifying the page of results the server returns. */ pageToken?: string; /** - * Required. The parent value for the Autonomous Database in the following format: projects/{project\}/locations/{location\}. + * Required. The name of the parent in the following format: projects/{project\}/locations/{location\}. */ parent?: string; } - export class Resource$Projects$Locations$Autonomousdatabases { + export class Resource$Projects$Locations$Cloudvmclusters$Dbnodes { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a new Autonomous Database in a given project and location. + * Lists the database nodes of a VM Cluster. * @example * ```js * // Before running the sample: @@ -3748,49 +9846,24 @@ export namespace oracledatabase_v1 { * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await oracledatabase.projects.locations.autonomousDatabases.create({ - * // Required. The ID of the Autonomous Database to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. - * autonomousDatabaseId: 'placeholder-value', - * // Required. The name of the parent in the following format: projects/{project\}/locations/{location\}. - * parent: 'projects/my-project/locations/my-location', - * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "adminPassword": "my_adminPassword", - * // "adminPasswordSecretVersion": "my_adminPasswordSecretVersion", - * // "cidr": "my_cidr", - * // "createTime": "my_createTime", - * // "database": "my_database", - * // "disasterRecoverySupportedLocations": [], - * // "displayName": "my_displayName", - * // "entitlementId": "my_entitlementId", - * // "labels": {}, - * // "name": "my_name", - * // "network": "my_network", - * // "odbNetwork": "my_odbNetwork", - * // "odbSubnet": "my_odbSubnet", - * // "peerAutonomousDatabases": [], - * // "properties": {}, - * // "sourceConfig": {} - * // } - * }, + * + * // Do the magic + * const res = + * await oracledatabase.projects.locations.cloudVmClusters.dbNodes.list({ + * // Optional. The maximum number of items to return. If unspecified, at most 50 db nodes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the node should return. + * pageToken: 'placeholder-value', + * // Required. The parent value for database node in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloudVmCluster\}. . + * parent: + * 'projects/my-project/locations/my-location/cloudVmClusters/my-cloudVmCluster', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "dbNodes": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -3806,54 +9879,54 @@ export namespace oracledatabase_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$Autonomousdatabases$Create, + list( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Autonomousdatabases$Create, + list( + params?: Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Create, + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Autonomousdatabases$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Create; + {}) as Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Autonomousdatabases$Create; + {} as Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List; options = {}; } @@ -3867,11 +9940,11 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/autonomousDatabases').replace( + url: (rootUrl + '/v1/{+parent}/dbNodes').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -3882,17 +9955,39 @@ export namespace oracledatabase_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$Cloudvmclusters$Dbnodes$List extends StandardParameters { /** - * Deletes a single Autonomous Database. + * Optional. The maximum number of items to return. If unspecified, at most 50 db nodes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the node should return. + */ + pageToken?: string; + /** + * Required. The parent value for database node in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloudVmCluster\}. . + */ + parent?: string; + } + + export class Resource$Projects$Locations$Databasecharactersets { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * List DatabaseCharacterSets for the given project and location. * @example * ```js * // Before running the sample: @@ -3922,21 +10017,22 @@ export namespace oracledatabase_v1 { * * // Do the magic * const res = - * await oracledatabase.projects.locations.autonomousDatabases.delete({ - * // Required. The name of the resource in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. - * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', - * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * await oracledatabase.projects.locations.databaseCharacterSets.list({ + * // Optional. An expression for filtering the results of the request. Only the **character_set_type** field is supported in the following format: `character_set_type="{characterSetType\}"`. Accepted values include `DATABASE` and `NATIONAL`. + * filter: 'placeholder-value', + * // Optional. The maximum number of DatabaseCharacterSets to return. The service may return fewer than this value. If unspecified, at most 50 DatabaseCharacterSets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous `ListDatabaseCharacterSets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDatabaseCharacterSets` must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The parent value for DatabaseCharacterSets in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "databaseCharacterSets": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -3952,54 +10048,62 @@ export namespace oracledatabase_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$Autonomousdatabases$Delete, + list( + params: Params$Resource$Projects$Locations$Databasecharactersets$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Autonomousdatabases$Delete, + list( + params?: Params$Resource$Projects$Locations$Databasecharactersets$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Databasecharactersets$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Databasecharactersets$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Databasecharactersets$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Autonomousdatabases$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Databasecharactersets$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$Autonomousdatabases$Delete; + {}) as Params$Resource$Projects$Locations$Databasecharactersets$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Autonomousdatabases$Delete; + {} as Params$Resource$Projects$Locations$Databasecharactersets$List; options = {}; } @@ -4013,29 +10117,60 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/databaseCharacterSets').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$Databasecharactersets$List extends StandardParameters { /** - * Initiates a failover to target autonomous database from the associated primary database. + * Optional. An expression for filtering the results of the request. Only the **character_set_type** field is supported in the following format: `character_set_type="{characterSetType\}"`. Accepted values include `DATABASE` and `NATIONAL`. + */ + filter?: string; + /** + * Optional. The maximum number of DatabaseCharacterSets to return. The service may return fewer than this value. If unspecified, at most 50 DatabaseCharacterSets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListDatabaseCharacterSets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDatabaseCharacterSets` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent value for DatabaseCharacterSets in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Databases { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets details of a single Database. * @example * ```js * // Before running the sample: @@ -4064,28 +10199,32 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await oracledatabase.projects.locations.autonomousDatabases.failover({ - * // Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. - * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "peerAutonomousDatabase": "my_peerAutonomousDatabase" - * // } - * }, - * }); + * const res = await oracledatabase.projects.locations.databases.get({ + * // Required. The name of the Database resource in the following format: projects/{project\}/locations/{region\}/databases/{database\} + * name: 'projects/my-project/locations/my-location/databases/my-database', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "adminPassword": "my_adminPassword", + * // "adminPasswordSecretVersion": "my_adminPasswordSecretVersion", + * // "characterSet": "my_characterSet", + * // "createTime": "my_createTime", + * // "databaseId": "my_databaseId", + * // "dbHomeName": "my_dbHomeName", + * // "dbName": "my_dbName", + * // "dbUniqueName": "my_dbUniqueName", + * // "gcpOracleZone": "my_gcpOracleZone", * // "name": "my_name", - * // "response": {} + * // "ncharacterSet": "my_ncharacterSet", + * // "ociUrl": "my_ociUrl", + * // "opsInsightsStatus": "my_opsInsightsStatus", + * // "pluggableDatabaseId": "my_pluggableDatabaseId", + * // "pluggableDatabaseName": "my_pluggableDatabaseName", + * // "properties": {}, + * // "tdeWalletPassword": "my_tdeWalletPassword", + * // "tdeWalletPasswordSecretVersion": "my_tdeWalletPasswordSecretVersion" * // } * } * @@ -4101,54 +10240,53 @@ export namespace oracledatabase_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - failover( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Failover, + get( + params: Params$Resource$Projects$Locations$Databases$Get, options: StreamMethodOptions ): Promise>; - failover( - params?: Params$Resource$Projects$Locations$Autonomousdatabases$Failover, + get( + params?: Params$Resource$Projects$Locations$Databases$Get, options?: MethodOptions - ): Promise>; - failover( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Failover, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Databases$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - failover( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Failover, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Databases$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - failover( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Failover, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Databases$Get, + callback: BodyResponseCallback ): void; - failover(callback: BodyResponseCallback): void; - failover( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Autonomousdatabases$Failover - | BodyResponseCallback + | Params$Resource$Projects$Locations$Databases$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$Autonomousdatabases$Failover; + {}) as Params$Resource$Projects$Locations$Databases$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Autonomousdatabases$Failover; + params = {} as Params$Resource$Projects$Locations$Databases$Get; options = {}; } @@ -4162,11 +10300,8 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:failover').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -4177,17 +10312,17 @@ export namespace oracledatabase_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Generates a wallet for an Autonomous Database. + * Lists all the Databases for the given project, location and DbSystem. * @example * ```js * // Before running the sample: @@ -4216,26 +10351,22 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await oracledatabase.projects.locations.autonomousDatabases.generateWallet({ - * // Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. - * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "isRegional": false, - * // "password": "my_password", - * // "type": "my_type" - * // } - * }, - * }); + * const res = await oracledatabase.projects.locations.databases.list({ + * // Optional. An expression for filtering the results of the request. list for container databases is supported only with a valid dbSystem (full resource name) filter in this format: `dbSystem="projects/{project\}/locations/{location\}/dbSystems/{dbSystemId\}"` + * filter: 'placeholder-value', + * // Optional. The maximum number of items to return. If unspecified, a maximum of 50 Databases will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token. + * pageToken: 'placeholder-value', + * // Required. The parent resource name in the following format: projects/{project\}/locations/{region\} + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "archiveContent": "my_archiveContent" + * // "databases": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -4251,62 +10382,55 @@ export namespace oracledatabase_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - generateWallet( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet, + list( + params: Params$Resource$Projects$Locations$Databases$List, options: StreamMethodOptions ): Promise>; - generateWallet( - params?: Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet, + list( + params?: Params$Resource$Projects$Locations$Databases$List, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - generateWallet( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet, + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Databases$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - generateWallet( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet, + list( + params: Params$Resource$Projects$Locations$Databases$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - generateWallet( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - generateWallet( - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Databases$List, + callback: BodyResponseCallback ): void; - generateWallet( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet - | BodyResponseCallback + | Params$Resource$Projects$Locations$Databases$List + | 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$Autonomousdatabases$Generatewallet; + {}) as Params$Resource$Projects$Locations$Databases$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet; + params = {} as Params$Resource$Projects$Locations$Databases$List; options = {}; } @@ -4320,34 +10444,64 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:generateWallet').replace( + url: (rootUrl + '/v1/{+parent}/databases').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Databases$Get extends StandardParameters { /** - * Gets the details of a single Autonomous Database. + * Required. The name of the Database resource in the following format: projects/{project\}/locations/{region\}/databases/{database\} + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Databases$List extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. list for container databases is supported only with a valid dbSystem (full resource name) filter in this format: `dbSystem="projects/{project\}/locations/{location\}/dbSystems/{dbSystemId\}"` + */ + filter?: string; + /** + * Optional. The maximum number of items to return. If unspecified, a maximum of 50 Databases will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token. + */ + pageToken?: string; + /** + * Required. The parent resource name in the following format: projects/{project\}/locations/{region\} + */ + parent?: string; + } + + export class Resource$Projects$Locations$Dbsysteminitialstoragesizes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists all the DbSystemInitialStorageSizes for the given project and location. * @example * ```js * // Before running the sample: @@ -4376,30 +10530,21 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.autonomousDatabases.get({ - * // Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. - * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', - * }); + * const res = + * await oracledatabase.projects.locations.dbSystemInitialStorageSizes.list({ + * // Optional. The maximum number of items to return. If unspecified, a maximum of 50 DbSystemInitialStorageSizes will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token. + * pageToken: 'placeholder-value', + * // Required. The parent value for the DbSystemInitialStorageSize resource with the format: projects/{project\}/locations/{location\} + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "adminPassword": "my_adminPassword", - * // "adminPasswordSecretVersion": "my_adminPasswordSecretVersion", - * // "cidr": "my_cidr", - * // "createTime": "my_createTime", - * // "database": "my_database", - * // "disasterRecoverySupportedLocations": [], - * // "displayName": "my_displayName", - * // "entitlementId": "my_entitlementId", - * // "labels": {}, - * // "name": "my_name", - * // "network": "my_network", - * // "odbNetwork": "my_odbNetwork", - * // "odbSubnet": "my_odbSubnet", - * // "peerAutonomousDatabases": [], - * // "properties": {}, - * // "sourceConfig": {} + * // "dbSystemInitialStorageSizes": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -4415,54 +10560,62 @@ export namespace oracledatabase_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$Autonomousdatabases$Get, + list( + params: Params$Resource$Projects$Locations$Dbsysteminitialstoragesizes$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Autonomousdatabases$Get, + list( + params?: Params$Resource$Projects$Locations$Dbsysteminitialstoragesizes$List, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Dbsysteminitialstoragesizes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Dbsysteminitialstoragesizes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Dbsysteminitialstoragesizes$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Autonomousdatabases$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Dbsysteminitialstoragesizes$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$Autonomousdatabases$Get; + {}) as Params$Resource$Projects$Locations$Dbsysteminitialstoragesizes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Autonomousdatabases$Get; + {} as Params$Resource$Projects$Locations$Dbsysteminitialstoragesizes$List; options = {}; } @@ -4476,29 +10629,55 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: ( + rootUrl + '/v1/{+parent}/dbSystemInitialStorageSizes' + ).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$Dbsysteminitialstoragesizes$List extends StandardParameters { + /** + * Optional. The maximum number of items to return. If unspecified, a maximum of 50 DbSystemInitialStorageSizes will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token. + */ + pageToken?: string; + /** + * Required. The parent value for the DbSystemInitialStorageSize resource with the format: projects/{project\}/locations/{location\} + */ + parent?: string; + } + + export class Resource$Projects$Locations$Dbsystems { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Lists the Autonomous Databases in a given project and location. + * Creates a new DbSystem in a given project and location. * @example * ```js * // Before running the sample: @@ -4527,25 +10706,40 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.autonomousDatabases.list({ - * // Optional. An expression for filtering the results of the request. - * filter: 'placeholder-value', - * // Optional. An expression for ordering the results of the request. - * orderBy: 'placeholder-value', - * // Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous Database will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // Optional. A token identifying a page of results the server should return. - * pageToken: 'placeholder-value', - * // Required. The parent value for the Autonomous Database in the following format: projects/{project\}/locations/{location\}. + * const res = await oracledatabase.projects.locations.dbSystems.create({ + * // Required. The ID of the DbSystem to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + * dbSystemId: 'placeholder-value', + * // Required. The value for parent of the DbSystem in the following format: projects/{project\}/locations/{location\}. * parent: 'projects/my-project/locations/my-location', + * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "entitlementId": "my_entitlementId", + * // "gcpOracleZone": "my_gcpOracleZone", + * // "labels": {}, + * // "name": "my_name", + * // "ociUrl": "my_ociUrl", + * // "odbNetwork": "my_odbNetwork", + * // "odbSubnet": "my_odbSubnet", + * // "properties": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "autonomousDatabases": [], - * // "nextPageToken": "my_nextPageToken", - * // "unreachable": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -4561,58 +10755,53 @@ export namespace oracledatabase_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$Autonomousdatabases$List, + create( + params: Params$Resource$Projects$Locations$Dbsystems$Create, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Autonomousdatabases$List, + create( + params?: Params$Resource$Projects$Locations$Dbsystems$Create, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Autonomousdatabases$List, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Dbsystems$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Autonomousdatabases$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Autonomousdatabases$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Dbsystems$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Dbsystems$Create, + callback: BodyResponseCallback ): void; - list( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Autonomousdatabases$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Dbsystems$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$Autonomousdatabases$List; + {}) as Params$Resource$Projects$Locations$Dbsystems$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Autonomousdatabases$List; + params = {} as Params$Resource$Projects$Locations$Dbsystems$Create; options = {}; } @@ -4626,11 +10815,11 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/autonomousDatabases').replace( + url: (rootUrl + '/v1/{+parent}/dbSystems').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -4641,19 +10830,17 @@ export namespace oracledatabase_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates the parameters of a single Autonomous Database. + * Deletes a single DbSystem. * @example * ```js * // Before running the sample: @@ -4682,39 +10869,12 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.autonomousDatabases.patch( - * { - * // Identifier. The name of the Autonomous Database resource in the following format: projects/{project\}/locations/{region\}/autonomousDatabases/{autonomous_database\} - * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', - * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * // Optional. Field mask is used to specify the fields to be overwritten in the Exadata resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "adminPassword": "my_adminPassword", - * // "adminPasswordSecretVersion": "my_adminPasswordSecretVersion", - * // "cidr": "my_cidr", - * // "createTime": "my_createTime", - * // "database": "my_database", - * // "disasterRecoverySupportedLocations": [], - * // "displayName": "my_displayName", - * // "entitlementId": "my_entitlementId", - * // "labels": {}, - * // "name": "my_name", - * // "network": "my_network", - * // "odbNetwork": "my_odbNetwork", - * // "odbSubnet": "my_odbSubnet", - * // "peerAutonomousDatabases": [], - * // "properties": {}, - * // "sourceConfig": {} - * // } - * }, - * }, - * ); + * const res = await oracledatabase.projects.locations.dbSystems.delete({ + * // Required. The name of the DbSystem in the following format: projects/{project\}/locations/{location\}/dbSystems/{db_system\}. + * name: 'projects/my-project/locations/my-location/dbSystems/my-dbSystem', + * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -4739,32 +10899,32 @@ export namespace oracledatabase_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$Autonomousdatabases$Patch, + delete( + params: Params$Resource$Projects$Locations$Dbsystems$Delete, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Autonomousdatabases$Patch, + delete( + params?: Params$Resource$Projects$Locations$Dbsystems$Delete, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Patch, + delete( + params: Params$Resource$Projects$Locations$Dbsystems$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Patch, + delete( + params: Params$Resource$Projects$Locations$Dbsystems$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Patch, + delete( + params: Params$Resource$Projects$Locations$Dbsystems$Delete, callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Autonomousdatabases$Patch + | Params$Resource$Projects$Locations$Dbsystems$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -4780,13 +10940,12 @@ export namespace oracledatabase_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Patch; + {}) as Params$Resource$Projects$Locations$Dbsystems$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Autonomousdatabases$Patch; + params = {} as Params$Resource$Projects$Locations$Dbsystems$Delete; options = {}; } @@ -4801,7 +10960,7 @@ export namespace oracledatabase_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -4822,7 +10981,7 @@ export namespace oracledatabase_v1 { } /** - * Restarts an Autonomous Database. + * Gets details of a single DbSystem. * @example * ```js * // Before running the sample: @@ -4851,26 +11010,24 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await oracledatabase.projects.locations.autonomousDatabases.restart({ - * // Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. - * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }); + * const res = await oracledatabase.projects.locations.dbSystems.get({ + * // Required. The name of the DbSystem in the following format: projects/{project\}/locations/{location\}/dbSystems/{db_system\}. + * name: 'projects/my-project/locations/my-location/dbSystems/my-dbSystem', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "entitlementId": "my_entitlementId", + * // "gcpOracleZone": "my_gcpOracleZone", + * // "labels": {}, * // "name": "my_name", - * // "response": {} + * // "ociUrl": "my_ociUrl", + * // "odbNetwork": "my_odbNetwork", + * // "odbSubnet": "my_odbSubnet", + * // "properties": {} * // } * } * @@ -4886,54 +11043,53 @@ export namespace oracledatabase_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - restart( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Restart, + get( + params: Params$Resource$Projects$Locations$Dbsystems$Get, options: StreamMethodOptions ): Promise>; - restart( - params?: Params$Resource$Projects$Locations$Autonomousdatabases$Restart, + get( + params?: Params$Resource$Projects$Locations$Dbsystems$Get, options?: MethodOptions - ): Promise>; - restart( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Restart, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Dbsystems$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - restart( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Restart, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Dbsystems$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - restart( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Restart, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Dbsystems$Get, + callback: BodyResponseCallback ): void; - restart(callback: BodyResponseCallback): void; - restart( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Autonomousdatabases$Restart - | BodyResponseCallback + | Params$Resource$Projects$Locations$Dbsystems$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$Autonomousdatabases$Restart; + {}) as Params$Resource$Projects$Locations$Dbsystems$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Autonomousdatabases$Restart; + params = {} as Params$Resource$Projects$Locations$Dbsystems$Get; options = {}; } @@ -4947,11 +11103,8 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:restart').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -4962,17 +11115,17 @@ export namespace oracledatabase_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Restores a single Autonomous Database. + * Lists all the DbSystems for the given project and location. * @example * ```js * // Before running the sample: @@ -5001,28 +11154,25 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await oracledatabase.projects.locations.autonomousDatabases.restore({ - * // Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. - * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "restoreTime": "my_restoreTime" - * // } - * }, - * }); + * const res = await oracledatabase.projects.locations.dbSystems.list({ + * // Optional. An expression for filtering the results of the request. + * filter: 'placeholder-value', + * // Optional. An expression for ordering the results of the request. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of items to return. If unspecified, at most 50 DbSystems will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. The parent value for DbSystems in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "dbSystems": [], + * // "nextPageToken": "my_nextPageToken", + * // "unreachable": [] * // } * } * @@ -5038,54 +11188,55 @@ export namespace oracledatabase_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - restore( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Restore, + list( + params: Params$Resource$Projects$Locations$Dbsystems$List, options: StreamMethodOptions ): Promise>; - restore( - params?: Params$Resource$Projects$Locations$Autonomousdatabases$Restore, + list( + params?: Params$Resource$Projects$Locations$Dbsystems$List, options?: MethodOptions - ): Promise>; - restore( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Restore, + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Dbsystems$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - restore( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Restore, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Dbsystems$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - restore( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Restore, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Dbsystems$List, + callback: BodyResponseCallback ): void; - restore(callback: BodyResponseCallback): void; - restore( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Autonomousdatabases$Restore - | BodyResponseCallback + | Params$Resource$Projects$Locations$Dbsystems$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Restore; + {}) as Params$Resource$Projects$Locations$Dbsystems$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Autonomousdatabases$Restore; + params = {} as Params$Resource$Projects$Locations$Dbsystems$List; options = {}; } @@ -5099,32 +11250,97 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:restore').replace( + url: (rootUrl + '/v1/{+parent}/dbSystems').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Projects$Locations$Dbsystems$Create extends StandardParameters { + /** + * Required. The ID of the DbSystem to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + */ + dbSystemId?: string; + /** + * Required. The value for parent of the DbSystem in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; /** - * Starts an Autonomous Database. + * Request body metadata + */ + requestBody?: Schema$DbSystem; + } + export interface Params$Resource$Projects$Locations$Dbsystems$Delete extends StandardParameters { + /** + * Required. The name of the DbSystem in the following format: projects/{project\}/locations/{location\}/dbSystems/{db_system\}. + */ + name?: string; + /** + * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Dbsystems$Get extends StandardParameters { + /** + * Required. The name of the DbSystem in the following format: projects/{project\}/locations/{location\}/dbSystems/{db_system\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Dbsystems$List extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. + */ + filter?: string; + /** + * Optional. An expression for ordering the results of the request. + */ + orderBy?: string; + /** + * Optional. The maximum number of items to return. If unspecified, at most 50 DbSystems will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The parent value for DbSystems in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Dbsystemshapes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists the database system shapes available for the project and location. * @example * ```js * // Before running the sample: @@ -5153,27 +11369,22 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.autonomousDatabases.start( - * { - * // Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. - * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * const res = await oracledatabase.projects.locations.dbSystemShapes.list({ + * // Optional. An expression for filtering the results of the request. Only the gcp_oracle_zone_id field is supported in this format: `gcp_oracle_zone_id="{gcp_oracle_zone_id\}"`. + * filter: 'placeholder-value', + * // Optional. The maximum number of items to return. If unspecified, at most 50 database system shapes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. The parent value for Database System Shapes in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "dbSystemShapes": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -5189,54 +11400,57 @@ export namespace oracledatabase_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - start( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Start, + list( + params: Params$Resource$Projects$Locations$Dbsystemshapes$List, options: StreamMethodOptions ): Promise>; - start( - params?: Params$Resource$Projects$Locations$Autonomousdatabases$Start, + list( + params?: Params$Resource$Projects$Locations$Dbsystemshapes$List, options?: MethodOptions - ): Promise>; - start( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Start, + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Dbsystemshapes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - start( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Start, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Dbsystemshapes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - start( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Start, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Dbsystemshapes$List, + callback: BodyResponseCallback ): void; - start(callback: BodyResponseCallback): void; - start( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Autonomousdatabases$Start - | BodyResponseCallback + | Params$Resource$Projects$Locations$Dbsystemshapes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Start; + {}) as Params$Resource$Projects$Locations$Dbsystemshapes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Autonomousdatabases$Start; + params = {} as Params$Resource$Projects$Locations$Dbsystemshapes$List; options = {}; } @@ -5250,29 +11464,58 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:start').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+parent}/dbSystemShapes').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$Dbsystemshapes$List extends StandardParameters { /** - * Stops an Autonomous Database. + * Optional. An expression for filtering the results of the request. Only the gcp_oracle_zone_id field is supported in this format: `gcp_oracle_zone_id="{gcp_oracle_zone_id\}"`. + */ + filter?: string; + /** + * Optional. The maximum number of items to return. If unspecified, at most 50 database system shapes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The parent value for Database System Shapes in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Dbversions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * List DbVersions for the given project and location. * @example * ```js * // Before running the sample: @@ -5301,25 +11544,22 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.autonomousDatabases.stop({ - * // Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. - * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, + * const res = await oracledatabase.projects.locations.dbVersions.list({ + * // Optional. Filter expression that matches a subset of the DbVersions to show. The supported filter for dbSystem creation is `db_system_shape = {db_system_shape\} AND storage_management = {storage_management\}`. If no filter is provided, all DbVersions will be returned. + * filter: 'placeholder-value', + * // Optional. The maximum number of items to return. If unspecified, a maximum of 50 DbVersions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token. + * pageToken: 'placeholder-value', + * // Required. The parent value for the DbVersion resource with the format: projects/{project\}/locations/{location\} + * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "dbVersions": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -5335,54 +11575,55 @@ export namespace oracledatabase_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$Autonomousdatabases$Stop, + list( + params: Params$Resource$Projects$Locations$Dbversions$List, options: StreamMethodOptions ): Promise>; - stop( - params?: Params$Resource$Projects$Locations$Autonomousdatabases$Stop, + list( + params?: Params$Resource$Projects$Locations$Dbversions$List, options?: MethodOptions - ): Promise>; - stop( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Stop, + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Dbversions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - stop( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Stop, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Dbversions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - stop( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Stop, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Dbversions$List, + callback: BodyResponseCallback ): void; - stop(callback: BodyResponseCallback): void; - stop( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Autonomousdatabases$Stop - | BodyResponseCallback + | Params$Resource$Projects$Locations$Dbversions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Stop; + {}) as Params$Resource$Projects$Locations$Dbversions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Autonomousdatabases$Stop; + params = {} as Params$Resource$Projects$Locations$Dbversions$List; options = {}; } @@ -5396,29 +11637,58 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:stop').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+parent}/dbVersions').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$Dbversions$List extends StandardParameters { /** - * Initiates a switchover of specified autonomous database to the associated peer database. + * Optional. Filter expression that matches a subset of the DbVersions to show. The supported filter for dbSystem creation is `db_system_shape = {db_system_shape\} AND storage_management = {storage_management\}`. If no filter is provided, all DbVersions will be returned. + */ + filter?: string; + /** + * Optional. The maximum number of items to return. If unspecified, a maximum of 50 DbVersions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token. + */ + pageToken?: string; + /** + * Required. The parent value for the DbVersion resource with the format: projects/{project\}/locations/{location\} + */ + parent?: string; + } + + export class Resource$Projects$Locations$Entitlements { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists the entitlements in a given project. * @example * ```js * // Before running the sample: @@ -5447,28 +11717,20 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await oracledatabase.projects.locations.autonomousDatabases.switchover({ - * // Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. - * name: 'projects/my-project/locations/my-location/autonomousDatabases/my-autonomousDatabase', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "peerAutonomousDatabase": "my_peerAutonomousDatabase" - * // } - * }, - * }); + * const res = await oracledatabase.projects.locations.entitlements.list({ + * // Optional. The maximum number of items to return. If unspecified, a maximum of 50 entitlements will be returned. The maximum value is 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. The parent value for the entitlement in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "entitlements": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -5484,54 +11746,55 @@ export namespace oracledatabase_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - switchover( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Switchover, + list( + params: Params$Resource$Projects$Locations$Entitlements$List, options: StreamMethodOptions ): Promise>; - switchover( - params?: Params$Resource$Projects$Locations$Autonomousdatabases$Switchover, - options?: MethodOptions - ): Promise>; - switchover( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Switchover, + list( + params?: Params$Resource$Projects$Locations$Entitlements$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Entitlements$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - switchover( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Switchover, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Entitlements$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - switchover( - params: Params$Resource$Projects$Locations$Autonomousdatabases$Switchover, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Entitlements$List, + callback: BodyResponseCallback ): void; - switchover(callback: BodyResponseCallback): void; - switchover( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Autonomousdatabases$Switchover - | BodyResponseCallback + | Params$Resource$Projects$Locations$Entitlements$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Switchover; + {}) as Params$Resource$Projects$Locations$Entitlements$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Autonomousdatabases$Switchover; + params = {} as Params$Resource$Projects$Locations$Entitlements$List; options = {}; } @@ -5545,99 +11808,34 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:switchover').replace( + url: (rootUrl + '/v1/{+parent}/entitlements').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Autonomousdatabases$Create extends StandardParameters { - /** - * Required. The ID of the Autonomous Database to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. - */ - autonomousDatabaseId?: string; - /** - * Required. The name of the parent in the following format: projects/{project\}/locations/{location\}. - */ - parent?: string; - /** - * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AutonomousDatabase; - } - export interface Params$Resource$Projects$Locations$Autonomousdatabases$Delete extends StandardParameters { - /** - * Required. The name of the resource in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. - */ - name?: string; - /** - * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Projects$Locations$Autonomousdatabases$Failover extends StandardParameters { - /** - * Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FailoverAutonomousDatabaseRequest; - } - export interface Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet extends StandardParameters { - /** - * Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GenerateAutonomousDatabaseWalletRequest; - } - export interface Params$Resource$Projects$Locations$Autonomousdatabases$Get extends StandardParameters { - /** - * Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Autonomousdatabases$List extends StandardParameters { - /** - * Optional. An expression for filtering the results of the request. - */ - filter?: string; - /** - * Optional. An expression for ordering the results of the request. - */ - orderBy?: string; + export interface Params$Resource$Projects$Locations$Entitlements$List extends StandardParameters { /** - * Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous Database will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. The maximum number of items to return. If unspecified, a maximum of 50 entitlements will be returned. The maximum value is 1000. */ pageSize?: number; /** @@ -5645,93 +11843,187 @@ export namespace oracledatabase_v1 { */ pageToken?: string; /** - * Required. The parent value for the Autonomous Database in the following format: projects/{project\}/locations/{location\}. + * Required. The parent value for the entitlement in the following format: projects/{project\}/locations/{location\}. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Autonomousdatabases$Patch extends StandardParameters { - /** - * Identifier. The name of the Autonomous Database resource in the following format: projects/{project\}/locations/{region\}/autonomousDatabases/{autonomous_database\} - */ - name?: string; - /** - * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * Optional. Field mask is used to specify the fields to be overwritten in the Exadata resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AutonomousDatabase; - } - export interface Params$Resource$Projects$Locations$Autonomousdatabases$Restart extends StandardParameters { - /** - * Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RestartAutonomousDatabaseRequest; - } - export interface Params$Resource$Projects$Locations$Autonomousdatabases$Restore extends StandardParameters { - /** - * Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. - */ - name?: string; - /** - * Request body metadata - */ - requestBody?: Schema$RestoreAutonomousDatabaseRequest; - } - export interface Params$Resource$Projects$Locations$Autonomousdatabases$Start extends StandardParameters { - /** - * Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. - */ - name?: string; + export class Resource$Projects$Locations$Exadbvmclusters { + context: APIRequestContext; + dbNodes: Resource$Projects$Locations$Exadbvmclusters$Dbnodes; + constructor(context: APIRequestContext) { + this.context = context; + this.dbNodes = new Resource$Projects$Locations$Exadbvmclusters$Dbnodes( + this.context + ); + } /** - * Request body metadata - */ - requestBody?: Schema$StartAutonomousDatabaseRequest; - } - export interface Params$Resource$Projects$Locations$Autonomousdatabases$Stop extends StandardParameters { - /** - * Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + * Creates a new Exadb (Exascale) VM Cluster resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/oracledatabase.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const oracledatabase = google.oracledatabase('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await oracledatabase.projects.locations.exadbVmClusters.create({ + * // Required. The ID of the ExadbVmCluster to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + * exadbVmClusterId: 'placeholder-value', + * // Required. The value for parent of the ExadbVmCluster in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "backupOdbSubnet": "my_backupOdbSubnet", + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "entitlementId": "my_entitlementId", + * // "gcpOracleZone": "my_gcpOracleZone", + * // "labels": {}, + * // "name": "my_name", + * // "odbNetwork": "my_odbNetwork", + * // "odbSubnet": "my_odbSubnet", + * // "properties": {} + * // } + * }, + * }); + * 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. */ - name?: string; + create( + params: Params$Resource$Projects$Locations$Exadbvmclusters$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Exadbvmclusters$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Exadbvmclusters$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Exadbvmclusters$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Exadbvmclusters$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Exadbvmclusters$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Exadbvmclusters$Create; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$StopAutonomousDatabaseRequest; - } - export interface Params$Resource$Projects$Locations$Autonomousdatabases$Switchover extends StandardParameters { - /** - * Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. - */ - name?: string; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Exadbvmclusters$Create; + options = {}; + } - /** - * Request body metadata - */ - requestBody?: Schema$SwitchoverAutonomousDatabaseRequest; - } + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } - export class Resource$Projects$Locations$Autonomousdbversions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/exadbVmClusters').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); + } } /** - * Lists all the available Autonomous Database versions for a project and location. + * Deletes a single Exadb (Exascale) VM Cluster. * @example * ```js * // Before running the sample: @@ -5760,22 +12052,21 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.autonomousDbVersions.list( - * { - * // Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // Optional. A token identifying a page of results the server should return. - * pageToken: 'placeholder-value', - * // Required. The parent value for the Autonomous Database in the following format: projects/{project\}/locations/{location\}. - * parent: 'projects/my-project/locations/my-location', - * }, - * ); + * const res = await oracledatabase.projects.locations.exadbVmClusters.delete({ + * // Required. The name of the ExadbVmCluster in the following format: projects/{project\}/locations/{location\}/exadbVmClusters/{exadb_vm_cluster\}. + * name: 'projects/my-project/locations/my-location/exadbVmClusters/my-exadbVmCluster', + * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "autonomousDbVersions": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -5791,62 +12082,54 @@ export namespace oracledatabase_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$Autonomousdbversions$List, + delete( + params: Params$Resource$Projects$Locations$Exadbvmclusters$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Autonomousdbversions$List, + delete( + params?: Params$Resource$Projects$Locations$Exadbvmclusters$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Autonomousdbversions$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Exadbvmclusters$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Autonomousdbversions$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Autonomousdbversions$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Exadbvmclusters$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Exadbvmclusters$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Autonomousdbversions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Exadbvmclusters$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$Autonomousdbversions$List; + {}) as Params$Resource$Projects$Locations$Exadbvmclusters$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Autonomousdbversions$List; + {} as Params$Resource$Projects$Locations$Exadbvmclusters$Delete; options = {}; } @@ -5860,61 +12143,29 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/autonomousDbVersions').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); } } - } - - export interface Params$Resource$Projects$Locations$Autonomousdbversions$List extends StandardParameters { - /** - * Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * Optional. A token identifying a page of results the server should return. - */ - pageToken?: string; - /** - * Required. The parent value for the Autonomous Database in the following format: projects/{project\}/locations/{location\}. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Cloudexadatainfrastructures { - context: APIRequestContext; - dbServers: Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers; - constructor(context: APIRequestContext) { - this.context = context; - this.dbServers = - new Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers( - this.context - ); - } /** - * Creates a new Exadata Infrastructure in a given project and location. + * Gets details of a single Exadb (Exascale) VM Cluster. * @example * ```js * // Before running the sample: @@ -5943,38 +12194,24 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await oracledatabase.projects.locations.cloudExadataInfrastructures.create({ - * // Required. The ID of the Exadata Infrastructure to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. - * cloudExadataInfrastructureId: 'placeholder-value', - * // Required. The parent value for CloudExadataInfrastructure in the following format: projects/{project\}/locations/{location\}. - * parent: 'projects/my-project/locations/my-location', - * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "entitlementId": "my_entitlementId", - * // "gcpOracleZone": "my_gcpOracleZone", - * // "labels": {}, - * // "name": "my_name", - * // "properties": {} - * // } - * }, - * }); + * const res = await oracledatabase.projects.locations.exadbVmClusters.get({ + * // Required. The name of the ExadbVmCluster in the following format: projects/{project\}/locations/{location\}/exadbVmClusters/{exadb_vm_cluster\}. + * name: 'projects/my-project/locations/my-location/exadbVmClusters/my-exadbVmCluster', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "backupOdbSubnet": "my_backupOdbSubnet", + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "entitlementId": "my_entitlementId", + * // "gcpOracleZone": "my_gcpOracleZone", + * // "labels": {}, * // "name": "my_name", - * // "response": {} + * // "odbNetwork": "my_odbNetwork", + * // "odbSubnet": "my_odbSubnet", + * // "properties": {} * // } * } * @@ -5990,54 +12227,53 @@ export namespace oracledatabase_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$Cloudexadatainfrastructures$Create, + get( + params: Params$Resource$Projects$Locations$Exadbvmclusters$Get, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create, + get( + params?: Params$Resource$Projects$Locations$Exadbvmclusters$Get, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Exadbvmclusters$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Exadbvmclusters$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Exadbvmclusters$Get, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Exadbvmclusters$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$Cloudexadatainfrastructures$Create; + {}) as Params$Resource$Projects$Locations$Exadbvmclusters$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create; + params = {} as Params$Resource$Projects$Locations$Exadbvmclusters$Get; options = {}; } @@ -6051,31 +12287,29 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+parent}/cloudExadataInfrastructures' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a single Exadata Infrastructure. + * Lists all the Exadb (Exascale) VM Clusters for the given project and location. * @example * ```js * // Before running the sample: @@ -6104,24 +12338,25 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await oracledatabase.projects.locations.cloudExadataInfrastructures.delete({ - * // Optional. If set to true, all VM clusters for this Exadata Infrastructure will be deleted. An Exadata Infrastructure can only be deleted once all its VM clusters have been deleted. - * force: 'placeholder-value', - * // Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project\}/locations/{location\}/cloudExadataInfrastructures/{cloud_exadata_infrastructure\}. - * name: 'projects/my-project/locations/my-location/cloudExadataInfrastructures/my-cloudExadataInfrastructure', - * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * }); + * const res = await oracledatabase.projects.locations.exadbVmClusters.list({ + * // Optional. An expression for filtering the results of the request. + * filter: 'placeholder-value', + * // Optional. An expression for ordering the results of the request. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of items to return. If unspecified, at most 50 ExadbVmClusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. The parent value for ExadbVmClusters in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "exadbVmClusters": [], + * // "nextPageToken": "my_nextPageToken", + * // "unreachable": [] * // } * } * @@ -6137,54 +12372,57 @@ export namespace oracledatabase_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$Cloudexadatainfrastructures$Delete, + list( + params: Params$Resource$Projects$Locations$Exadbvmclusters$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete, + list( + params?: Params$Resource$Projects$Locations$Exadbvmclusters$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete, + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Exadbvmclusters$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Exadbvmclusters$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Exadbvmclusters$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Exadbvmclusters$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete; + {}) as Params$Resource$Projects$Locations$Exadbvmclusters$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete; + params = {} as Params$Resource$Projects$Locations$Exadbvmclusters$List; options = {}; } @@ -6198,29 +12436,32 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/exadbVmClusters').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets details of a single Exadata Infrastructure. + * Updates a single Exadb (Exascale) VM Cluster. To add virtual machines to existing exadb vm cluster, only pass the node count. * @example * ```js * // Before running the sample: @@ -6249,22 +12490,40 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await oracledatabase.projects.locations.cloudExadataInfrastructures.get({ - * // Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project\}/locations/{location\}/cloudExadataInfrastructures/{cloud_exadata_infrastructure\}. - * name: 'projects/my-project/locations/my-location/cloudExadataInfrastructures/my-cloudExadataInfrastructure', - * }); + * const res = await oracledatabase.projects.locations.exadbVmClusters.patch({ + * // Identifier. The name of the ExadbVmCluster resource in the following format: projects/{project\}/locations/{region\}/exadbVmClusters/{exadb_vm_cluster\} + * name: 'projects/my-project/locations/my-location/exadbVmClusters/my-exadbVmCluster', + * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Optional. A mask specifying which fields in th VM Cluster should be updated. A field specified in the mask is overwritten. If a mask isn't provided then all the fields in the VM Cluster are overwritten. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "backupOdbSubnet": "my_backupOdbSubnet", + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "entitlementId": "my_entitlementId", + * // "gcpOracleZone": "my_gcpOracleZone", + * // "labels": {}, + * // "name": "my_name", + * // "odbNetwork": "my_odbNetwork", + * // "odbSubnet": "my_odbSubnet", + * // "properties": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "entitlementId": "my_entitlementId", - * // "gcpOracleZone": "my_gcpOracleZone", - * // "labels": {}, + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "properties": {} + * // "response": {} * // } * } * @@ -6280,58 +12539,53 @@ export namespace oracledatabase_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$Cloudexadatainfrastructures$Get, + patch( + params: Params$Resource$Projects$Locations$Exadbvmclusters$Patch, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get, + patch( + params?: Params$Resource$Projects$Locations$Exadbvmclusters$Patch, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Exadbvmclusters$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Exadbvmclusters$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Exadbvmclusters$Patch, + callback: BodyResponseCallback ): void; - get( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Exadbvmclusters$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$Cloudexadatainfrastructures$Get; + {}) as Params$Resource$Projects$Locations$Exadbvmclusters$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get; + params = {} as Params$Resource$Projects$Locations$Exadbvmclusters$Patch; options = {}; } @@ -6346,7 +12600,7 @@ export namespace oracledatabase_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -6357,17 +12611,17 @@ export namespace oracledatabase_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists Exadata Infrastructures in a given project and location. + * Removes virtual machines from an existing exadb vm cluster. * @example * ```js * // Before running the sample: @@ -6397,25 +12651,30 @@ export namespace oracledatabase_v1 { * * // Do the magic * const res = - * await oracledatabase.projects.locations.cloudExadataInfrastructures.list({ - * // Optional. An expression for filtering the results of the request. - * filter: 'placeholder-value', - * // Optional. An expression for ordering the results of the request. - * orderBy: 'placeholder-value', - * // Optional. The maximum number of items to return. If unspecified, at most 50 Exadata infrastructures will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // Optional. A token identifying a page of results the server should return. - * pageToken: 'placeholder-value', - * // Required. The parent value for CloudExadataInfrastructure in the following format: projects/{project\}/locations/{location\}. - * parent: 'projects/my-project/locations/my-location', - * }); + * await oracledatabase.projects.locations.exadbVmClusters.removeVirtualMachine( + * { + * // Required. The name of the ExadbVmCluster in the following format: projects/{project\}/locations/{location\}/exadbVmClusters/{exadb_vm_cluster\}. + * name: 'projects/my-project/locations/my-location/exadbVmClusters/my-exadbVmCluster', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "hostnames": [], + * // "requestId": "my_requestId" + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "cloudExadataInfrastructures": [], - * // "nextPageToken": "my_nextPageToken", - * // "unreachable": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -6431,62 +12690,56 @@ export namespace oracledatabase_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$Cloudexadatainfrastructures$List, + removeVirtualMachine( + params: Params$Resource$Projects$Locations$Exadbvmclusters$Removevirtualmachine, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List, + removeVirtualMachine( + params?: Params$Resource$Projects$Locations$Exadbvmclusters$Removevirtualmachine, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List, + ): Promise>; + removeVirtualMachine( + params: Params$Resource$Projects$Locations$Exadbvmclusters$Removevirtualmachine, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + removeVirtualMachine( + params: Params$Resource$Projects$Locations$Exadbvmclusters$Removevirtualmachine, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List, - callback: BodyResponseCallback + removeVirtualMachine( + params: Params$Resource$Projects$Locations$Exadbvmclusters$Removevirtualmachine, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + removeVirtualMachine( + callback: BodyResponseCallback ): void; - list( + removeVirtualMachine( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Exadbvmclusters$Removevirtualmachine + | 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$Cloudexadatainfrastructures$List; + {}) as Params$Resource$Projects$Locations$Exadbvmclusters$Removevirtualmachine; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List; + {} as Params$Resource$Projects$Locations$Exadbvmclusters$Removevirtualmachine; options = {}; } @@ -6500,58 +12753,53 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+parent}/cloudExadataInfrastructures' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:removeVirtualMachine').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$Cloudexadatainfrastructures$Create extends StandardParameters { + export interface Params$Resource$Projects$Locations$Exadbvmclusters$Create extends StandardParameters { /** - * Required. The ID of the Exadata Infrastructure to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + * Required. The ID of the ExadbVmCluster to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. */ - cloudExadataInfrastructureId?: string; + exadbVmClusterId?: string; /** - * Required. The parent value for CloudExadataInfrastructure in the following format: projects/{project\}/locations/{location\}. + * Required. The value for parent of the ExadbVmCluster in the following format: projects/{project\}/locations/{location\}. */ parent?: string; /** - * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** * Request body metadata */ - requestBody?: Schema$CloudExadataInfrastructure; + requestBody?: Schema$ExadbVmCluster; } - export interface Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete extends StandardParameters { - /** - * Optional. If set to true, all VM clusters for this Exadata Infrastructure will be deleted. An Exadata Infrastructure can only be deleted once all its VM clusters have been deleted. - */ - force?: boolean; + export interface Params$Resource$Projects$Locations$Exadbvmclusters$Delete extends StandardParameters { /** - * Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project\}/locations/{location\}/cloudExadataInfrastructures/{cloud_exadata_infrastructure\}. + * Required. The name of the ExadbVmCluster in the following format: projects/{project\}/locations/{location\}/exadbVmClusters/{exadb_vm_cluster\}. */ name?: string; /** @@ -6559,13 +12807,13 @@ export namespace oracledatabase_v1 { */ requestId?: string; } - export interface Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Exadbvmclusters$Get extends StandardParameters { /** - * Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project\}/locations/{location\}/cloudExadataInfrastructures/{cloud_exadata_infrastructure\}. + * Required. The name of the ExadbVmCluster in the following format: projects/{project\}/locations/{location\}/exadbVmClusters/{exadb_vm_cluster\}. */ name?: string; } - export interface Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Exadbvmclusters$List extends StandardParameters { /** * Optional. An expression for filtering the results of the request. */ @@ -6575,7 +12823,7 @@ export namespace oracledatabase_v1 { */ orderBy?: string; /** - * Optional. The maximum number of items to return. If unspecified, at most 50 Exadata infrastructures will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. The maximum number of items to return. If unspecified, at most 50 ExadbVmClusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. */ pageSize?: number; /** @@ -6583,19 +12831,49 @@ export namespace oracledatabase_v1 { */ pageToken?: string; /** - * Required. The parent value for CloudExadataInfrastructure in the following format: projects/{project\}/locations/{location\}. + * Required. The parent value for ExadbVmClusters in the following format: projects/{project\}/locations/{location\}. */ parent?: string; } + export interface Params$Resource$Projects$Locations$Exadbvmclusters$Patch extends StandardParameters { + /** + * Identifier. The name of the ExadbVmCluster resource in the following format: projects/{project\}/locations/{region\}/exadbVmClusters/{exadb_vm_cluster\} + */ + name?: string; + /** + * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. A mask specifying which fields in th VM Cluster should be updated. A field specified in the mask is overwritten. If a mask isn't provided then all the fields in the VM Cluster are overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ExadbVmCluster; + } + export interface Params$Resource$Projects$Locations$Exadbvmclusters$Removevirtualmachine extends StandardParameters { + /** + * Required. The name of the ExadbVmCluster in the following format: projects/{project\}/locations/{location\}/exadbVmClusters/{exadb_vm_cluster\}. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RemoveVirtualMachineExadbVmClusterRequest; + } - export class Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers { + export class Resource$Projects$Locations$Exadbvmclusters$Dbnodes { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Lists the database servers of an Exadata Infrastructure instance. + * Lists the database nodes of a VM Cluster. * @example * ```js * // Before running the sample: @@ -6625,22 +12903,20 @@ export namespace oracledatabase_v1 { * * // Do the magic * const res = - * await oracledatabase.projects.locations.cloudExadataInfrastructures.dbServers.list( - * { - * // Optional. The maximum number of items to return. If unspecified, a maximum of 50 db servers will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. - * pageSize: 'placeholder-value', - * // Optional. A token identifying a page of results the server should return. - * pageToken: 'placeholder-value', - * // Required. The parent value for database server in the following format: projects/{project\}/locations/{location\}/cloudExadataInfrastructures/{cloudExadataInfrastructure\}. - * parent: - * 'projects/my-project/locations/my-location/cloudExadataInfrastructures/my-cloudExadataInfrastructure', - * }, - * ); + * await oracledatabase.projects.locations.exadbVmClusters.dbNodes.list({ + * // Optional. The maximum number of items to return. If unspecified, at most 50 db nodes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the node should return. + * pageToken: 'placeholder-value', + * // Required. The parent value for database node in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloudVmCluster\}. . + * parent: + * 'projects/my-project/locations/my-location/exadbVmClusters/my-exadbVmCluster', + * }); * console.log(res.data); * * // Example response * // { - * // "dbServers": [], + * // "dbNodes": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -6658,55 +12934,53 @@ export namespace oracledatabase_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List, + params: Params$Resource$Projects$Locations$Exadbvmclusters$Dbnodes$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List, + params?: Params$Resource$Projects$Locations$Exadbvmclusters$Dbnodes$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List, + params: Params$Resource$Projects$Locations$Exadbvmclusters$Dbnodes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Exadbvmclusters$Dbnodes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Exadbvmclusters$Dbnodes$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Exadbvmclusters$Dbnodes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List; + {}) as Params$Resource$Projects$Locations$Exadbvmclusters$Dbnodes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List; + {} as Params$Resource$Projects$Locations$Exadbvmclusters$Dbnodes$List; options = {}; } @@ -6720,7 +12994,7 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/dbServers').replace( + url: (rootUrl + '/v1/{+parent}/dbNodes').replace( /([^:]\/)\/+/g, '$1' ), @@ -6735,43 +13009,39 @@ export namespace oracledatabase_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$Cloudexadatainfrastructures$Dbservers$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Exadbvmclusters$Dbnodes$List extends StandardParameters { /** - * Optional. The maximum number of items to return. If unspecified, a maximum of 50 db servers will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. + * Optional. The maximum number of items to return. If unspecified, at most 50 db nodes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. */ pageSize?: number; /** - * Optional. A token identifying a page of results the server should return. + * Optional. A token identifying a page of results the node should return. */ pageToken?: string; /** - * Required. The parent value for database server in the following format: projects/{project\}/locations/{location\}/cloudExadataInfrastructures/{cloudExadataInfrastructure\}. + * Required. The parent value for database node in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloudVmCluster\}. . */ parent?: string; } - export class Resource$Projects$Locations$Cloudvmclusters { + export class Resource$Projects$Locations$Exascaledbstoragevaults { context: APIRequestContext; - dbNodes: Resource$Projects$Locations$Cloudvmclusters$Dbnodes; constructor(context: APIRequestContext) { this.context = context; - this.dbNodes = new Resource$Projects$Locations$Cloudvmclusters$Dbnodes( - this.context - ); } /** - * Creates a new VM Cluster in a given project and location. + * Creates a new ExascaleDB Storage Vault resource. * @example * ```js * // Before running the sample: @@ -6800,35 +13070,29 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.cloudVmClusters.create({ - * // Required. The ID of the VM Cluster to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. - * cloudVmClusterId: 'placeholder-value', - * // Required. The name of the parent in the following format: projects/{project\}/locations/{location\}. - * parent: 'projects/my-project/locations/my-location', - * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * const res = + * await oracledatabase.projects.locations.exascaleDbStorageVaults.create({ + * // Required. The ID of the ExascaleDbStorageVault to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + * exascaleDbStorageVaultId: 'placeholder-value', + * // Required. The value for parent of the ExascaleDbStorageVault in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "backupOdbSubnet": "my_backupOdbSubnet", - * // "backupSubnetCidr": "my_backupSubnetCidr", - * // "cidr": "my_cidr", - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "exadataInfrastructure": "my_exadataInfrastructure", - * // "gcpOracleZone": "my_gcpOracleZone", - * // "identityConnector": {}, - * // "labels": {}, - * // "name": "my_name", - * // "network": "my_network", - * // "odbNetwork": "my_odbNetwork", - * // "odbSubnet": "my_odbSubnet", - * // "properties": {} - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "entitlementId": "my_entitlementId", + * // "gcpOracleZone": "my_gcpOracleZone", + * // "labels": {}, + * // "name": "my_name", + * // "properties": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -6854,31 +13118,31 @@ export namespace oracledatabase_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Cloudvmclusters$Create, + params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Cloudvmclusters$Create, + params?: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Create, options?: MethodOptions ): Promise>; create( - params: Params$Resource$Projects$Locations$Cloudvmclusters$Create, + params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Cloudvmclusters$Create, + params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Cloudvmclusters$Create, + params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Create, callback: BodyResponseCallback ): void; create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cloudvmclusters$Create + | Params$Resource$Projects$Locations$Exascaledbstoragevaults$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -6894,13 +13158,13 @@ export namespace oracledatabase_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cloudvmclusters$Create; + {}) as Params$Resource$Projects$Locations$Exascaledbstoragevaults$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Cloudvmclusters$Create; + {} as Params$Resource$Projects$Locations$Exascaledbstoragevaults$Create; options = {}; } @@ -6914,7 +13178,7 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/cloudVmClusters').replace( + url: (rootUrl + '/v1/{+parent}/exascaleDbStorageVaults').replace( /([^:]\/)\/+/g, '$1' ), @@ -6939,7 +13203,7 @@ export namespace oracledatabase_v1 { } /** - * Deletes a single VM Cluster. + * Deletes a single ExascaleDB Storage Vault. * @example * ```js * // Before running the sample: @@ -6968,14 +13232,13 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.cloudVmClusters.delete({ - * // Optional. If set to true, all child resources for the VM Cluster will be deleted. A VM Cluster can only be deleted once all its child resources have been deleted. - * force: 'placeholder-value', - * // Required. The name of the Cloud VM Cluster in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloud_vm_cluster\}. - * name: 'projects/my-project/locations/my-location/cloudVmClusters/my-cloudVmCluster', - * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * }); + * const res = + * await oracledatabase.projects.locations.exascaleDbStorageVaults.delete({ + * // Required. The name of the ExascaleDbStorageVault in the following format: projects/{project\}/locations/{location\}/exascaleDbStorageVaults/{exascale_db_storage_vault\}. + * name: 'projects/my-project/locations/my-location/exascaleDbStorageVaults/my-exascaleDbStorageVault', + * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -7001,31 +13264,31 @@ export namespace oracledatabase_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Cloudvmclusters$Delete, + params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Cloudvmclusters$Delete, + params?: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Cloudvmclusters$Delete, + params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Cloudvmclusters$Delete, + params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Cloudvmclusters$Delete, + params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cloudvmclusters$Delete + | Params$Resource$Projects$Locations$Exascaledbstoragevaults$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -7041,13 +13304,13 @@ export namespace oracledatabase_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cloudvmclusters$Delete; + {}) as Params$Resource$Projects$Locations$Exascaledbstoragevaults$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Cloudvmclusters$Delete; + {} as Params$Resource$Projects$Locations$Exascaledbstoragevaults$Delete; options = {}; } @@ -7083,7 +13346,7 @@ export namespace oracledatabase_v1 { } /** - * Gets details of a single VM Cluster. + * Gets details of a single ExascaleDB Storage Vault. * @example * ```js * // Before running the sample: @@ -7112,27 +13375,21 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.cloudVmClusters.get({ - * // Required. The name of the Cloud VM Cluster in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloud_vm_cluster\}. - * name: 'projects/my-project/locations/my-location/cloudVmClusters/my-cloudVmCluster', - * }); + * const res = + * await oracledatabase.projects.locations.exascaleDbStorageVaults.get({ + * // Required. The name of the ExascaleDbStorageVault in the following format: projects/{project\}/locations/{location\}/exascaleDbStorageVaults/{exascale_db_storage_vault\}. + * name: 'projects/my-project/locations/my-location/exascaleDbStorageVaults/my-exascaleDbStorageVault', + * }); * console.log(res.data); * * // Example response * // { - * // "backupOdbSubnet": "my_backupOdbSubnet", - * // "backupSubnetCidr": "my_backupSubnetCidr", - * // "cidr": "my_cidr", * // "createTime": "my_createTime", * // "displayName": "my_displayName", - * // "exadataInfrastructure": "my_exadataInfrastructure", + * // "entitlementId": "my_entitlementId", * // "gcpOracleZone": "my_gcpOracleZone", - * // "identityConnector": {}, * // "labels": {}, * // "name": "my_name", - * // "network": "my_network", - * // "odbNetwork": "my_odbNetwork", - * // "odbSubnet": "my_odbSubnet", * // "properties": {} * // } * } @@ -7150,52 +13407,55 @@ export namespace oracledatabase_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Cloudvmclusters$Get, + params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Cloudvmclusters$Get, + params?: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Cloudvmclusters$Get, + params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Cloudvmclusters$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Cloudvmclusters$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cloudvmclusters$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Exascaledbstoragevaults$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$Cloudvmclusters$Get; + {}) as Params$Resource$Projects$Locations$Exascaledbstoragevaults$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Cloudvmclusters$Get; + params = + {} as Params$Resource$Projects$Locations$Exascaledbstoragevaults$Get; options = {}; } @@ -7221,17 +13481,17 @@ export namespace oracledatabase_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists the VM Clusters in a given project and location. + * Lists all the ExascaleDB Storage Vaults for the given project and location. * @example * ```js * // Before running the sample: @@ -7260,21 +13520,24 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.cloudVmClusters.list({ - * // Optional. An expression for filtering the results of the request. - * filter: 'placeholder-value', - * // Optional. The number of VM clusters to return. If unspecified, at most 50 VM clusters will be returned. The maximum value is 1,000. - * pageSize: 'placeholder-value', - * // Optional. A token identifying the page of results the server returns. - * pageToken: 'placeholder-value', - * // Required. The name of the parent in the following format: projects/{project\}/locations/{location\}. - * parent: 'projects/my-project/locations/my-location', - * }); + * const res = + * await oracledatabase.projects.locations.exascaleDbStorageVaults.list({ + * // Optional. An expression for filtering the results of the request. Filter the list as specified in https://google.aip.dev/160. + * filter: 'placeholder-value', + * // Optional. An expression for ordering the results of the request. Order results as specified in https://google.aip.dev/132. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of items to return. If unspecified, at most 50 ExascaleDbStorageVaults will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. The parent value for ExascaleDbStorageVault in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "cloudVmClusters": [], + * // "exascaleDbStorageVaults": [], * // "nextPageToken": "my_nextPageToken", * // "unreachable": [] * // } @@ -7293,56 +13556,61 @@ export namespace oracledatabase_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Cloudvmclusters$List, + params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Cloudvmclusters$List, + params?: Params$Resource$Projects$Locations$Exascaledbstoragevaults$List, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; list( - params: Params$Resource$Projects$Locations$Cloudvmclusters$List, + params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Cloudvmclusters$List, + params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Cloudvmclusters$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cloudvmclusters$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Exascaledbstoragevaults$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$Cloudvmclusters$List; + {}) as Params$Resource$Projects$Locations$Exascaledbstoragevaults$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Cloudvmclusters$List; + params = + {} as Params$Resource$Projects$Locations$Exascaledbstoragevaults$List; options = {}; } @@ -7356,7 +13624,7 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/cloudVmClusters').replace( + url: (rootUrl + '/v1/{+parent}/exascaleDbStorageVaults').replace( /([^:]\/)\/+/g, '$1' ), @@ -7371,42 +13639,40 @@ export namespace oracledatabase_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$Cloudvmclusters$Create extends StandardParameters { + export interface Params$Resource$Projects$Locations$Exascaledbstoragevaults$Create extends StandardParameters { /** - * Required. The ID of the VM Cluster to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + * Required. The ID of the ExascaleDbStorageVault to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. */ - cloudVmClusterId?: string; + exascaleDbStorageVaultId?: string; /** - * Required. The name of the parent in the following format: projects/{project\}/locations/{location\}. + * Required. The value for parent of the ExascaleDbStorageVault in the following format: projects/{project\}/locations/{location\}. */ parent?: string; /** - * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** * Request body metadata */ - requestBody?: Schema$CloudVmCluster; + requestBody?: Schema$ExascaleDbStorageVault; } - export interface Params$Resource$Projects$Locations$Cloudvmclusters$Delete extends StandardParameters { - /** - * Optional. If set to true, all child resources for the VM Cluster will be deleted. A VM Cluster can only be deleted once all its child resources have been deleted. - */ - force?: boolean; + export interface Params$Resource$Projects$Locations$Exascaledbstoragevaults$Delete extends StandardParameters { /** - * Required. The name of the Cloud VM Cluster in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloud_vm_cluster\}. + * Required. The name of the ExascaleDbStorageVault in the following format: projects/{project\}/locations/{location\}/exascaleDbStorageVaults/{exascale_db_storage_vault\}. */ name?: string; /** @@ -7414,39 +13680,46 @@ export namespace oracledatabase_v1 { */ requestId?: string; } - export interface Params$Resource$Projects$Locations$Cloudvmclusters$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Exascaledbstoragevaults$Get extends StandardParameters { /** - * Required. The name of the Cloud VM Cluster in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloud_vm_cluster\}. + * Required. The name of the ExascaleDbStorageVault in the following format: projects/{project\}/locations/{location\}/exascaleDbStorageVaults/{exascale_db_storage_vault\}. */ name?: string; } - export interface Params$Resource$Projects$Locations$Cloudvmclusters$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Exascaledbstoragevaults$List extends StandardParameters { /** - * Optional. An expression for filtering the results of the request. + * Optional. An expression for filtering the results of the request. Filter the list as specified in https://google.aip.dev/160. */ filter?: string; /** - * Optional. The number of VM clusters to return. If unspecified, at most 50 VM clusters will be returned. The maximum value is 1,000. + * Optional. An expression for ordering the results of the request. Order results as specified in https://google.aip.dev/132. + */ + orderBy?: string; + /** + * Optional. The maximum number of items to return. If unspecified, at most 50 ExascaleDbStorageVaults will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. */ pageSize?: number; /** - * Optional. A token identifying the page of results the server returns. + * Optional. A token identifying a page of results the server should return. */ pageToken?: string; /** - * Required. The name of the parent in the following format: projects/{project\}/locations/{location\}. + * Required. The parent value for ExascaleDbStorageVault in the following format: projects/{project\}/locations/{location\}. */ parent?: string; } - export class Resource$Projects$Locations$Cloudvmclusters$Dbnodes { + export class Resource$Projects$Locations$Giversions { context: APIRequestContext; + minorVersions: Resource$Projects$Locations$Giversions$Minorversions; constructor(context: APIRequestContext) { this.context = context; + this.minorVersions = + new Resource$Projects$Locations$Giversions$Minorversions(this.context); } /** - * Lists the database nodes of a VM Cluster. + * Lists all the valid Oracle Grid Infrastructure (GI) versions for the given project and location. * @example * ```js * // Before running the sample: @@ -7475,21 +13748,21 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await oracledatabase.projects.locations.cloudVmClusters.dbNodes.list({ - * // Optional. The maximum number of items to return. If unspecified, at most 50 db nodes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // Optional. A token identifying a page of results the node should return. - * pageToken: 'placeholder-value', - * // Required. The parent value for database node in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloudVmCluster\}. . - * parent: - * 'projects/my-project/locations/my-location/cloudVmClusters/my-cloudVmCluster', - * }); + * const res = await oracledatabase.projects.locations.giVersions.list({ + * // Optional. An expression for filtering the results of the request. Only the shape, gcp_oracle_zone and gi_version fields are supported in this format: `shape="{shape\}"`. + * filter: 'placeholder-value', + * // Optional. The maximum number of items to return. If unspecified, a maximum of 50 Oracle Grid Infrastructure (GI) versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. The parent value for Grid Infrastructure Version in the following format: Format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "dbNodes": [], + * // "giVersions": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -7507,53 +13780,54 @@ export namespace oracledatabase_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List, + params: Params$Resource$Projects$Locations$Giversions$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List, + params?: Params$Resource$Projects$Locations$Giversions$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List, + params: Params$Resource$Projects$Locations$Giversions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Giversions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Giversions$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Giversions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List; + {}) as Params$Resource$Projects$Locations$Giversions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List; + params = {} as Params$Resource$Projects$Locations$Giversions$List; options = {}; } @@ -7567,7 +13841,7 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/dbNodes').replace( + url: (rootUrl + '/v1/{+parent}/giVersions').replace( /([^:]\/)\/+/g, '$1' ), @@ -7582,39 +13856,43 @@ export namespace oracledatabase_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$Cloudvmclusters$Dbnodes$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Giversions$List extends StandardParameters { /** - * Optional. The maximum number of items to return. If unspecified, at most 50 db nodes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. An expression for filtering the results of the request. Only the shape, gcp_oracle_zone and gi_version fields are supported in this format: `shape="{shape\}"`. + */ + filter?: string; + /** + * Optional. The maximum number of items to return. If unspecified, a maximum of 50 Oracle Grid Infrastructure (GI) versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. */ pageSize?: number; /** - * Optional. A token identifying a page of results the node should return. + * Optional. A token identifying a page of results the server should return. */ pageToken?: string; /** - * Required. The parent value for database node in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloudVmCluster\}. . + * Required. The parent value for Grid Infrastructure Version in the following format: Format: projects/{project\}/locations/{location\}. */ parent?: string; } - export class Resource$Projects$Locations$Databasecharactersets { + export class Resource$Projects$Locations$Giversions$Minorversions { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * List DatabaseCharacterSets for the given project and location. + * Lists all the valid minor versions for the given project, location, gi version and shape family. * @example * ```js * // Before running the sample: @@ -7644,21 +13922,22 @@ export namespace oracledatabase_v1 { * * // Do the magic * const res = - * await oracledatabase.projects.locations.databaseCharacterSets.list({ - * // Optional. An expression for filtering the results of the request. Only the **character_set_type** field is supported in the following format: `character_set_type="{characterSetType\}"`. Accepted values include `DATABASE` and `NATIONAL`. + * await oracledatabase.projects.locations.giVersions.minorVersions.list({ + * // Optional. An expression for filtering the results of the request. Only shapeFamily and gcp_oracle_zone_id are supported in this format: `shape_family="{shapeFamily\}" AND gcp_oracle_zone_id="{gcp_oracle_zone_id\}"`. * filter: 'placeholder-value', - * // Optional. The maximum number of DatabaseCharacterSets to return. The service may return fewer than this value. If unspecified, at most 50 DatabaseCharacterSets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * // Optional. The maximum number of items to return. If unspecified, a maximum of 50 System Versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. * pageSize: 'placeholder-value', - * // Optional. A page token, received from a previous `ListDatabaseCharacterSets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDatabaseCharacterSets` must match the call that provided the page token. + * // Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token. * pageToken: 'placeholder-value', - * // Required. The parent value for DatabaseCharacterSets in the following format: projects/{project\}/locations/{location\}. - * parent: 'projects/my-project/locations/my-location', + * // Required. The parent value for the MinorVersion resource with the format: projects/{project\}/locations/{location\}/giVersions/{gi_version\} + * parent: + * 'projects/my-project/locations/my-location/giVersions/my-giVersion', * }); * console.log(res.data); * * // Example response * // { - * // "databaseCharacterSets": [], + * // "minorVersions": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -7676,61 +13955,57 @@ export namespace oracledatabase_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Databasecharactersets$List, + params: Params$Resource$Projects$Locations$Giversions$Minorversions$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Databasecharactersets$List, + params?: Params$Resource$Projects$Locations$Giversions$Minorversions$List, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; list( - params: Params$Resource$Projects$Locations$Databasecharactersets$List, + params: Params$Resource$Projects$Locations$Giversions$Minorversions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Databasecharactersets$List, + params: Params$Resource$Projects$Locations$Giversions$Minorversions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Databasecharactersets$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Giversions$Minorversions$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Databasecharactersets$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Giversions$Minorversions$List + | 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$Databasecharactersets$List; + {}) as Params$Resource$Projects$Locations$Giversions$Minorversions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Databasecharactersets$List; + {} as Params$Resource$Projects$Locations$Giversions$Minorversions$List; options = {}; } @@ -7744,7 +14019,7 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/databaseCharacterSets').replace( + url: (rootUrl + '/v1/{+parent}/minorVersions').replace( /([^:]\/)\/+/g, '$1' ), @@ -7759,45 +14034,43 @@ export namespace oracledatabase_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$Databasecharactersets$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Giversions$Minorversions$List extends StandardParameters { /** - * Optional. An expression for filtering the results of the request. Only the **character_set_type** field is supported in the following format: `character_set_type="{characterSetType\}"`. Accepted values include `DATABASE` and `NATIONAL`. + * Optional. An expression for filtering the results of the request. Only shapeFamily and gcp_oracle_zone_id are supported in this format: `shape_family="{shapeFamily\}" AND gcp_oracle_zone_id="{gcp_oracle_zone_id\}"`. */ filter?: string; /** - * Optional. The maximum number of DatabaseCharacterSets to return. The service may return fewer than this value. If unspecified, at most 50 DatabaseCharacterSets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. The maximum number of items to return. If unspecified, a maximum of 50 System Versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. */ pageSize?: number; /** - * Optional. A page token, received from a previous `ListDatabaseCharacterSets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDatabaseCharacterSets` must match the call that provided the page token. + * Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token. */ pageToken?: string; /** - * Required. The parent value for DatabaseCharacterSets in the following format: projects/{project\}/locations/{location\}. + * Required. The parent value for the MinorVersion resource with the format: projects/{project\}/locations/{location\}/giVersions/{gi_version\} */ parent?: string; } - export class Resource$Projects$Locations$Databases { + export class Resource$Projects$Locations$Goldengateconnectionassignments { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Gets details of a single Database. + * Creates a new GoldengateConnectionAssignment in a given project and location. * @example * ```js * // Before running the sample: @@ -7826,32 +14099,39 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.databases.get({ - * // Required. The name of the Database resource in the following format: projects/{project\}/locations/{region\}/databases/{database\} - * name: 'projects/my-project/locations/my-location/databases/my-database', - * }); + * const res = + * await oracledatabase.projects.locations.goldengateConnectionAssignments.create( + * { + * // Required. The ID of the GoldengateConnectionAssignment to create. + * goldengateConnectionAssignmentId: 'placeholder-value', + * // Required. The parent resource where this GoldengateConnectionAssignment will be created. Format: projects/{project\}/locations/{location\} + * parent: 'projects/my-project/locations/my-location', + * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "entitlementId": "my_entitlementId", + * // "labels": {}, + * // "name": "my_name", + * // "properties": {} + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "adminPassword": "my_adminPassword", - * // "adminPasswordSecretVersion": "my_adminPasswordSecretVersion", - * // "characterSet": "my_characterSet", - * // "createTime": "my_createTime", - * // "databaseId": "my_databaseId", - * // "dbHomeName": "my_dbHomeName", - * // "dbName": "my_dbName", - * // "dbUniqueName": "my_dbUniqueName", - * // "gcpOracleZone": "my_gcpOracleZone", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "ncharacterSet": "my_ncharacterSet", - * // "ociUrl": "my_ociUrl", - * // "opsInsightsStatus": "my_opsInsightsStatus", - * // "pluggableDatabaseId": "my_pluggableDatabaseId", - * // "pluggableDatabaseName": "my_pluggableDatabaseName", - * // "properties": {}, - * // "tdeWalletPassword": "my_tdeWalletPassword", - * // "tdeWalletPasswordSecretVersion": "my_tdeWalletPasswordSecretVersion" + * // "response": {} * // } * } * @@ -7867,53 +14147,54 @@ export namespace oracledatabase_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$Databases$Get, + create( + params: Params$Resource$Projects$Locations$Goldengateconnectionassignments$Create, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Databases$Get, + create( + params?: Params$Resource$Projects$Locations$Goldengateconnectionassignments$Create, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Databases$Get, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Goldengateconnectionassignments$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Databases$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Goldengateconnectionassignments$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Databases$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Goldengateconnectionassignments$Create, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Databases$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Goldengateconnectionassignments$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$Databases$Get; + {}) as Params$Resource$Projects$Locations$Goldengateconnectionassignments$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Databases$Get; + params = + {} as Params$Resource$Projects$Locations$Goldengateconnectionassignments$Create; options = {}; } @@ -7927,29 +14208,31 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: ( + rootUrl + '/v1/{+parent}/goldengateConnectionAssignments' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists all the Databases for the given project, location and DbSystem. + * Deletes a single GoldengateConnectionAssignment. * @example * ```js * // Before running the sample: @@ -7978,22 +14261,24 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.databases.list({ - * // Optional. An expression for filtering the results of the request. list for container databases is supported only with a valid dbSystem (full resource name) filter in this format: `dbSystem="projects/{project\}/locations/{location\}/dbSystems/{dbSystemId\}"` - * filter: 'placeholder-value', - * // Optional. The maximum number of items to return. If unspecified, a maximum of 50 Databases will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. - * pageSize: 'placeholder-value', - * // Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token. - * pageToken: 'placeholder-value', - * // Required. The parent resource name in the following format: projects/{project\}/locations/{region\} - * parent: 'projects/my-project/locations/my-location', - * }); + * const res = + * await oracledatabase.projects.locations.goldengateConnectionAssignments.delete( + * { + * // Required. The name of the GoldengateConnectionAssignment to delete. Format: projects/{project\}/locations/{location\}/goldengateConnectionAssignments/{goldengate_connection_assignment\} + * name: 'projects/my-project/locations/my-location/goldengateConnectionAssignments/my-goldengateConnectionAssignment', + * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "databases": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -8009,55 +14294,54 @@ export namespace oracledatabase_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$Databases$List, + delete( + params: Params$Resource$Projects$Locations$Goldengateconnectionassignments$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Databases$List, + delete( + params?: Params$Resource$Projects$Locations$Goldengateconnectionassignments$Delete, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Databases$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Goldengateconnectionassignments$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Databases$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Goldengateconnectionassignments$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Databases$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Goldengateconnectionassignments$Delete, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Databases$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Goldengateconnectionassignments$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$Databases$List; + {}) as Params$Resource$Projects$Locations$Goldengateconnectionassignments$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Databases$List; + params = + {} as Params$Resource$Projects$Locations$Goldengateconnectionassignments$Delete; options = {}; } @@ -8071,64 +14355,29 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/databases').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); } } - } - - export interface Params$Resource$Projects$Locations$Databases$Get extends StandardParameters { - /** - * Required. The name of the Database resource in the following format: projects/{project\}/locations/{region\}/databases/{database\} - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Databases$List extends StandardParameters { - /** - * Optional. An expression for filtering the results of the request. list for container databases is supported only with a valid dbSystem (full resource name) filter in this format: `dbSystem="projects/{project\}/locations/{location\}/dbSystems/{dbSystemId\}"` - */ - filter?: string; - /** - * Optional. The maximum number of items to return. If unspecified, a maximum of 50 Databases will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. - */ - pageSize?: number; - /** - * Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token. - */ - pageToken?: string; - /** - * Required. The parent resource name in the following format: projects/{project\}/locations/{region\} - */ - parent?: string; - } - - export class Resource$Projects$Locations$Dbsysteminitialstoragesizes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Lists all the DbSystemInitialStorageSizes for the given project and location. + * Gets details of a single GoldengateConnectionAssignment. * @example * ```js * // Before running the sample: @@ -8158,20 +14407,22 @@ export namespace oracledatabase_v1 { * * // Do the magic * const res = - * await oracledatabase.projects.locations.dbSystemInitialStorageSizes.list({ - * // Optional. The maximum number of items to return. If unspecified, a maximum of 50 DbSystemInitialStorageSizes will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. - * pageSize: 'placeholder-value', - * // Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token. - * pageToken: 'placeholder-value', - * // Required. The parent value for the DbSystemInitialStorageSize resource with the format: projects/{project\}/locations/{location\} - * parent: 'projects/my-project/locations/my-location', - * }); + * await oracledatabase.projects.locations.goldengateConnectionAssignments.get( + * { + * // Required. The name of the GoldengateConnectionAssignment to retrieve. Format: projects/{project\}/locations/{location\}/goldengateConnectionAssignments/{goldengate_connection_assignment\} + * name: 'projects/my-project/locations/my-location/goldengateConnectionAssignments/my-goldengateConnectionAssignment', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "dbSystemInitialStorageSizes": [], - * // "nextPageToken": "my_nextPageToken" + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "entitlementId": "my_entitlementId", + * // "labels": {}, + * // "name": "my_name", + * // "properties": {} * // } * } * @@ -8187,62 +14438,58 @@ export namespace oracledatabase_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$Dbsysteminitialstoragesizes$List, + get( + params: Params$Resource$Projects$Locations$Goldengateconnectionassignments$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Dbsysteminitialstoragesizes$List, + get( + params?: Params$Resource$Projects$Locations$Goldengateconnectionassignments$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Dbsysteminitialstoragesizes$List, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Goldengateconnectionassignments$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Dbsysteminitialstoragesizes$List, + get( + params: Params$Resource$Projects$Locations$Goldengateconnectionassignments$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Dbsysteminitialstoragesizes$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Goldengateconnectionassignments$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Dbsysteminitialstoragesizes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Goldengateconnectionassignments$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$Dbsysteminitialstoragesizes$List; + {}) as Params$Resource$Projects$Locations$Goldengateconnectionassignments$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Dbsysteminitialstoragesizes$List; + {} as Params$Resource$Projects$Locations$Goldengateconnectionassignments$Get; options = {}; } @@ -8256,55 +14503,31 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+parent}/dbSystemInitialStorageSizes' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Dbsysteminitialstoragesizes$List extends StandardParameters { - /** - * Optional. The maximum number of items to return. If unspecified, a maximum of 50 DbSystemInitialStorageSizes will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. - */ - pageSize?: number; - /** - * Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token. - */ - pageToken?: string; - /** - * Required. The parent value for the DbSystemInitialStorageSize resource with the format: projects/{project\}/locations/{location\} - */ - parent?: string; - } - - export class Resource$Projects$Locations$Dbsystems { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates a new DbSystem in a given project and location. + * Lists GoldengateConnectionAssignments in a given project and location. * @example * ```js * // Before running the sample: @@ -8333,40 +14556,28 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.dbSystems.create({ - * // Required. The ID of the DbSystem to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. - * dbSystemId: 'placeholder-value', - * // Required. The value for parent of the DbSystem in the following format: projects/{project\}/locations/{location\}. - * parent: 'projects/my-project/locations/my-location', - * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "entitlementId": "my_entitlementId", - * // "gcpOracleZone": "my_gcpOracleZone", - * // "labels": {}, - * // "name": "my_name", - * // "ociUrl": "my_ociUrl", - * // "odbNetwork": "my_odbNetwork", - * // "odbSubnet": "my_odbSubnet", - * // "properties": {} - * // } - * }, - * }); + * const res = + * await oracledatabase.projects.locations.goldengateConnectionAssignments.list( + * { + * // Optional. A filter expression that filters GoldengateConnectionAssignments listed in the response. + * filter: 'placeholder-value', + * // Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "DESC" after a field name for descending. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of GoldengateConnectionAssignments to return. The service may return fewer than this value. If unspecified, at most 50 GoldengateConnectionAssignments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous `ListGoldengateConnectionAssignments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGoldengateConnectionAssignments` must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The parent value for the GoldengateConnectionAssignments. Format: projects/{project\}/locations/{location\} + * parent: 'projects/my-project/locations/my-location', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "goldengateConnectionAssignments": [], + * // "nextPageToken": "my_nextPageToken", + * // "unreachable": [] * // } * } * @@ -8382,53 +14593,62 @@ export namespace oracledatabase_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$Dbsystems$Create, + list( + params: Params$Resource$Projects$Locations$Goldengateconnectionassignments$List, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Dbsystems$Create, + list( + params?: Params$Resource$Projects$Locations$Goldengateconnectionassignments$List, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Dbsystems$Create, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Goldengateconnectionassignments$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Dbsystems$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Goldengateconnectionassignments$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Dbsystems$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Goldengateconnectionassignments$List, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Dbsystems$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Goldengateconnectionassignments$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$Dbsystems$Create; + {}) as Params$Resource$Projects$Locations$Goldengateconnectionassignments$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Dbsystems$Create; + params = + {} as Params$Resource$Projects$Locations$Goldengateconnectionassignments$List; options = {}; } @@ -8442,11 +14662,10 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/dbSystems').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: ( + rootUrl + '/v1/{+parent}/goldengateConnectionAssignments' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -8457,17 +14676,19 @@ export namespace oracledatabase_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a single DbSystem. + * Tests a single GoldengateConnectionAssignment. * @example * ```js * // Before running the sample: @@ -8496,21 +14717,28 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.dbSystems.delete({ - * // Required. The name of the DbSystem in the following format: projects/{project\}/locations/{location\}/dbSystems/{db_system\}. - * name: 'projects/my-project/locations/my-location/dbSystems/my-dbSystem', - * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * }); + * const res = + * await oracledatabase.projects.locations.goldengateConnectionAssignments.test( + * { + * // Required. Name of the connection assignment for which to test connection. projects/{project\}/locations/{region\}/goldengateConnectionAssignments/{goldengate_connection_assignment\} + * name: 'projects/my-project/locations/my-location/goldengateConnectionAssignments/my-goldengateConnectionAssignment', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "type": "my_type" + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "done": false, * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "errors": [], + * // "resultType": "my_resultType" * // } * } * @@ -8526,53 +14754,62 @@ export namespace oracledatabase_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$Dbsystems$Delete, + test( + params: Params$Resource$Projects$Locations$Goldengateconnectionassignments$Test, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Dbsystems$Delete, + test( + params?: Params$Resource$Projects$Locations$Goldengateconnectionassignments$Test, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Dbsystems$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + test( + params: Params$Resource$Projects$Locations$Goldengateconnectionassignments$Test, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Dbsystems$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + test( + params: Params$Resource$Projects$Locations$Goldengateconnectionassignments$Test, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Dbsystems$Delete, - callback: BodyResponseCallback + test( + params: Params$Resource$Projects$Locations$Goldengateconnectionassignments$Test, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + test( + callback: BodyResponseCallback + ): void; + test( paramsOrCallback?: - | Params$Resource$Projects$Locations$Dbsystems$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Goldengateconnectionassignments$Test + | 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$Dbsystems$Delete; + {}) as Params$Resource$Projects$Locations$Goldengateconnectionassignments$Test; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Dbsystems$Delete; + params = + {} as Params$Resource$Projects$Locations$Goldengateconnectionassignments$Test; options = {}; } @@ -8586,8 +14823,8 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:test').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -8598,17 +14835,95 @@ export namespace oracledatabase_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$Goldengateconnectionassignments$Create extends StandardParameters { /** - * Gets details of a single DbSystem. + * Required. The ID of the GoldengateConnectionAssignment to create. + */ + goldengateConnectionAssignmentId?: string; + /** + * Required. The parent resource where this GoldengateConnectionAssignment will be created. Format: projects/{project\}/locations/{location\} + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoldengateConnectionAssignment; + } + export interface Params$Resource$Projects$Locations$Goldengateconnectionassignments$Delete extends StandardParameters { + /** + * Required. The name of the GoldengateConnectionAssignment to delete. Format: projects/{project\}/locations/{location\}/goldengateConnectionAssignments/{goldengate_connection_assignment\} + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Goldengateconnectionassignments$Get extends StandardParameters { + /** + * Required. The name of the GoldengateConnectionAssignment to retrieve. Format: projects/{project\}/locations/{location\}/goldengateConnectionAssignments/{goldengate_connection_assignment\} + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Goldengateconnectionassignments$List extends StandardParameters { + /** + * Optional. A filter expression that filters GoldengateConnectionAssignments listed in the response. + */ + filter?: string; + /** + * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "DESC" after a field name for descending. + */ + orderBy?: string; + /** + * Optional. The maximum number of GoldengateConnectionAssignments to return. The service may return fewer than this value. If unspecified, at most 50 GoldengateConnectionAssignments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListGoldengateConnectionAssignments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGoldengateConnectionAssignments` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent value for the GoldengateConnectionAssignments. Format: projects/{project\}/locations/{location\} + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Goldengateconnectionassignments$Test extends StandardParameters { + /** + * Required. Name of the connection assignment for which to test connection. projects/{project\}/locations/{region\}/goldengateConnectionAssignments/{goldengate_connection_assignment\} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestGoldengateConnectionAssignmentRequest; + } + + export class Resource$Projects$Locations$Goldengateconnections { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new GoldengateConnection in a given project and location. * @example * ```js * // Before running the sample: @@ -8637,24 +14952,40 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.dbSystems.get({ - * // Required. The name of the DbSystem in the following format: projects/{project\}/locations/{location\}/dbSystems/{db_system\}. - * name: 'projects/my-project/locations/my-location/dbSystems/my-dbSystem', - * }); + * const res = + * await oracledatabase.projects.locations.goldengateConnections.create({ + * // Required. The ID of the GoldengateConnection to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + * goldengateConnectionId: 'placeholder-value', + * // Required. The value for parent of the GoldengateConnection in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "entitlementId": "my_entitlementId", + * // "gcpOracleZone": "my_gcpOracleZone", + * // "labels": {}, + * // "name": "my_name", + * // "ociUrl": "my_ociUrl", + * // "odbNetwork": "my_odbNetwork", + * // "odbSubnet": "my_odbSubnet", + * // "properties": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "entitlementId": "my_entitlementId", - * // "gcpOracleZone": "my_gcpOracleZone", - * // "labels": {}, + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "ociUrl": "my_ociUrl", - * // "odbNetwork": "my_odbNetwork", - * // "odbSubnet": "my_odbSubnet", - * // "properties": {} + * // "response": {} * // } * } * @@ -8670,53 +15001,54 @@ export namespace oracledatabase_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$Dbsystems$Get, + create( + params: Params$Resource$Projects$Locations$Goldengateconnections$Create, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Dbsystems$Get, + create( + params?: Params$Resource$Projects$Locations$Goldengateconnections$Create, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Dbsystems$Get, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Goldengateconnections$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Dbsystems$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Goldengateconnections$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Dbsystems$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Goldengateconnections$Create, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Dbsystems$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Goldengateconnections$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$Dbsystems$Get; + {}) as Params$Resource$Projects$Locations$Goldengateconnections$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Dbsystems$Get; + params = + {} as Params$Resource$Projects$Locations$Goldengateconnections$Create; options = {}; } @@ -8730,29 +15062,32 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/goldengateConnections').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists all the DbSystems for the given project and location. + * Deletes a single GoldengateConnection. * @example * ```js * // Before running the sample: @@ -8781,25 +15116,22 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.dbSystems.list({ - * // Optional. An expression for filtering the results of the request. - * filter: 'placeholder-value', - * // Optional. An expression for ordering the results of the request. - * orderBy: 'placeholder-value', - * // Optional. The maximum number of items to return. If unspecified, at most 50 DbSystems will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // Optional. A token identifying a page of results the server should return. - * pageToken: 'placeholder-value', - * // Required. The parent value for DbSystems in the following format: projects/{project\}/locations/{location\}. - * parent: 'projects/my-project/locations/my-location', - * }); + * const res = + * await oracledatabase.projects.locations.goldengateConnections.delete({ + * // Required. The name of the GoldengateConnection in the following format: projects/{project\}/locations/{location\}/goldengateConnections/{goldengate_connection\}. + * name: 'projects/my-project/locations/my-location/goldengateConnections/my-goldengateConnection', + * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "dbSystems": [], - * // "nextPageToken": "my_nextPageToken", - * // "unreachable": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -8815,55 +15147,54 @@ export namespace oracledatabase_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$Dbsystems$List, + delete( + params: Params$Resource$Projects$Locations$Goldengateconnections$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Dbsystems$List, + delete( + params?: Params$Resource$Projects$Locations$Goldengateconnections$Delete, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Dbsystems$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Goldengateconnections$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Dbsystems$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Goldengateconnections$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Dbsystems$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Goldengateconnections$Delete, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Dbsystems$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Goldengateconnections$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$Dbsystems$List; + {}) as Params$Resource$Projects$Locations$Goldengateconnections$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Dbsystems$List; + params = + {} as Params$Resource$Projects$Locations$Goldengateconnections$Delete; options = {}; } @@ -8877,97 +15208,29 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/dbSystems').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); } } - } - - export interface Params$Resource$Projects$Locations$Dbsystems$Create extends StandardParameters { - /** - * Required. The ID of the DbSystem to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. - */ - dbSystemId?: string; - /** - * Required. The value for parent of the DbSystem in the following format: projects/{project\}/locations/{location\}. - */ - parent?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$DbSystem; - } - export interface Params$Resource$Projects$Locations$Dbsystems$Delete extends StandardParameters { - /** - * Required. The name of the DbSystem in the following format: projects/{project\}/locations/{location\}/dbSystems/{db_system\}. - */ - name?: string; - /** - * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Projects$Locations$Dbsystems$Get extends StandardParameters { - /** - * Required. The name of the DbSystem in the following format: projects/{project\}/locations/{location\}/dbSystems/{db_system\}. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Dbsystems$List extends StandardParameters { - /** - * Optional. An expression for filtering the results of the request. - */ - filter?: string; - /** - * Optional. An expression for ordering the results of the request. - */ - orderBy?: string; - /** - * Optional. The maximum number of items to return. If unspecified, at most 50 DbSystems will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * Optional. A token identifying a page of results the server should return. - */ - pageToken?: string; - /** - * Required. The parent value for DbSystems in the following format: projects/{project\}/locations/{location\}. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Dbsystemshapes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Lists the database system shapes available for the project and location. + * Gets details of a single GoldengateConnection. * @example * ```js * // Before running the sample: @@ -8996,22 +15259,25 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.dbSystemShapes.list({ - * // Optional. An expression for filtering the results of the request. Only the gcp_oracle_zone_id field is supported in this format: `gcp_oracle_zone_id="{gcp_oracle_zone_id\}"`. - * filter: 'placeholder-value', - * // Optional. The maximum number of items to return. If unspecified, at most 50 database system shapes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // Optional. A token identifying a page of results the server should return. - * pageToken: 'placeholder-value', - * // Required. The parent value for Database System Shapes in the following format: projects/{project\}/locations/{location\}. - * parent: 'projects/my-project/locations/my-location', - * }); + * const res = await oracledatabase.projects.locations.goldengateConnections.get( + * { + * // Required. The name of the GoldengateConnection in the following format: projects/{project\}/locations/{location\}/goldengateConnections/{goldengate_connection\}. + * name: 'projects/my-project/locations/my-location/goldengateConnections/my-goldengateConnection', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "dbSystemShapes": [], - * // "nextPageToken": "my_nextPageToken" + * // "createTime": "my_createTime", + * // "entitlementId": "my_entitlementId", + * // "gcpOracleZone": "my_gcpOracleZone", + * // "labels": {}, + * // "name": "my_name", + * // "ociUrl": "my_ociUrl", + * // "odbNetwork": "my_odbNetwork", + * // "odbSubnet": "my_odbSubnet", + * // "properties": {} * // } * } * @@ -9027,57 +15293,56 @@ export namespace oracledatabase_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$Dbsystemshapes$List, + get( + params: Params$Resource$Projects$Locations$Goldengateconnections$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Dbsystemshapes$List, + get( + params?: Params$Resource$Projects$Locations$Goldengateconnections$Get, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Dbsystemshapes$List, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Goldengateconnections$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Dbsystemshapes$List, + get( + params: Params$Resource$Projects$Locations$Goldengateconnections$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Dbsystemshapes$List, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Goldengateconnections$Get, + callback: BodyResponseCallback ): void; - list( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Dbsystemshapes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Goldengateconnections$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$Dbsystemshapes$List; + {}) as Params$Resource$Projects$Locations$Goldengateconnections$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Dbsystemshapes$List; + params = + {} as Params$Resource$Projects$Locations$Goldengateconnections$Get; options = {}; } @@ -9091,58 +15356,29 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/dbSystemShapes').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').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$Dbsystemshapes$List extends StandardParameters { - /** - * Optional. An expression for filtering the results of the request. Only the gcp_oracle_zone_id field is supported in this format: `gcp_oracle_zone_id="{gcp_oracle_zone_id\}"`. - */ - filter?: string; - /** - * Optional. The maximum number of items to return. If unspecified, at most 50 database system shapes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * Optional. A token identifying a page of results the server should return. - */ - pageToken?: string; - /** - * Required. The parent value for Database System Shapes in the following format: projects/{project\}/locations/{location\}. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Dbversions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * List DbVersions for the given project and location. + * Lists all the GoldengateConnections for the given project and location. * @example * ```js * // Before running the sample: @@ -9171,22 +15407,26 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.dbVersions.list({ - * // Optional. Filter expression that matches a subset of the DbVersions to show. The supported filter for dbSystem creation is `db_system_shape = {db_system_shape\} AND storage_management = {storage_management\}`. If no filter is provided, all DbVersions will be returned. - * filter: 'placeholder-value', - * // Optional. The maximum number of items to return. If unspecified, a maximum of 50 DbVersions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. - * pageSize: 'placeholder-value', - * // Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token. - * pageToken: 'placeholder-value', - * // Required. The parent value for the DbVersion resource with the format: projects/{project\}/locations/{location\} - * parent: 'projects/my-project/locations/my-location', - * }); + * const res = + * await oracledatabase.projects.locations.goldengateConnections.list({ + * // Optional. An expression for filtering the results of the request. + * filter: 'placeholder-value', + * // Optional. An expression for ordering the results of the request. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of items to return. If unspecified, at most 50 GoldengateConnections will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous ListGoldengateConnections call. Provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. The parent value for GoldengateConnections in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "dbVersions": [], - * // "nextPageToken": "my_nextPageToken" + * // "goldengateConnections": [], + * // "nextPageToken": "my_nextPageToken", + * // "unreachable": [] * // } * } * @@ -9203,54 +15443,61 @@ export namespace oracledatabase_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Dbversions$List, + params: Params$Resource$Projects$Locations$Goldengateconnections$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Dbversions$List, + params?: Params$Resource$Projects$Locations$Goldengateconnections$List, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; list( - params: Params$Resource$Projects$Locations$Dbversions$List, + params: Params$Resource$Projects$Locations$Goldengateconnections$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Dbversions$List, + params: Params$Resource$Projects$Locations$Goldengateconnections$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Dbversions$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Goldengateconnections$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Dbversions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Goldengateconnections$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$Dbversions$List; + {}) as Params$Resource$Projects$Locations$Goldengateconnections$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Dbversions$List; + params = + {} as Params$Resource$Projects$Locations$Goldengateconnections$List; options = {}; } @@ -9264,7 +15511,7 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/dbVersions').replace( + url: (rootUrl + '/v1/{+parent}/goldengateConnections').replace( /([^:]\/)\/+/g, '$1' ), @@ -9279,43 +15526,84 @@ export namespace oracledatabase_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$Dbversions$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Goldengateconnections$Create extends StandardParameters { /** - * Optional. Filter expression that matches a subset of the DbVersions to show. The supported filter for dbSystem creation is `db_system_shape = {db_system_shape\} AND storage_management = {storage_management\}`. If no filter is provided, all DbVersions will be returned. + * Required. The ID of the GoldengateConnection to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + */ + goldengateConnectionId?: string; + /** + * Required. The value for parent of the GoldengateConnection in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoldengateConnection; + } + export interface Params$Resource$Projects$Locations$Goldengateconnections$Delete extends StandardParameters { + /** + * Required. The name of the GoldengateConnection in the following format: projects/{project\}/locations/{location\}/goldengateConnections/{goldengate_connection\}. + */ + name?: string; + /** + * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Goldengateconnections$Get extends StandardParameters { + /** + * Required. The name of the GoldengateConnection in the following format: projects/{project\}/locations/{location\}/goldengateConnections/{goldengate_connection\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Goldengateconnections$List extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. */ filter?: string; /** - * Optional. The maximum number of items to return. If unspecified, a maximum of 50 DbVersions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. + * Optional. An expression for ordering the results of the request. + */ + orderBy?: string; + /** + * Optional. The maximum number of items to return. If unspecified, at most 50 GoldengateConnections will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. */ pageSize?: number; /** - * Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token. + * Optional. A page token, received from a previous ListGoldengateConnections call. Provide this to retrieve the subsequent page. */ pageToken?: string; /** - * Required. The parent value for the DbVersion resource with the format: projects/{project\}/locations/{location\} + * Required. The parent value for GoldengateConnections in the following format: projects/{project\}/locations/{location\}. */ parent?: string; } - export class Resource$Projects$Locations$Entitlements { + export class Resource$Projects$Locations$Goldengateconnectiontypes { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Lists the entitlements in a given project. + * Gets details of a single GoldengateConnectionType. * @example * ```js * // Before running the sample: @@ -9344,20 +15632,18 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.entitlements.list({ - * // Optional. The maximum number of items to return. If unspecified, a maximum of 50 entitlements will be returned. The maximum value is 1000. - * pageSize: 'placeholder-value', - * // Optional. A token identifying a page of results the server should return. - * pageToken: 'placeholder-value', - * // Required. The parent value for the entitlement in the following format: projects/{project\}/locations/{location\}. - * parent: 'projects/my-project/locations/my-location', - * }); + * const res = + * await oracledatabase.projects.locations.goldengateConnectionTypes.get({ + * // Required. Name of the resource in the format: projects/{project\}/locations/{location\}/goldengateConnectionTypes/{goldengate_connection_type\} + * name: 'projects/my-project/locations/my-location/goldengateConnectionTypes/my-goldengateConnectionType', + * }); * console.log(res.data); * * // Example response * // { - * // "entitlements": [], - * // "nextPageToken": "my_nextPageToken" + * // "connectionType": "my_connectionType", + * // "name": "my_name", + * // "technologyTypes": [] * // } * } * @@ -9373,55 +15659,56 @@ export namespace oracledatabase_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$Entitlements$List, + get( + params: Params$Resource$Projects$Locations$Goldengateconnectiontypes$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Entitlements$List, + get( + params?: Params$Resource$Projects$Locations$Goldengateconnectiontypes$Get, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Entitlements$List, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Goldengateconnectiontypes$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Entitlements$List, + get( + params: Params$Resource$Projects$Locations$Goldengateconnectiontypes$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Entitlements$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Goldengateconnectiontypes$Get, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Entitlements$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Goldengateconnectiontypes$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$Entitlements$List; + {}) as Params$Resource$Projects$Locations$Goldengateconnectiontypes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Entitlements$List; + params = + {} as Params$Resource$Projects$Locations$Goldengateconnectiontypes$Get; options = {}; } @@ -9435,58 +15722,29 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/entitlements').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); } } - } - - export interface Params$Resource$Projects$Locations$Entitlements$List extends StandardParameters { - /** - * Optional. The maximum number of items to return. If unspecified, a maximum of 50 entitlements will be returned. The maximum value is 1000. - */ - pageSize?: number; - /** - * Optional. A token identifying a page of results the server should return. - */ - pageToken?: string; - /** - * Required. The parent value for the entitlement in the following format: projects/{project\}/locations/{location\}. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Exadbvmclusters { - context: APIRequestContext; - dbNodes: Resource$Projects$Locations$Exadbvmclusters$Dbnodes; - constructor(context: APIRequestContext) { - this.context = context; - this.dbNodes = new Resource$Projects$Locations$Exadbvmclusters$Dbnodes( - this.context - ); - } /** - * Creates a new Exadb (Exascale) VM Cluster resource. + * Lists GoldengateConnectionTypes in a given project and location. * @example * ```js * // Before running the sample: @@ -9515,40 +15773,24 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.exadbVmClusters.create({ - * // Required. The ID of the ExadbVmCluster to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. - * exadbVmClusterId: 'placeholder-value', - * // Required. The value for parent of the ExadbVmCluster in the following format: projects/{project\}/locations/{location\}. - * parent: 'projects/my-project/locations/my-location', - * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "backupOdbSubnet": "my_backupOdbSubnet", - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "entitlementId": "my_entitlementId", - * // "gcpOracleZone": "my_gcpOracleZone", - * // "labels": {}, - * // "name": "my_name", - * // "odbNetwork": "my_odbNetwork", - * // "odbSubnet": "my_odbSubnet", - * // "properties": {} - * // } - * }, - * }); + * const res = + * await oracledatabase.projects.locations.goldengateConnectionTypes.list({ + * // Optional. An expression for filtering the results of the request. The connection_type field must be specified in the format: `connection_type="ORACLE"`. + * filter: 'placeholder-value', + * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. Parent value for ListGoldengateConnectionTypesRequest Format: projects/{project\}/locations/{location\} + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "goldengateConnectionTypes": [], + * // "nextPageToken": "my_nextPageToken", + * // "unreachable": [] * // } * } * @@ -9564,54 +15806,62 @@ export namespace oracledatabase_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$Exadbvmclusters$Create, + list( + params: Params$Resource$Projects$Locations$Goldengateconnectiontypes$List, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Exadbvmclusters$Create, + list( + params?: Params$Resource$Projects$Locations$Goldengateconnectiontypes$List, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Exadbvmclusters$Create, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Goldengateconnectiontypes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Exadbvmclusters$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Goldengateconnectiontypes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Exadbvmclusters$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Goldengateconnectiontypes$List, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Exadbvmclusters$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Goldengateconnectiontypes$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$Exadbvmclusters$Create; + {}) as Params$Resource$Projects$Locations$Goldengateconnectiontypes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Exadbvmclusters$Create; + {} as Params$Resource$Projects$Locations$Goldengateconnectiontypes$List; options = {}; } @@ -9625,11 +15875,11 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/exadbVmClusters').replace( + url: (rootUrl + '/v1/{+parent}/goldengateConnectionTypes').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -9640,17 +15890,51 @@ export namespace oracledatabase_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$Goldengateconnectiontypes$Get extends StandardParameters { /** - * Deletes a single Exadb (Exascale) VM Cluster. + * Required. Name of the resource in the format: projects/{project\}/locations/{location\}/goldengateConnectionTypes/{goldengate_connection_type\} + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Goldengateconnectiontypes$List extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. The connection_type field must be specified in the format: `connection_type="ORACLE"`. + */ + filter?: string; + /** + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. Parent value for ListGoldengateConnectionTypesRequest Format: projects/{project\}/locations/{location\} + */ + parent?: string; + } + + export class Resource$Projects$Locations$Goldengatedeploymentenvironments { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets details of a single GoldengateDeploymentEnvironment. * @example * ```js * // Before running the sample: @@ -9679,21 +15963,28 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.exadbVmClusters.delete({ - * // Required. The name of the ExadbVmCluster in the following format: projects/{project\}/locations/{location\}/exadbVmClusters/{exadb_vm_cluster\}. - * name: 'projects/my-project/locations/my-location/exadbVmClusters/my-exadbVmCluster', - * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * }); + * const res = + * await oracledatabase.projects.locations.goldengateDeploymentEnvironments.get( + * { + * // Required. Name of the resource with the format: projects/{project\}/locations/{location\}/goldengateDeploymentEnvironments/{goldengate_deployment_environment\} + * name: 'projects/my-project/locations/my-location/goldengateDeploymentEnvironments/my-goldengateDeploymentEnvironment', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "autoScalingEnabled": false, + * // "category": "my_category", + * // "defaultCpuCoreCount": 0, + * // "displayName": "my_displayName", + * // "environmentType": "my_environmentType", + * // "maxCpuCoreCount": 0, + * // "memoryGbPerCpuCore": 0, + * // "minCpuCoreCount": 0, * // "name": "my_name", - * // "response": {} + * // "networkBandwidthGbpsPerCpuCore": 0, + * // "storageUsageLimitGbPerCpuCore": 0 * // } * } * @@ -9709,54 +16000,58 @@ export namespace oracledatabase_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$Exadbvmclusters$Delete, + get( + params: Params$Resource$Projects$Locations$Goldengatedeploymentenvironments$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Exadbvmclusters$Delete, + get( + params?: Params$Resource$Projects$Locations$Goldengatedeploymentenvironments$Get, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Exadbvmclusters$Delete, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Goldengatedeploymentenvironments$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Exadbvmclusters$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Goldengatedeploymentenvironments$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Exadbvmclusters$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Goldengatedeploymentenvironments$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Exadbvmclusters$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Goldengatedeploymentenvironments$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$Exadbvmclusters$Delete; + {}) as Params$Resource$Projects$Locations$Goldengatedeploymentenvironments$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Exadbvmclusters$Delete; + {} as Params$Resource$Projects$Locations$Goldengatedeploymentenvironments$Get; options = {}; } @@ -9771,7 +16066,7 @@ export namespace oracledatabase_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -9782,17 +16077,19 @@ export namespace oracledatabase_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets details of a single Exadb (Exascale) VM Cluster. + * Lists GoldengateDeploymentEnvironments in a given project and location. * @example * ```js * // Before running the sample: @@ -9821,24 +16118,24 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.exadbVmClusters.get({ - * // Required. The name of the ExadbVmCluster in the following format: projects/{project\}/locations/{location\}/exadbVmClusters/{exadb_vm_cluster\}. - * name: 'projects/my-project/locations/my-location/exadbVmClusters/my-exadbVmCluster', - * }); + * const res = + * await oracledatabase.projects.locations.goldengateDeploymentEnvironments.list( + * { + * // Optional. The maximum number of items to return. If unspecified, at most 50 deployment environments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. The parent, which owns this collection of GoldengateDeploymentEnvironments. Format: projects/{project\}/locations/{location\} + * parent: 'projects/my-project/locations/my-location', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "backupOdbSubnet": "my_backupOdbSubnet", - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "entitlementId": "my_entitlementId", - * // "gcpOracleZone": "my_gcpOracleZone", - * // "labels": {}, - * // "name": "my_name", - * // "odbNetwork": "my_odbNetwork", - * // "odbSubnet": "my_odbSubnet", - * // "properties": {} + * // "goldengateDeploymentEnvironments": [], + * // "nextPageToken": "my_nextPageToken", + * // "unreachable": [] * // } * } * @@ -9854,53 +16151,62 @@ export namespace oracledatabase_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$Exadbvmclusters$Get, + list( + params: Params$Resource$Projects$Locations$Goldengatedeploymentenvironments$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Exadbvmclusters$Get, + list( + params?: Params$Resource$Projects$Locations$Goldengatedeploymentenvironments$List, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Exadbvmclusters$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Goldengatedeploymentenvironments$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Exadbvmclusters$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Goldengatedeploymentenvironments$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Exadbvmclusters$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Goldengatedeploymentenvironments$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Exadbvmclusters$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Goldengatedeploymentenvironments$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$Exadbvmclusters$Get; + {}) as Params$Resource$Projects$Locations$Goldengatedeploymentenvironments$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Exadbvmclusters$Get; + params = + {} as Params$Resource$Projects$Locations$Goldengatedeploymentenvironments$List; options = {}; } @@ -9914,29 +16220,61 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: ( + rootUrl + '/v1/{+parent}/goldengateDeploymentEnvironments' + ).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$Goldengatedeploymentenvironments$Get extends StandardParameters { /** - * Lists all the Exadb (Exascale) VM Clusters for the given project and location. + * Required. Name of the resource with the format: projects/{project\}/locations/{location\}/goldengateDeploymentEnvironments/{goldengate_deployment_environment\} + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Goldengatedeploymentenvironments$List extends StandardParameters { + /** + * Optional. The maximum number of items to return. If unspecified, at most 50 deployment environments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The parent, which owns this collection of GoldengateDeploymentEnvironments. Format: projects/{project\}/locations/{location\} + */ + parent?: string; + } + + export class Resource$Projects$Locations$Goldengatedeployments { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new GoldengateDeployment in a given project and location. * @example * ```js * // Before running the sample: @@ -9965,25 +16303,41 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.exadbVmClusters.list({ - * // Optional. An expression for filtering the results of the request. - * filter: 'placeholder-value', - * // Optional. An expression for ordering the results of the request. - * orderBy: 'placeholder-value', - * // Optional. The maximum number of items to return. If unspecified, at most 50 ExadbVmClusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // Optional. A token identifying a page of results the server should return. - * pageToken: 'placeholder-value', - * // Required. The parent value for ExadbVmClusters in the following format: projects/{project\}/locations/{location\}. - * parent: 'projects/my-project/locations/my-location', - * }); + * const res = + * await oracledatabase.projects.locations.goldengateDeployments.create({ + * // Required. The ID of the GoldengateDeployment to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + * goldengateDeploymentId: 'placeholder-value', + * // Required. The value for parent of the GoldengateDeployment in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "entitlementId": "my_entitlementId", + * // "gcpOracleZone": "my_gcpOracleZone", + * // "labels": {}, + * // "name": "my_name", + * // "ociUrl": "my_ociUrl", + * // "odbNetwork": "my_odbNetwork", + * // "odbSubnet": "my_odbSubnet", + * // "properties": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "exadbVmClusters": [], - * // "nextPageToken": "my_nextPageToken", - * // "unreachable": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -9999,57 +16353,54 @@ export namespace oracledatabase_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$Exadbvmclusters$List, + create( + params: Params$Resource$Projects$Locations$Goldengatedeployments$Create, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Exadbvmclusters$List, + create( + params?: Params$Resource$Projects$Locations$Goldengatedeployments$Create, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Exadbvmclusters$List, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Goldengatedeployments$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Exadbvmclusters$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Exadbvmclusters$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Goldengatedeployments$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Goldengatedeployments$Create, + callback: BodyResponseCallback ): void; - list( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Exadbvmclusters$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Goldengatedeployments$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$Exadbvmclusters$List; + {}) as Params$Resource$Projects$Locations$Goldengatedeployments$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Exadbvmclusters$List; + params = + {} as Params$Resource$Projects$Locations$Goldengatedeployments$Create; options = {}; } @@ -10063,11 +16414,11 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/exadbVmClusters').replace( + url: (rootUrl + '/v1/{+parent}/goldengateDeployments').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -10078,17 +16429,17 @@ export namespace oracledatabase_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates a single Exadb (Exascale) VM Cluster. To add virtual machines to existing exadb vm cluster, only pass the node count. + * Deletes a single GoldengateDeployment. * @example * ```js * // Before running the sample: @@ -10117,31 +16468,13 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.exadbVmClusters.patch({ - * // Identifier. The name of the ExadbVmCluster resource in the following format: projects/{project\}/locations/{region\}/exadbVmClusters/{exadb_vm_cluster\} - * name: 'projects/my-project/locations/my-location/exadbVmClusters/my-exadbVmCluster', - * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * // Optional. A mask specifying which fields in th VM Cluster should be updated. A field specified in the mask is overwritten. If a mask isn't provided then all the fields in the VM Cluster are overwritten. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "backupOdbSubnet": "my_backupOdbSubnet", - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "entitlementId": "my_entitlementId", - * // "gcpOracleZone": "my_gcpOracleZone", - * // "labels": {}, - * // "name": "my_name", - * // "odbNetwork": "my_odbNetwork", - * // "odbSubnet": "my_odbSubnet", - * // "properties": {} - * // } - * }, - * }); + * const res = + * await oracledatabase.projects.locations.goldengateDeployments.delete({ + * // Required. The name of the GoldengateDeployment in the following format: projects/{project\}/locations/{location\}/goldengateDeployments/{goldengate_deployment\}. + * name: 'projects/my-project/locations/my-location/goldengateDeployments/my-goldengateDeployment', + * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -10166,32 +16499,32 @@ export namespace oracledatabase_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$Exadbvmclusters$Patch, + delete( + params: Params$Resource$Projects$Locations$Goldengatedeployments$Delete, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Exadbvmclusters$Patch, + delete( + params?: Params$Resource$Projects$Locations$Goldengatedeployments$Delete, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Exadbvmclusters$Patch, + delete( + params: Params$Resource$Projects$Locations$Goldengatedeployments$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Exadbvmclusters$Patch, + delete( + params: Params$Resource$Projects$Locations$Goldengatedeployments$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Exadbvmclusters$Patch, + delete( + params: Params$Resource$Projects$Locations$Goldengatedeployments$Delete, callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Exadbvmclusters$Patch + | Params$Resource$Projects$Locations$Goldengatedeployments$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -10207,12 +16540,13 @@ export namespace oracledatabase_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Exadbvmclusters$Patch; + {}) as Params$Resource$Projects$Locations$Goldengatedeployments$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Exadbvmclusters$Patch; + params = + {} as Params$Resource$Projects$Locations$Goldengatedeployments$Delete; options = {}; } @@ -10227,7 +16561,7 @@ export namespace oracledatabase_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -10248,7 +16582,7 @@ export namespace oracledatabase_v1 { } /** - * Removes virtual machines from an existing exadb vm cluster. + * Gets details of a single GoldengateDeployment. * @example * ```js * // Before running the sample: @@ -10277,31 +16611,26 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await oracledatabase.projects.locations.exadbVmClusters.removeVirtualMachine( - * { - * // Required. The name of the ExadbVmCluster in the following format: projects/{project\}/locations/{location\}/exadbVmClusters/{exadb_vm_cluster\}. - * name: 'projects/my-project/locations/my-location/exadbVmClusters/my-exadbVmCluster', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "hostnames": [], - * // "requestId": "my_requestId" - * // } - * }, - * }, - * ); + * const res = await oracledatabase.projects.locations.goldengateDeployments.get( + * { + * // Required. The name of the GoldengateDeployment in the following format: projects/{project\}/locations/{location\}/goldengateDeployments/{goldengate_deployment\}. + * name: 'projects/my-project/locations/my-location/goldengateDeployments/my-goldengateDeployment', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "entitlementId": "my_entitlementId", + * // "gcpOracleZone": "my_gcpOracleZone", + * // "labels": {}, * // "name": "my_name", - * // "response": {} + * // "ociUrl": "my_ociUrl", + * // "odbNetwork": "my_odbNetwork", + * // "odbSubnet": "my_odbSubnet", + * // "properties": {} * // } * } * @@ -10317,190 +16646,92 @@ export namespace oracledatabase_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - removeVirtualMachine( - params: Params$Resource$Projects$Locations$Exadbvmclusters$Removevirtualmachine, + get( + params: Params$Resource$Projects$Locations$Goldengatedeployments$Get, options: StreamMethodOptions ): Promise>; - removeVirtualMachine( - params?: Params$Resource$Projects$Locations$Exadbvmclusters$Removevirtualmachine, + get( + params?: Params$Resource$Projects$Locations$Goldengatedeployments$Get, options?: MethodOptions - ): Promise>; - removeVirtualMachine( - params: Params$Resource$Projects$Locations$Exadbvmclusters$Removevirtualmachine, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Goldengatedeployments$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeVirtualMachine( - params: Params$Resource$Projects$Locations$Exadbvmclusters$Removevirtualmachine, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - removeVirtualMachine( - params: Params$Resource$Projects$Locations$Exadbvmclusters$Removevirtualmachine, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Goldengatedeployments$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - removeVirtualMachine( - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Goldengatedeployments$Get, + callback: BodyResponseCallback ): void; - removeVirtualMachine( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Exadbvmclusters$Removevirtualmachine - | BodyResponseCallback + | Params$Resource$Projects$Locations$Goldengatedeployments$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Exadbvmclusters$Removevirtualmachine; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Exadbvmclusters$Removevirtualmachine; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://oracledatabase.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:removeVirtualMachine').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$Exadbvmclusters$Create extends StandardParameters { - /** - * Required. The ID of the ExadbVmCluster to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. - */ - exadbVmClusterId?: string; - /** - * Required. The value for parent of the ExadbVmCluster in the following format: projects/{project\}/locations/{location\}. - */ - parent?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ExadbVmCluster; - } - export interface Params$Resource$Projects$Locations$Exadbvmclusters$Delete extends StandardParameters { - /** - * Required. The name of the ExadbVmCluster in the following format: projects/{project\}/locations/{location\}/exadbVmClusters/{exadb_vm_cluster\}. - */ - name?: string; - /** - * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Projects$Locations$Exadbvmclusters$Get extends StandardParameters { - /** - * Required. The name of the ExadbVmCluster in the following format: projects/{project\}/locations/{location\}/exadbVmClusters/{exadb_vm_cluster\}. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Exadbvmclusters$List extends StandardParameters { - /** - * Optional. An expression for filtering the results of the request. - */ - filter?: string; - /** - * Optional. An expression for ordering the results of the request. - */ - orderBy?: string; - /** - * Optional. The maximum number of items to return. If unspecified, at most 50 ExadbVmClusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * Optional. A token identifying a page of results the server should return. - */ - pageToken?: string; - /** - * Required. The parent value for ExadbVmClusters in the following format: projects/{project\}/locations/{location\}. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Exadbvmclusters$Patch extends StandardParameters { - /** - * Identifier. The name of the ExadbVmCluster resource in the following format: projects/{project\}/locations/{region\}/exadbVmClusters/{exadb_vm_cluster\} - */ - name?: string; - /** - * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * Optional. A mask specifying which fields in th VM Cluster should be updated. A field specified in the mask is overwritten. If a mask isn't provided then all the fields in the VM Cluster are overwritten. - */ - updateMask?: string; + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Goldengatedeployments$Get; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$ExadbVmCluster; - } - export interface Params$Resource$Projects$Locations$Exadbvmclusters$Removevirtualmachine extends StandardParameters { - /** - * Required. The name of the ExadbVmCluster in the following format: projects/{project\}/locations/{location\}/exadbVmClusters/{exadb_vm_cluster\}. - */ - name?: string; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Goldengatedeployments$Get; + options = {}; + } - /** - * Request body metadata - */ - requestBody?: Schema$RemoveVirtualMachineExadbVmClusterRequest; - } + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } - export class Resource$Projects$Locations$Exadbvmclusters$Dbnodes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + const rootUrl = + options.rootUrl || 'https://oracledatabase.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 the database nodes of a VM Cluster. + * Lists all the GoldengateDeployments for the given project and location. * @example * ```js * // Before running the sample: @@ -10530,21 +16761,25 @@ export namespace oracledatabase_v1 { * * // Do the magic * const res = - * await oracledatabase.projects.locations.exadbVmClusters.dbNodes.list({ - * // Optional. The maximum number of items to return. If unspecified, at most 50 db nodes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * await oracledatabase.projects.locations.goldengateDeployments.list({ + * // Optional. An expression for filtering the results of the request. + * filter: 'placeholder-value', + * // Optional. An expression for ordering the results of the request. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of items to return. If unspecified, at most 50 GoldengateDeployments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. * pageSize: 'placeholder-value', - * // Optional. A token identifying a page of results the node should return. + * // Optional. A page token, received from a previous ListGoldengateDeployments call. Provide this to retrieve the subsequent page. * pageToken: 'placeholder-value', - * // Required. The parent value for database node in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloudVmCluster\}. . - * parent: - * 'projects/my-project/locations/my-location/exadbVmClusters/my-exadbVmCluster', + * // Required. The parent value for GoldengateDeployments in the following format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); * * // Example response * // { - * // "dbNodes": [], - * // "nextPageToken": "my_nextPageToken" + * // "goldengateDeployments": [], + * // "nextPageToken": "my_nextPageToken", + * // "unreachable": [] * // } * } * @@ -10561,53 +16796,61 @@ export namespace oracledatabase_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Exadbvmclusters$Dbnodes$List, + params: Params$Resource$Projects$Locations$Goldengatedeployments$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Exadbvmclusters$Dbnodes$List, + params?: Params$Resource$Projects$Locations$Goldengatedeployments$List, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; list( - params: Params$Resource$Projects$Locations$Exadbvmclusters$Dbnodes$List, + params: Params$Resource$Projects$Locations$Goldengatedeployments$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Exadbvmclusters$Dbnodes$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Goldengatedeployments$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Exadbvmclusters$Dbnodes$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Goldengatedeployments$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Exadbvmclusters$Dbnodes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Goldengatedeployments$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$Exadbvmclusters$Dbnodes$List; + {}) as Params$Resource$Projects$Locations$Goldengatedeployments$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Exadbvmclusters$Dbnodes$List; + {} as Params$Resource$Projects$Locations$Goldengatedeployments$List; options = {}; } @@ -10621,7 +16864,7 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/dbNodes').replace( + url: (rootUrl + '/v1/{+parent}/goldengateDeployments').replace( /([^:]\/)\/+/g, '$1' ), @@ -10636,39 +16879,19 @@ export namespace oracledatabase_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$Exadbvmclusters$Dbnodes$List extends StandardParameters { - /** - * Optional. The maximum number of items to return. If unspecified, at most 50 db nodes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * Optional. A token identifying a page of results the node should return. - */ - pageToken?: string; - /** - * Required. The parent value for database node in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloudVmCluster\}. . - */ - parent?: string; - } - - export class Resource$Projects$Locations$Exascaledbstoragevaults { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates a new ExascaleDB Storage Vault resource. + * Starts a single GoldengateDeployment. * @example * ```js * // Before running the sample: @@ -10698,26 +16921,14 @@ export namespace oracledatabase_v1 { * * // Do the magic * const res = - * await oracledatabase.projects.locations.exascaleDbStorageVaults.create({ - * // Required. The ID of the ExascaleDbStorageVault to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. - * exascaleDbStorageVaultId: 'placeholder-value', - * // Required. The value for parent of the ExascaleDbStorageVault in the following format: projects/{project\}/locations/{location\}. - * parent: 'projects/my-project/locations/my-location', - * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * await oracledatabase.projects.locations.goldengateDeployments.start({ + * // Required. The name of the Goldengate Deployment in the following format: projects/{project\}/locations/{location\}/goldengateDeployments/{goldengate_deployment\}. + * name: 'projects/my-project/locations/my-location/goldengateDeployments/my-goldengateDeployment', * * // Request body metadata * requestBody: { * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "entitlementId": "my_entitlementId", - * // "gcpOracleZone": "my_gcpOracleZone", - * // "labels": {}, - * // "name": "my_name", - * // "properties": {} - * // } + * // {} * }, * }); * console.log(res.data); @@ -10744,32 +16955,32 @@ export namespace oracledatabase_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$Exascaledbstoragevaults$Create, + start( + params: Params$Resource$Projects$Locations$Goldengatedeployments$Start, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Create, + start( + params?: Params$Resource$Projects$Locations$Goldengatedeployments$Start, options?: MethodOptions ): Promise>; - create( - params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Create, + start( + params: Params$Resource$Projects$Locations$Goldengatedeployments$Start, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Create, + start( + params: Params$Resource$Projects$Locations$Goldengatedeployments$Start, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Create, + start( + params: Params$Resource$Projects$Locations$Goldengatedeployments$Start, callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + start(callback: BodyResponseCallback): void; + start( paramsOrCallback?: - | Params$Resource$Projects$Locations$Exascaledbstoragevaults$Create + | Params$Resource$Projects$Locations$Goldengatedeployments$Start | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -10785,13 +16996,13 @@ export namespace oracledatabase_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Exascaledbstoragevaults$Create; + {}) as Params$Resource$Projects$Locations$Goldengatedeployments$Start; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Exascaledbstoragevaults$Create; + {} as Params$Resource$Projects$Locations$Goldengatedeployments$Start; options = {}; } @@ -10805,18 +17016,15 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/exascaleDbStorageVaults').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:start').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -10830,7 +17038,7 @@ export namespace oracledatabase_v1 { } /** - * Deletes a single ExascaleDB Storage Vault. + * Stops a single GoldengateDeployment. * @example * ```js * // Before running the sample: @@ -10860,11 +17068,15 @@ export namespace oracledatabase_v1 { * * // Do the magic * const res = - * await oracledatabase.projects.locations.exascaleDbStorageVaults.delete({ - * // Required. The name of the ExascaleDbStorageVault in the following format: projects/{project\}/locations/{location\}/exascaleDbStorageVaults/{exascale_db_storage_vault\}. - * name: 'projects/my-project/locations/my-location/exascaleDbStorageVaults/my-exascaleDbStorageVault', - * // Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', + * await oracledatabase.projects.locations.goldengateDeployments.stop({ + * // Required. The name of the Goldengate Deployment in the following format: projects/{project\}/locations/{location\}/goldengateDeployments/{goldengate_deployment\}. + * name: 'projects/my-project/locations/my-location/goldengateDeployments/my-goldengateDeployment', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, * }); * console.log(res.data); * @@ -10890,32 +17102,32 @@ export namespace oracledatabase_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$Exascaledbstoragevaults$Delete, + stop( + params: Params$Resource$Projects$Locations$Goldengatedeployments$Stop, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Delete, + stop( + params?: Params$Resource$Projects$Locations$Goldengatedeployments$Stop, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Delete, + stop( + params: Params$Resource$Projects$Locations$Goldengatedeployments$Stop, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Delete, + stop( + params: Params$Resource$Projects$Locations$Goldengatedeployments$Stop, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Delete, + stop( + params: Params$Resource$Projects$Locations$Goldengatedeployments$Stop, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + stop(callback: BodyResponseCallback): void; + stop( paramsOrCallback?: - | Params$Resource$Projects$Locations$Exascaledbstoragevaults$Delete + | Params$Resource$Projects$Locations$Goldengatedeployments$Stop | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -10931,13 +17143,13 @@ export namespace oracledatabase_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Exascaledbstoragevaults$Delete; + {}) as Params$Resource$Projects$Locations$Goldengatedeployments$Stop; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Exascaledbstoragevaults$Delete; + {} as Params$Resource$Projects$Locations$Goldengatedeployments$Stop; options = {}; } @@ -10951,8 +17163,8 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:stop').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -10971,9 +17183,96 @@ export namespace oracledatabase_v1 { return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Projects$Locations$Goldengatedeployments$Create extends StandardParameters { + /** + * Required. The ID of the GoldengateDeployment to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + */ + goldengateDeploymentId?: string; + /** + * Required. The value for parent of the GoldengateDeployment in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoldengateDeployment; + } + export interface Params$Resource$Projects$Locations$Goldengatedeployments$Delete extends StandardParameters { + /** + * Required. The name of the GoldengateDeployment in the following format: projects/{project\}/locations/{location\}/goldengateDeployments/{goldengate_deployment\}. + */ + name?: string; + /** + * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Goldengatedeployments$Get extends StandardParameters { + /** + * Required. The name of the GoldengateDeployment in the following format: projects/{project\}/locations/{location\}/goldengateDeployments/{goldengate_deployment\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Goldengatedeployments$List extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. + */ + filter?: string; + /** + * Optional. An expression for ordering the results of the request. + */ + orderBy?: string; + /** + * Optional. The maximum number of items to return. If unspecified, at most 50 GoldengateDeployments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous ListGoldengateDeployments call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The parent value for GoldengateDeployments in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Goldengatedeployments$Start extends StandardParameters { + /** + * Required. The name of the Goldengate Deployment in the following format: projects/{project\}/locations/{location\}/goldengateDeployments/{goldengate_deployment\}. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$StartGoldengateDeploymentRequest; + } + export interface Params$Resource$Projects$Locations$Goldengatedeployments$Stop extends StandardParameters { + /** + * Required. The name of the Goldengate Deployment in the following format: projects/{project\}/locations/{location\}/goldengateDeployments/{goldengate_deployment\}. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$StopGoldengateDeploymentRequest; + } + + export class Resource$Projects$Locations$Goldengatedeploymenttypes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Gets details of a single ExascaleDB Storage Vault. + * Gets details of a single GoldenGateDeploymentType. * @example * ```js * // Before running the sample: @@ -11003,21 +17302,25 @@ export namespace oracledatabase_v1 { * * // Do the magic * const res = - * await oracledatabase.projects.locations.exascaleDbStorageVaults.get({ - * // Required. The name of the ExascaleDbStorageVault in the following format: projects/{project\}/locations/{location\}/exascaleDbStorageVaults/{exascale_db_storage_vault\}. - * name: 'projects/my-project/locations/my-location/exascaleDbStorageVaults/my-exascaleDbStorageVault', + * await oracledatabase.projects.locations.goldengateDeploymentTypes.get({ + * // Required. The name of the GoldengateDeploymentType to retrieve. Format: projects/{project\}/locations/{location\}/goldengateDeploymentTypes/{goldengate_deployment_type\} + * name: 'projects/my-project/locations/my-location/goldengateDeploymentTypes/my-goldengateDeploymentType', * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", + * // "category": "my_category", + * // "connectionTypes": [], + * // "defaultUsername": "my_defaultUsername", + * // "deploymentType": "my_deploymentType", * // "displayName": "my_displayName", - * // "entitlementId": "my_entitlementId", - * // "gcpOracleZone": "my_gcpOracleZone", - * // "labels": {}, * // "name": "my_name", - * // "properties": {} + * // "oggVersion": "my_oggVersion", + * // "sourceTechnologies": [], + * // "supportedCapabilities": [], + * // "supportedTechnologiesUrl": "my_supportedTechnologiesUrl", + * // "targetTechnologies": [] * // } * } * @@ -11034,55 +17337,55 @@ export namespace oracledatabase_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Get, + params: Params$Resource$Projects$Locations$Goldengatedeploymenttypes$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Get, + params?: Params$Resource$Projects$Locations$Goldengatedeploymenttypes$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Get, + params: Params$Resource$Projects$Locations$Goldengatedeploymenttypes$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Get, + params: Params$Resource$Projects$Locations$Goldengatedeploymenttypes$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Goldengatedeploymenttypes$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Exascaledbstoragevaults$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Goldengatedeploymenttypes$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$Exascaledbstoragevaults$Get; + {}) as Params$Resource$Projects$Locations$Goldengatedeploymenttypes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Exascaledbstoragevaults$Get; + {} as Params$Resource$Projects$Locations$Goldengatedeploymenttypes$Get; options = {}; } @@ -11108,17 +17411,17 @@ export namespace oracledatabase_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists all the ExascaleDB Storage Vaults for the given project and location. + * Lists GoldenGateDeploymentTypes in a given project and location. * @example * ```js * // Before running the sample: @@ -11148,23 +17451,23 @@ export namespace oracledatabase_v1 { * * // Do the magic * const res = - * await oracledatabase.projects.locations.exascaleDbStorageVaults.list({ - * // Optional. An expression for filtering the results of the request. Filter the list as specified in https://google.aip.dev/160. + * await oracledatabase.projects.locations.goldengateDeploymentTypes.list({ + * // Optional. An expression for filtering the results of the request. Either the deployment_type and ogg_version fields must be specified in the format: `deployment_type="DATABASE_ORACLE"` or `ogg_version="version"`. Allowed values for deployment_type are: `DATABASE_ORACLE`, `BIGDATA`, `DATABASE_MICROSOFT_SQLSERVER`, `DATABASE_MYSQL`, `DATABASE_POSTGRESQL`, `DATABASE_DB2ZOS`, `DATABASE_DB2I`, `GGSA`, `DATA_TRANSFORMS`. * filter: 'placeholder-value', - * // Optional. An expression for ordering the results of the request. Order results as specified in https://google.aip.dev/132. + * // Optional. Hint for how to order the results * orderBy: 'placeholder-value', - * // Optional. The maximum number of items to return. If unspecified, at most 50 ExascaleDbStorageVaults will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. * pageSize: 'placeholder-value', * // Optional. A token identifying a page of results the server should return. * pageToken: 'placeholder-value', - * // Required. The parent value for ExascaleDbStorageVault in the following format: projects/{project\}/locations/{location\}. + * // Required. The parent resource. Format: projects/{project\}/locations/{location\} * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); * * // Example response * // { - * // "exascaleDbStorageVaults": [], + * // "goldengateDeploymentTypes": [], * // "nextPageToken": "my_nextPageToken", * // "unreachable": [] * // } @@ -11183,61 +17486,61 @@ export namespace oracledatabase_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$List, + params: Params$Resource$Projects$Locations$Goldengatedeploymenttypes$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Exascaledbstoragevaults$List, + params?: Params$Resource$Projects$Locations$Goldengatedeploymenttypes$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$List, + params: Params$Resource$Projects$Locations$Goldengatedeploymenttypes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$List, + params: Params$Resource$Projects$Locations$Goldengatedeploymenttypes$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Exascaledbstoragevaults$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Goldengatedeploymenttypes$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Exascaledbstoragevaults$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Goldengatedeploymenttypes$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$Exascaledbstoragevaults$List; + {}) as Params$Resource$Projects$Locations$Goldengatedeploymenttypes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Exascaledbstoragevaults$List; + {} as Params$Resource$Projects$Locations$Goldengatedeploymenttypes$List; options = {}; } @@ -11251,7 +17554,7 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/exascaleDbStorageVaults').replace( + url: (rootUrl + '/v1/{+parent}/goldengateDeploymentTypes').replace( /([^:]\/)\/+/g, '$1' ), @@ -11266,64 +17569,35 @@ export namespace oracledatabase_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Exascaledbstoragevaults$Create extends StandardParameters { - /** - * Required. The ID of the ExascaleDbStorageVault to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. - */ - exascaleDbStorageVaultId?: string; - /** - * Required. The value for parent of the ExascaleDbStorageVault in the following format: projects/{project\}/locations/{location\}. - */ - parent?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ExascaleDbStorageVault; - } - export interface Params$Resource$Projects$Locations$Exascaledbstoragevaults$Delete extends StandardParameters { - /** - * Required. The name of the ExascaleDbStorageVault in the following format: projects/{project\}/locations/{location\}/exascaleDbStorageVaults/{exascale_db_storage_vault\}. - */ - name?: string; - /** - * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Projects$Locations$Exascaledbstoragevaults$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Goldengatedeploymenttypes$Get extends StandardParameters { /** - * Required. The name of the ExascaleDbStorageVault in the following format: projects/{project\}/locations/{location\}/exascaleDbStorageVaults/{exascale_db_storage_vault\}. + * Required. The name of the GoldengateDeploymentType to retrieve. Format: projects/{project\}/locations/{location\}/goldengateDeploymentTypes/{goldengate_deployment_type\} */ name?: string; } - export interface Params$Resource$Projects$Locations$Exascaledbstoragevaults$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Goldengatedeploymenttypes$List extends StandardParameters { /** - * Optional. An expression for filtering the results of the request. Filter the list as specified in https://google.aip.dev/160. + * Optional. An expression for filtering the results of the request. Either the deployment_type and ogg_version fields must be specified in the format: `deployment_type="DATABASE_ORACLE"` or `ogg_version="version"`. Allowed values for deployment_type are: `DATABASE_ORACLE`, `BIGDATA`, `DATABASE_MICROSOFT_SQLSERVER`, `DATABASE_MYSQL`, `DATABASE_POSTGRESQL`, `DATABASE_DB2ZOS`, `DATABASE_DB2I`, `GGSA`, `DATA_TRANSFORMS`. */ filter?: string; /** - * Optional. An expression for ordering the results of the request. Order results as specified in https://google.aip.dev/132. + * Optional. Hint for how to order the results */ orderBy?: string; /** - * Optional. The maximum number of items to return. If unspecified, at most 50 ExascaleDbStorageVaults will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. */ pageSize?: number; /** @@ -11331,22 +17605,19 @@ export namespace oracledatabase_v1 { */ pageToken?: string; /** - * Required. The parent value for ExascaleDbStorageVault in the following format: projects/{project\}/locations/{location\}. + * Required. The parent resource. Format: projects/{project\}/locations/{location\} */ parent?: string; } - export class Resource$Projects$Locations$Giversions { + export class Resource$Projects$Locations$Goldengatedeploymentversions { context: APIRequestContext; - minorVersions: Resource$Projects$Locations$Giversions$Minorversions; constructor(context: APIRequestContext) { this.context = context; - this.minorVersions = - new Resource$Projects$Locations$Giversions$Minorversions(this.context); } /** - * Lists all the valid Oracle Grid Infrastructure (GI) versions for the given project and location. + * Gets details of a single GoldengateDeploymentVersion. * @example * ```js * // Before running the sample: @@ -11375,22 +17646,18 @@ export namespace oracledatabase_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await oracledatabase.projects.locations.giVersions.list({ - * // Optional. An expression for filtering the results of the request. Only the shape, gcp_oracle_zone and gi_version fields are supported in this format: `shape="{shape\}"`. - * filter: 'placeholder-value', - * // Optional. The maximum number of items to return. If unspecified, a maximum of 50 Oracle Grid Infrastructure (GI) versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. - * pageSize: 'placeholder-value', - * // Optional. A token identifying a page of results the server should return. - * pageToken: 'placeholder-value', - * // Required. The parent value for Grid Infrastructure Version in the following format: Format: projects/{project\}/locations/{location\}. - * parent: 'projects/my-project/locations/my-location', - * }); + * const res = + * await oracledatabase.projects.locations.goldengateDeploymentVersions.get({ + * // Required. The name of the GoldengateDeploymentVersion to retrieve. Format: projects/{project\}/locations/{location\}/goldengateDeploymentVersions/{goldengate_deployment_version\} + * name: 'projects/my-project/locations/my-location/goldengateDeploymentVersions/my-goldengateDeploymentVersion', + * }); * console.log(res.data); * * // Example response * // { - * // "giVersions": [], - * // "nextPageToken": "my_nextPageToken" + * // "name": "my_name", + * // "ocid": "my_ocid", + * // "properties": {} * // } * } * @@ -11406,55 +17673,58 @@ export namespace oracledatabase_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$Giversions$List, + get( + params: Params$Resource$Projects$Locations$Goldengatedeploymentversions$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Giversions$List, + get( + params?: Params$Resource$Projects$Locations$Goldengatedeploymentversions$Get, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Giversions$List, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Goldengatedeploymentversions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Giversions$List, + get( + params: Params$Resource$Projects$Locations$Goldengatedeploymentversions$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Giversions$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Goldengatedeploymentversions$Get, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Giversions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Goldengatedeploymentversions$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$Giversions$List; + {}) as Params$Resource$Projects$Locations$Goldengatedeploymentversions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Giversions$List; + params = + {} as Params$Resource$Projects$Locations$Goldengatedeploymentversions$Get; options = {}; } @@ -11468,58 +17738,29 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/giVersions').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); } } - } - - export interface Params$Resource$Projects$Locations$Giversions$List extends StandardParameters { - /** - * Optional. An expression for filtering the results of the request. Only the shape, gcp_oracle_zone and gi_version fields are supported in this format: `shape="{shape\}"`. - */ - filter?: string; - /** - * Optional. The maximum number of items to return. If unspecified, a maximum of 50 Oracle Grid Infrastructure (GI) versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. - */ - pageSize?: number; - /** - * Optional. A token identifying a page of results the server should return. - */ - pageToken?: string; - /** - * Required. The parent value for Grid Infrastructure Version in the following format: Format: projects/{project\}/locations/{location\}. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Giversions$Minorversions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Lists all the valid minor versions for the given project, location, gi version and shape family. + * Lists GoldengateDeploymentVersions in a given project and location. * @example * ```js * // Before running the sample: @@ -11549,23 +17790,23 @@ export namespace oracledatabase_v1 { * * // Do the magic * const res = - * await oracledatabase.projects.locations.giVersions.minorVersions.list({ - * // Optional. An expression for filtering the results of the request. Only shapeFamily and gcp_oracle_zone_id are supported in this format: `shape_family="{shapeFamily\}" AND gcp_oracle_zone_id="{gcp_oracle_zone_id\}"`. + * await oracledatabase.projects.locations.goldengateDeploymentVersions.list({ + * // Optional. An expression for filtering the results of the request. Either the deployment_id and deployment_type fields must be specified in the format: `deployment_id="id"` or `deployment_type="DATABASE_ORACLE"`. * filter: 'placeholder-value', - * // Optional. The maximum number of items to return. If unspecified, a maximum of 50 System Versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. + * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. * pageSize: 'placeholder-value', - * // Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token. + * // Optional. A token identifying a page of results the server should return. * pageToken: 'placeholder-value', - * // Required. The parent value for the MinorVersion resource with the format: projects/{project\}/locations/{location\}/giVersions/{gi_version\} - * parent: - * 'projects/my-project/locations/my-location/giVersions/my-giVersion', + * // Required. Parent value for ListGoldengateDeploymentVersionsRequest Format: projects/{project\}/locations/{location\} + * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); * * // Example response * // { - * // "minorVersions": [], - * // "nextPageToken": "my_nextPageToken" + * // "goldengateDeploymentVersions": [], + * // "nextPageToken": "my_nextPageToken", + * // "unreachable": [] * // } * } * @@ -11582,57 +17823,61 @@ export namespace oracledatabase_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Giversions$Minorversions$List, + params: Params$Resource$Projects$Locations$Goldengatedeploymentversions$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Giversions$Minorversions$List, + params?: Params$Resource$Projects$Locations$Goldengatedeploymentversions$List, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; list( - params: Params$Resource$Projects$Locations$Giversions$Minorversions$List, + params: Params$Resource$Projects$Locations$Goldengatedeploymentversions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Giversions$Minorversions$List, + params: Params$Resource$Projects$Locations$Goldengatedeploymentversions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Giversions$Minorversions$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Goldengatedeploymentversions$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Giversions$Minorversions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Goldengatedeploymentversions$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$Giversions$Minorversions$List; + {}) as Params$Resource$Projects$Locations$Goldengatedeploymentversions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Giversions$Minorversions$List; + {} as Params$Resource$Projects$Locations$Goldengatedeploymentversions$List; options = {}; } @@ -11646,10 +17891,9 @@ export namespace oracledatabase_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/minorVersions').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1/{+parent}/goldengateDeploymentVersions' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -11661,31 +17905,39 @@ export namespace oracledatabase_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$Giversions$Minorversions$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Goldengatedeploymentversions$Get extends StandardParameters { /** - * Optional. An expression for filtering the results of the request. Only shapeFamily and gcp_oracle_zone_id are supported in this format: `shape_family="{shapeFamily\}" AND gcp_oracle_zone_id="{gcp_oracle_zone_id\}"`. + * Required. The name of the GoldengateDeploymentVersion to retrieve. Format: projects/{project\}/locations/{location\}/goldengateDeploymentVersions/{goldengate_deployment_version\} + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Goldengatedeploymentversions$List extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. Either the deployment_id and deployment_type fields must be specified in the format: `deployment_id="id"` or `deployment_type="DATABASE_ORACLE"`. */ filter?: string; /** - * Optional. The maximum number of items to return. If unspecified, a maximum of 50 System Versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. */ pageSize?: number; /** - * Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token. + * Optional. A token identifying a page of results the server should return. */ pageToken?: string; /** - * Required. The parent value for the MinorVersion resource with the format: projects/{project\}/locations/{location\}/giVersions/{gi_version\} + * Required. Parent value for ListGoldengateDeploymentVersionsRequest Format: projects/{project\}/locations/{location\} */ parent?: string; } diff --git a/src/apis/recaptchaenterprise/v1.ts b/src/apis/recaptchaenterprise/v1.ts index 12bde18149b..717033ac61e 100644 --- a/src/apis/recaptchaenterprise/v1.ts +++ b/src/apis/recaptchaenterprise/v1.ts @@ -348,7 +348,7 @@ export namespace recaptchaenterprise_v1 { */ botType?: string | null; /** - * Optional. Enumerated string value that indicates the identity of the bot, formatted in kebab-case. + * Optional. Enumerated string value that indicates the identity of the bot, formatted in kebab-case. Current example values include the following: * google-agent * browser-base * chat-gpt * aws-bedrock * cybaa-bot * cloudflare * payhawk Ensure that your applications can handle identifier values not explicitly listed here. Deprecated values might take some time to stop showing up in responses. New values can be pushed so this list should be taken as non exhaustive. */ name?: string | null; } diff --git a/src/apis/retail/v2.ts b/src/apis/retail/v2.ts index bdc197a3ed5..c72fc968ae6 100644 --- a/src/apis/retail/v2.ts +++ b/src/apis/retail/v2.ts @@ -3295,7 +3295,7 @@ export namespace retail_v2 { */ catalogAttribute?: Schema$GoogleCloudRetailV2CatalogAttribute; /** - * Indicates which fields in the provided CatalogAttribute to update. The following are NOT supported: * CatalogAttribute.key If not set, all supported fields are updated. + * Optional. Indicates which fields in the provided CatalogAttribute to update. The following are NOT supported: * CatalogAttribute.key If not set, all supported fields are updated. */ updateMask?: string | null; } @@ -5775,7 +5775,7 @@ export namespace retail_v2 { * const res = await retail.projects.locations.catalogs.patch({ * // Required. Immutable. The fully qualified resource name of the catalog. * name: 'projects/my-project/locations/my-location/catalogs/my-catalog', - * // Indicates which fields in the provided Catalog to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. + * // Optional. Indicates which fields in the provided Catalog to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. * updateMask: 'placeholder-value', * * // Request body metadata @@ -6075,7 +6075,7 @@ export namespace retail_v2 { * const res = await retail.projects.locations.catalogs.updateAttributesConfig({ * // Required. Immutable. The fully qualified resource name of the attribute config. Format: `projects/x/locations/x/catalogs/x/attributesConfig` * name: 'projects/my-project/locations/my-location/catalogs/my-catalog/attributesConfig', - * // Indicates which fields in the provided AttributesConfig to update. The following is the only supported field: * AttributesConfig.catalog_attributes If not set, all supported fields are updated. + * // Optional. Indicates which fields in the provided AttributesConfig to update. The following is the only supported field: * AttributesConfig.catalog_attributes If not set, all supported fields are updated. * updateMask: 'placeholder-value', * * // Request body metadata @@ -6234,7 +6234,7 @@ export namespace retail_v2 { * const res = await retail.projects.locations.catalogs.updateCompletionConfig({ * // Required. Immutable. Fully qualified name `projects/x/locations/x/catalogs/x/completionConfig` * name: 'projects/my-project/locations/my-location/catalogs/my-catalog/completionConfig', - * // Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.auto_learning If not set, all supported fields are updated. + * // Optional. Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.auto_learning If not set, all supported fields are updated. * updateMask: 'placeholder-value', * * // Request body metadata @@ -6976,7 +6976,7 @@ export namespace retail_v2 { */ name?: string; /** - * Indicates which fields in the provided Catalog to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. + * Optional. Indicates which fields in the provided Catalog to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. */ updateMask?: string; @@ -7002,7 +7002,7 @@ export namespace retail_v2 { */ name?: string; /** - * Indicates which fields in the provided AttributesConfig to update. The following is the only supported field: * AttributesConfig.catalog_attributes If not set, all supported fields are updated. + * Optional. Indicates which fields in the provided AttributesConfig to update. The following is the only supported field: * AttributesConfig.catalog_attributes If not set, all supported fields are updated. */ updateMask?: string; @@ -7017,7 +7017,7 @@ export namespace retail_v2 { */ name?: string; /** - * Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.auto_learning If not set, all supported fields are updated. + * Optional. Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.auto_learning If not set, all supported fields are updated. */ updateMask?: string; diff --git a/src/apis/retail/v2alpha.ts b/src/apis/retail/v2alpha.ts index c9b7a5061df..2686663d75e 100644 --- a/src/apis/retail/v2alpha.ts +++ b/src/apis/retail/v2alpha.ts @@ -2845,7 +2845,7 @@ export namespace retail_v2alpha { */ catalogAttribute?: Schema$GoogleCloudRetailV2alphaCatalogAttribute; /** - * Indicates which fields in the provided CatalogAttribute to update. The following are NOT supported: * CatalogAttribute.key If not set, all supported fields are updated. + * Optional. Indicates which fields in the provided CatalogAttribute to update. The following are NOT supported: * CatalogAttribute.key If not set, all supported fields are updated. */ updateMask?: string | null; } @@ -7240,7 +7240,7 @@ export namespace retail_v2alpha { * const res = await retail.projects.locations.catalogs.patch({ * // Required. Immutable. The fully qualified resource name of the catalog. * name: 'projects/my-project/locations/my-location/catalogs/my-catalog', - * // Indicates which fields in the provided Catalog to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. + * // Optional. Indicates which fields in the provided Catalog to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. * updateMask: 'placeholder-value', * * // Request body metadata @@ -7544,7 +7544,7 @@ export namespace retail_v2alpha { * const res = await retail.projects.locations.catalogs.updateAttributesConfig({ * // Required. Immutable. The fully qualified resource name of the attribute config. Format: `projects/x/locations/x/catalogs/x/attributesConfig` * name: 'projects/my-project/locations/my-location/catalogs/my-catalog/attributesConfig', - * // Indicates which fields in the provided AttributesConfig to update. The following is the only supported field: * AttributesConfig.catalog_attributes If not set, all supported fields are updated. + * // Optional. Indicates which fields in the provided AttributesConfig to update. The following is the only supported field: * AttributesConfig.catalog_attributes If not set, all supported fields are updated. * updateMask: 'placeholder-value', * * // Request body metadata @@ -7703,7 +7703,7 @@ export namespace retail_v2alpha { * const res = await retail.projects.locations.catalogs.updateCompletionConfig({ * // Required. Immutable. Fully qualified name `projects/x/locations/x/catalogs/x/completionConfig` * name: 'projects/my-project/locations/my-location/catalogs/my-catalog/completionConfig', - * // Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.auto_learning If not set, all supported fields are updated. + * // Optional. Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.auto_learning If not set, all supported fields are updated. * updateMask: 'placeholder-value', * * // Request body metadata @@ -8445,7 +8445,7 @@ export namespace retail_v2alpha { */ name?: string; /** - * Indicates which fields in the provided Catalog to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. + * Optional. Indicates which fields in the provided Catalog to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. */ updateMask?: string; @@ -8471,7 +8471,7 @@ export namespace retail_v2alpha { */ name?: string; /** - * Indicates which fields in the provided AttributesConfig to update. The following is the only supported field: * AttributesConfig.catalog_attributes If not set, all supported fields are updated. + * Optional. Indicates which fields in the provided AttributesConfig to update. The following is the only supported field: * AttributesConfig.catalog_attributes If not set, all supported fields are updated. */ updateMask?: string; @@ -8486,7 +8486,7 @@ export namespace retail_v2alpha { */ name?: string; /** - * Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.auto_learning If not set, all supported fields are updated. + * Optional. Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.auto_learning If not set, all supported fields are updated. */ updateMask?: string; diff --git a/src/apis/retail/v2beta.ts b/src/apis/retail/v2beta.ts index 70e7089749e..184e25e2450 100644 --- a/src/apis/retail/v2beta.ts +++ b/src/apis/retail/v2beta.ts @@ -3087,7 +3087,7 @@ export namespace retail_v2beta { */ catalogAttribute?: Schema$GoogleCloudRetailV2betaCatalogAttribute; /** - * Indicates which fields in the provided CatalogAttribute to update. The following are NOT supported: * CatalogAttribute.key If not set, all supported fields are updated. + * Optional. Indicates which fields in the provided CatalogAttribute to update. The following are NOT supported: * CatalogAttribute.key If not set, all supported fields are updated. */ updateMask?: string | null; } @@ -6253,7 +6253,7 @@ export namespace retail_v2beta { * const res = await retail.projects.locations.catalogs.patch({ * // Required. Immutable. The fully qualified resource name of the catalog. * name: 'projects/my-project/locations/my-location/catalogs/my-catalog', - * // Indicates which fields in the provided Catalog to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. + * // Optional. Indicates which fields in the provided Catalog to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. * updateMask: 'placeholder-value', * * // Request body metadata @@ -6557,7 +6557,7 @@ export namespace retail_v2beta { * const res = await retail.projects.locations.catalogs.updateAttributesConfig({ * // Required. Immutable. The fully qualified resource name of the attribute config. Format: `projects/x/locations/x/catalogs/x/attributesConfig` * name: 'projects/my-project/locations/my-location/catalogs/my-catalog/attributesConfig', - * // Indicates which fields in the provided AttributesConfig to update. The following is the only supported field: * AttributesConfig.catalog_attributes If not set, all supported fields are updated. + * // Optional. Indicates which fields in the provided AttributesConfig to update. The following is the only supported field: * AttributesConfig.catalog_attributes If not set, all supported fields are updated. * updateMask: 'placeholder-value', * * // Request body metadata @@ -6716,7 +6716,7 @@ export namespace retail_v2beta { * const res = await retail.projects.locations.catalogs.updateCompletionConfig({ * // Required. Immutable. Fully qualified name `projects/x/locations/x/catalogs/x/completionConfig` * name: 'projects/my-project/locations/my-location/catalogs/my-catalog/completionConfig', - * // Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.auto_learning If not set, all supported fields are updated. + * // Optional. Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.auto_learning If not set, all supported fields are updated. * updateMask: 'placeholder-value', * * // Request body metadata @@ -7458,7 +7458,7 @@ export namespace retail_v2beta { */ name?: string; /** - * Indicates which fields in the provided Catalog to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. + * Optional. Indicates which fields in the provided Catalog to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. */ updateMask?: string; @@ -7484,7 +7484,7 @@ export namespace retail_v2beta { */ name?: string; /** - * Indicates which fields in the provided AttributesConfig to update. The following is the only supported field: * AttributesConfig.catalog_attributes If not set, all supported fields are updated. + * Optional. Indicates which fields in the provided AttributesConfig to update. The following is the only supported field: * AttributesConfig.catalog_attributes If not set, all supported fields are updated. */ updateMask?: string; @@ -7499,7 +7499,7 @@ export namespace retail_v2beta { */ name?: string; /** - * Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.auto_learning If not set, all supported fields are updated. + * Optional. Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.auto_learning If not set, all supported fields are updated. */ updateMask?: string; diff --git a/src/apis/run/v1.ts b/src/apis/run/v1.ts index 3d5372c7adf..3c54f4273af 100644 --- a/src/apis/run/v1.ts +++ b/src/apis/run/v1.ts @@ -1114,7 +1114,7 @@ export namespace run_v1 { */ pullTiming?: Schema$GoogleDevtoolsCloudbuildV1TimeSpan; /** - * Output only. Declaration of results for this build step. + * Declaration of results for this build step. */ results?: Schema$GoogleDevtoolsCloudbuildV1StepResult[]; /** @@ -2520,7 +2520,7 @@ export namespace run_v1 { */ export interface Schema$ObjectMeta { /** - * Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + * Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution . * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution . * `run.googleapis.com/execution-environment`: Revision, Execution . * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution . * `run.googleapis.com/vpc-access-egress`: Revision, Execution. */ annotations?: {[key: string]: string} | null; /** diff --git a/src/apis/run/v2.ts b/src/apis/run/v2.ts index 9d9f2a20519..a19ccaca09f 100644 --- a/src/apis/run/v2.ts +++ b/src/apis/run/v2.ts @@ -2824,7 +2824,7 @@ export namespace run_v2 { */ pullTiming?: Schema$GoogleDevtoolsCloudbuildV1TimeSpan; /** - * Output only. Declaration of results for this build step. + * Declaration of results for this build step. */ results?: Schema$GoogleDevtoolsCloudbuildV1StepResult[]; /** diff --git a/src/apis/sqladmin/v1.ts b/src/apis/sqladmin/v1.ts index f6d2d68c9b3..c349996b5f1 100644 --- a/src/apis/sqladmin/v1.ts +++ b/src/apis/sqladmin/v1.ts @@ -2697,7 +2697,7 @@ export namespace sqladmin_v1 { */ denyMaintenancePeriods?: Schema$DenyMaintenancePeriod[]; /** - * Optional. The edition of the instance. + * Optional. The edition type of the Cloud SQL instance. */ edition?: string | null; /** diff --git a/src/apis/tagmanager/v2.ts b/src/apis/tagmanager/v2.ts index 9c271718d91..0d0a6ac75fa 100644 --- a/src/apis/tagmanager/v2.ts +++ b/src/apis/tagmanager/v2.ts @@ -265,6 +265,10 @@ export namespace tagmanager_v2 { */ workspaceId?: string | null; } + export interface Schema$CompilerErrorLite { + errorMessage?: string | null; + errorType?: string | null; + } /** * Represents a predicate. */ @@ -579,6 +583,10 @@ export namespace tagmanager_v2 { * Compiler errors or not. */ compilerError?: boolean | null; + /** + * Compiler error details. + */ + compilerErrors?: Schema$CompilerErrorLite[]; /** * The container version created. */ @@ -1210,6 +1218,10 @@ export namespace tagmanager_v2 { * Compiler errors or not. */ compilerError?: boolean | null; + /** + * Compiler error details. + */ + compilerErrors?: Schema$CompilerErrorLite[]; /** * The container version created. */ @@ -1223,6 +1235,10 @@ export namespace tagmanager_v2 { * Were there compiler errors or not. */ compilerError?: boolean | null; + /** + * Compiler error details. + */ + compilerErrors?: Schema$CompilerErrorLite[]; /** * The quick previewed container version. */ @@ -5926,6 +5942,7 @@ export namespace tagmanager_v2 { * // Example response * // { * // "compilerError": false, + * // "compilerErrors": [], * // "containerVersion": {} * // } * } @@ -7334,6 +7351,7 @@ export namespace tagmanager_v2 { * // Example response * // { * // "compilerError": false, + * // "compilerErrors": [], * // "containerVersion": {}, * // "newWorkspacePath": "my_newWorkspacePath", * // "syncStatus": {} @@ -8050,6 +8068,7 @@ export namespace tagmanager_v2 { * // Example response * // { * // "compilerError": false, + * // "compilerErrors": [], * // "containerVersion": {}, * // "syncStatus": {} * // } diff --git a/src/apis/threatintelligence/v1beta.ts b/src/apis/threatintelligence/v1beta.ts index 59d373b39e2..f082d575141 100644 --- a/src/apis/threatintelligence/v1beta.ts +++ b/src/apis/threatintelligence/v1beta.ts @@ -129,7 +129,7 @@ export namespace threatintelligence_v1beta { */ export interface Schema$Alert { /** - * Optional. AI summary of the finding. + * Optional. AI summary of the alert. */ aiSummary?: string | null; /** @@ -219,7 +219,7 @@ export namespace threatintelligence_v1beta { */ export interface Schema$AlertDocument { /** - * Output only. AI summary of the finding. + * Output only. AI summary of the document. */ aiSummary?: string | null; /** diff --git a/src/apis/walletobjects/v1.ts b/src/apis/walletobjects/v1.ts index 45dec8f20bb..71655495bfc 100644 --- a/src/apis/walletobjects/v1.ts +++ b/src/apis/walletobjects/v1.ts @@ -2876,6 +2876,10 @@ export namespace walletobjects_v1 { * Scotty-provided SHA256 hash for an upload. */ sha256Hash?: string | null; + /** + * Scotty-provided SHA512 hash for an upload. + */ + sha512Hash?: string | null; /** * Time at which the media data was last updated, in milliseconds since UNIX epoch */ @@ -17540,6 +17544,7 @@ export namespace walletobjects_v1 { * // "referenceType": "my_referenceType", * // "sha1Hash": "my_sha1Hash", * // "sha256Hash": "my_sha256Hash", + * // "sha512Hash": "my_sha512Hash", * // "timestamp": "my_timestamp", * // "token": "my_token" * // } diff --git a/src/apis/workspaceevents/v1.ts b/src/apis/workspaceevents/v1.ts index c98044803bf..a37f576c216 100644 --- a/src/apis/workspaceevents/v1.ts +++ b/src/apis/workspaceevents/v1.ts @@ -184,6 +184,15 @@ export namespace workspaceevents_v1 { export interface Schema$DataPart { data?: {[key: string]: any} | null; } + /** + * Additional supported options for serving Drive events. + */ + export interface Schema$DriveOptions { + /** + * Optional. Immutable. For subscriptions to Google Drive events, whether to receive events about Drive files that are children of the target folder or shared drive. * If `false`, the subscription only receives events about changes to the folder or shared drive that's specified as the `targetResource`. * If `true`, the `mimeType` field of the `file` resource must be set to `application/vnd.google-apps.folder`. For details, see [Google Drive event types](https://developers.google.com/workspace/events/guides/events-drive#event-types). + */ + includeDescendants?: boolean | null; + } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} */ @@ -417,6 +426,10 @@ export namespace workspaceevents_v1 { * Output only. The time when the subscription is created. */ createTime?: string | null; + /** + * Optional. Features that are supported only for subscriptions on Drive resources. + */ + driveOptions?: Schema$DriveOptions; /** * Optional. This checksum is computed by the server based on the value of other fields, and might be sent on update requests to ensure the client has an up-to-date value before proceeding. */ @@ -988,6 +1001,7 @@ export namespace workspaceevents_v1 { * // { * // "authority": "my_authority", * // "createTime": "my_createTime", + * // "driveOptions": {}, * // "etag": "my_etag", * // "eventTypes": [], * // "expireTime": "my_expireTime", @@ -1334,6 +1348,7 @@ export namespace workspaceevents_v1 { * // { * // "authority": "my_authority", * // "createTime": "my_createTime", + * // "driveOptions": {}, * // "etag": "my_etag", * // "eventTypes": [], * // "expireTime": "my_expireTime", @@ -1675,6 +1690,7 @@ export namespace workspaceevents_v1 { * // { * // "authority": "my_authority", * // "createTime": "my_createTime", + * // "driveOptions": {}, * // "etag": "my_etag", * // "eventTypes": [], * // "expireTime": "my_expireTime", diff --git a/src/apis/workstations/v1beta.ts b/src/apis/workstations/v1beta.ts index b1f21c57eaf..8aaa3d6eb4c 100644 --- a/src/apis/workstations/v1beta.ts +++ b/src/apis/workstations/v1beta.ts @@ -993,6 +993,10 @@ export namespace workstations_v1beta { * Identifier. Full name of this workstation. */ name?: string | null; + /** + * Optional. Directories to persist across workstation sessions. + */ + persistentDirectories?: Schema$WorkstationPersistentDirectory[]; /** * Output only. Indicates whether this workstation is currently being updated to match its intended state. */ @@ -1265,6 +1269,36 @@ export namespace workstations_v1beta { */ updateTime?: string | null; } + /** + * A Persistent Directory backed by a Compute Engine regional persistent disk within the workstation. + */ + export interface Schema$WorkstationGceRegionalPersistentDisk { + /** + * The name of the persistent directory. + */ + name?: string | null; + /** + * Required. The desired size of the persistent directory in GB. + */ + sizeGb?: number | null; + } + /** + * A directory to persist across workstation sessions. Updates to this field will only take effect on this workstation after it is restarted. + */ + export interface Schema$WorkstationPersistentDirectory { + /** + * A PersistentDirectory backed by a Compute Engine persistent disk. + */ + gcePd?: Schema$WorkstationGceRegionalPersistentDisk; + /** + * Optional. The mount path of the persistent directory. + */ + mountPath?: string | null; + /** + * Optional. Size of the persistent directory in GB. If specified in an update request, this is the desired size of the directory. + */ + sizeGb?: number | null; + } export class Resource$Projects { context: APIRequestContext; @@ -4466,6 +4500,7 @@ export namespace workstations_v1beta { * // "kmsKey": "my_kmsKey", * // "labels": {}, * // "name": "my_name", + * // "persistentDirectories": [], * // "reconciling": false, * // "runtimeHost": {}, * // "satisfiesPzi": false, @@ -4943,6 +4978,7 @@ export namespace workstations_v1beta { * // "kmsKey": "my_kmsKey", * // "labels": {}, * // "name": "my_name", + * // "persistentDirectories": [], * // "reconciling": false, * // "runtimeHost": {}, * // "satisfiesPzi": false, @@ -5559,6 +5595,7 @@ export namespace workstations_v1beta { * // "kmsKey": "my_kmsKey", * // "labels": {}, * // "name": "my_name", + * // "persistentDirectories": [], * // "reconciling": false, * // "runtimeHost": {}, * // "satisfiesPzi": false, diff --git a/src/index.ts b/src/index.ts index 3b486b9ce34..7ba8360d5aa 100644 --- a/src/index.ts +++ b/src/index.ts @@ -159,6 +159,7 @@ export {cloudiot_v1} from './apis/cloudiot/v1'; export {cloudkms_v1} from './apis/cloudkms/v1'; export {cloudlocationfinder_v1} from './apis/cloudlocationfinder/v1'; export {cloudlocationfinder_v1alpha} from './apis/cloudlocationfinder/v1alpha'; +export {cloudnumberregistry_v1alpha} from './apis/cloudnumberregistry/v1alpha'; export {cloudprofiler_v2} from './apis/cloudprofiler/v2'; export {cloudresourcemanager_v1} from './apis/cloudresourcemanager/v1'; export {cloudresourcemanager_v1beta1} from './apis/cloudresourcemanager/v1beta1';