diff --git a/discovery/adsense-v2.json b/discovery/adsense-v2.json index 03d8bbd0c0..2b0ac8e119 100644 --- a/discovery/adsense-v2.json +++ b/discovery/adsense-v2.json @@ -324,7 +324,7 @@ "adunits": { "methods": { "create": { - "description": "Creates an ad unit. This method can only be used by projects enabled for the [AdSense for Platforms](https://developers.google.com/adsense/platforms/) product. Note that ad units can only be created for ad clients with an \"AFC\" product code. For more info see the [AdClient resource](/adsense/management/reference/rest/v2/accounts.adclients). For now, this method can only be used to create `DISPLAY` ad units. See: https://support.google.com/adsense/answer/9183566", + "description": "Creates an ad unit. This method can be called only by a restricted set of projects, which are usually owned by [AdSense for Platforms](https://developers.google.com/adsense/platforms/) publishers. Contact your account manager if you need to use this method. Note that ad units can only be created for ad clients with an \"AFC\" product code. For more info see the [AdClient resource](/adsense/management/reference/rest/v2/accounts.adclients). For now, this method can only be used to create `DISPLAY` ad units. See: https://support.google.com/adsense/answer/9183566", "flatPath": "v2/accounts/{accountsId}/adclients/{adclientsId}/adunits", "httpMethod": "POST", "id": "adsense.accounts.adclients.adunits.create", @@ -478,7 +478,7 @@ ] }, "patch": { - "description": "Updates an ad unit. This method can only be used by projects enabled for the [AdSense for Platforms](https://developers.google.com/adsense/platforms/) product. For now, this method can only be used to update `DISPLAY` ad units. See: https://support.google.com/adsense/answer/9183566", + "description": "Updates an ad unit. This method can be called only by a restricted set of projects, which are usually owned by [AdSense for Platforms](https://developers.google.com/adsense/platforms/) publishers. Contact your account manager if you need to use this method. For now, this method can only be used to update `DISPLAY` ad units. See: https://support.google.com/adsense/answer/9183566", "flatPath": "v2/accounts/{accountsId}/adclients/{adclientsId}/adunits/{adunitsId}", "httpMethod": "PATCH", "id": "adsense.accounts.adclients.adunits.patch", @@ -516,7 +516,7 @@ "customchannels": { "methods": { "create": { - "description": "Creates a custom channel. This method can only be used by projects enabled for the [AdSense for Platforms](https://developers.google.com/adsense/platforms/) product.", + "description": "Creates a custom channel. This method can be called only by a restricted set of projects, which are usually owned by [AdSense for Platforms](https://developers.google.com/adsense/platforms/) publishers. Contact your account manager if you need to use this method.", "flatPath": "v2/accounts/{accountsId}/adclients/{adclientsId}/customchannels", "httpMethod": "POST", "id": "adsense.accounts.adclients.customchannels.create", @@ -544,7 +544,7 @@ ] }, "delete": { - "description": "Deletes a custom channel. This method can only be used by projects enabled for the [AdSense for Platforms](https://developers.google.com/adsense/platforms/) product.", + "description": "Deletes a custom channel. This method can be called only by a restricted set of projects, which are usually owned by [AdSense for Platforms](https://developers.google.com/adsense/platforms/) publishers. Contact your account manager if you need to use this method.", "flatPath": "v2/accounts/{accountsId}/adclients/{adclientsId}/customchannels/{customchannelsId}", "httpMethod": "DELETE", "id": "adsense.accounts.adclients.customchannels.delete", @@ -669,7 +669,7 @@ ] }, "patch": { - "description": "Updates a custom channel. This method can only be used by projects enabled for the [AdSense for Platforms](https://developers.google.com/adsense/platforms/) product.", + "description": "Updates a custom channel. This method can be called only by a restricted set of projects, which are usually owned by [AdSense for Platforms](https://developers.google.com/adsense/platforms/) publishers. Contact your account manager if you need to use this method.", "flatPath": "v2/accounts/{accountsId}/adclients/{adclientsId}/customchannels/{customchannelsId}", "httpMethod": "PATCH", "id": "adsense.accounts.adclients.customchannels.patch", @@ -1845,7 +1845,7 @@ } } }, - "revision": "20240313", + "revision": "20240321", "rootUrl": "https://adsense.googleapis.com/", "schemas": { "Account": { diff --git a/discovery/aiplatform-v1.json b/discovery/aiplatform-v1.json index 07a20a825a..f7a5cca797 100644 --- a/discovery/aiplatform-v1.json +++ b/discovery/aiplatform-v1.json @@ -20,24 +20,29 @@ "documentationLink": "https://cloud.google.com/vertex-ai/", "endpoints": [ { - "endpointUrl": "https://asia-east1-aiplatform.googleapis.com/", - "location": "asia-east1", - "description": "Locational Endpoint" + "location": "africa-south1", + "description": "Locational Endpoint", + "endpointUrl": "https://africa-south1-aiplatform.googleapis.com/" }, { + "endpointUrl": "https://asia-east1-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "location": "asia-east2", - "endpointUrl": "https://asia-east2-aiplatform.googleapis.com/" + "location": "asia-east1" }, { "description": "Locational Endpoint", + "endpointUrl": "https://asia-east2-aiplatform.googleapis.com/", + "location": "asia-east2" + }, + { "endpointUrl": "https://asia-northeast1-aiplatform.googleapis.com/", + "description": "Locational Endpoint", "location": "asia-northeast1" }, { - "description": "Locational Endpoint", + "location": "asia-northeast2", "endpointUrl": "https://asia-northeast2-aiplatform.googleapis.com/", - "location": "asia-northeast2" + "description": "Locational Endpoint" }, { "endpointUrl": "https://asia-northeast3-aiplatform.googleapis.com/", @@ -45,63 +50,63 @@ "description": "Locational Endpoint" }, { - "description": "Locational Endpoint", + "endpointUrl": "https://asia-south1-aiplatform.googleapis.com/", "location": "asia-south1", - "endpointUrl": "https://asia-south1-aiplatform.googleapis.com/" + "description": "Locational Endpoint" }, { - "endpointUrl": "https://asia-southeast1-aiplatform.googleapis.com/", + "description": "Locational Endpoint", "location": "asia-southeast1", - "description": "Locational Endpoint" + "endpointUrl": "https://asia-southeast1-aiplatform.googleapis.com/" }, { + "location": "asia-southeast2", "endpointUrl": "https://asia-southeast2-aiplatform.googleapis.com/", - "description": "Locational Endpoint", - "location": "asia-southeast2" + "description": "Locational Endpoint" }, { - "endpointUrl": "https://australia-southeast1-aiplatform.googleapis.com/", "description": "Locational Endpoint", + "endpointUrl": "https://australia-southeast1-aiplatform.googleapis.com/", "location": "australia-southeast1" }, { - "location": "australia-southeast2", "endpointUrl": "https://australia-southeast2-aiplatform.googleapis.com/", + "location": "australia-southeast2", "description": "Locational Endpoint" }, { + "location": "europe-central2", "description": "Locational Endpoint", - "endpointUrl": "https://europe-central2-aiplatform.googleapis.com/", - "location": "europe-central2" + "endpointUrl": "https://europe-central2-aiplatform.googleapis.com/" }, { - "description": "Locational Endpoint", + "location": "europe-north1", "endpointUrl": "https://europe-north1-aiplatform.googleapis.com/", - "location": "europe-north1" + "description": "Locational Endpoint" }, { + "location": "europe-southwest1", "description": "Locational Endpoint", - "endpointUrl": "https://europe-southwest1-aiplatform.googleapis.com/", - "location": "europe-southwest1" + "endpointUrl": "https://europe-southwest1-aiplatform.googleapis.com/" }, { "endpointUrl": "https://europe-west1-aiplatform.googleapis.com/", - "location": "europe-west1", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "europe-west1" }, { - "location": "europe-west2", + "description": "Locational Endpoint", "endpointUrl": "https://europe-west2-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "europe-west2" }, { - "endpointUrl": "https://europe-west3-aiplatform.googleapis.com/", + "description": "Locational Endpoint", "location": "europe-west3", - "description": "Locational Endpoint" + "endpointUrl": "https://europe-west3-aiplatform.googleapis.com/" }, { - "description": "Locational Endpoint", "endpointUrl": "https://europe-west4-aiplatform.googleapis.com/", + "description": "Locational Endpoint", "location": "europe-west4" }, { @@ -116,8 +121,23 @@ }, { "location": "europe-west9", - "endpointUrl": "https://europe-west9-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "endpointUrl": "https://europe-west9-aiplatform.googleapis.com/" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://europe-west12-aiplatform.googleapis.com/", + "location": "europe-west12" + }, + { + "endpointUrl": "https://me-central1-aiplatform.googleapis.com/", + "description": "Locational Endpoint", + "location": "me-central1" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://me-central2-aiplatform.googleapis.com/", + "location": "me-central2" }, { "description": "Locational Endpoint", @@ -125,49 +145,49 @@ "location": "me-west1" }, { - "endpointUrl": "https://northamerica-northeast1-aiplatform.googleapis.com/", "location": "northamerica-northeast1", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "endpointUrl": "https://northamerica-northeast1-aiplatform.googleapis.com/" }, { "description": "Locational Endpoint", - "location": "northamerica-northeast2", - "endpointUrl": "https://northamerica-northeast2-aiplatform.googleapis.com/" + "endpointUrl": "https://northamerica-northeast2-aiplatform.googleapis.com/", + "location": "northamerica-northeast2" }, { - "endpointUrl": "https://southamerica-east1-aiplatform.googleapis.com/", + "description": "Locational Endpoint", "location": "southamerica-east1", - "description": "Locational Endpoint" + "endpointUrl": "https://southamerica-east1-aiplatform.googleapis.com/" }, { - "description": "Locational Endpoint", "endpointUrl": "https://southamerica-west1-aiplatform.googleapis.com/", - "location": "southamerica-west1" + "location": "southamerica-west1", + "description": "Locational Endpoint" }, { - "location": "us-central1", "description": "Locational Endpoint", - "endpointUrl": "https://us-central1-aiplatform.googleapis.com/" + "endpointUrl": "https://us-central1-aiplatform.googleapis.com/", + "location": "us-central1" }, { - "description": "Locational Endpoint", + "location": "us-central2", "endpointUrl": "https://us-central2-aiplatform.googleapis.com/", - "location": "us-central2" + "description": "Locational Endpoint" }, { + "endpointUrl": "https://us-east1-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "location": "us-east1", - "endpointUrl": "https://us-east1-aiplatform.googleapis.com/" + "location": "us-east1" }, { "endpointUrl": "https://us-east4-aiplatform.googleapis.com/", - "location": "us-east4", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "us-east4" }, { - "endpointUrl": "https://us-south1-aiplatform.googleapis.com/", "location": "us-south1", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "endpointUrl": "https://us-south1-aiplatform.googleapis.com/" }, { "location": "us-west1", @@ -176,8 +196,8 @@ }, { "location": "us-west2", - "endpointUrl": "https://us-west2-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "endpointUrl": "https://us-west2-aiplatform.googleapis.com/" }, { "description": "Locational Endpoint", @@ -185,9 +205,14 @@ "location": "us-west3" }, { - "location": "us-west4", "endpointUrl": "https://us-west4-aiplatform.googleapis.com/", + "location": "us-west4", "description": "Locational Endpoint" + }, + { + "location": "us-east5", + "description": "Locational Endpoint", + "endpointUrl": "https://us-east5-aiplatform.googleapis.com/" } ], "fullyEncodeReservedExpansion": true, @@ -3217,7 +3242,7 @@ ], "parameters": { "filter": { - "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports = and !=. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports = and, != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `base_model_name` only supports = Some examples: * `endpoint=1` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `baseModelName=\"text-bison\"`", + "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports `=` and `!=`. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports `=` and `!=`. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:*` or `labels:key` - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `base_model_name` only supports `=`. Some examples: * `endpoint=1` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `baseModelName=\"text-bison\"`", "location": "query", "type": "string" }, @@ -11367,7 +11392,7 @@ ], "parameters": { "filter": { - "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * `notebookRuntime=\"notebookRuntime123\"` * `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"` * `notebookRuntimeTemplate=\"notebookRuntimeTemplate321\"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser=\"test@google.com\"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED`", + "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * `notebookRuntime=\"notebookRuntime123\"` * `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"` * `notebookRuntimeTemplate=\"notebookRuntimeTemplate321\"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser=\"test@google.com\"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED`", "location": "query", "type": "string" }, @@ -11618,6 +11643,344 @@ } } }, + "persistentResources": { + "methods": { + "create": { + "description": "Creates a PersistentResource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.persistentResources.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the PersistentResource in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "persistentResourceId": { + "description": "Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/persistentResources", + "request": { + "$ref": "GoogleCloudAiplatformV1PersistentResource" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a PersistentResource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.persistentResources.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the PersistentResource to be deleted. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a PersistentResource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.persistentResources.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1PersistentResource" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists PersistentResources in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.persistentResources.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token. Typically obtained via ListPersistentResourceResponse.next_page_token of the previous PersistentResourceService.ListPersistentResource call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list the PersistentResources from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/persistentResources", + "response": { + "$ref": "GoogleCloudAiplatformV1ListPersistentResourcesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a PersistentResource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.persistentResources.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Resource name of a PersistentResource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Specify the fields to be overwritten in the PersistentResource by the update method.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1PersistentResource" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "reboot": { + "description": "Reboots a PersistentResource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}:reboot", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.persistentResources.reboot", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:reboot", + "request": { + "$ref": "GoogleCloudAiplatformV1RebootPersistentResourceRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.persistentResources.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.persistentResources.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.persistentResources.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.persistentResources.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/[^/]+/persistentResources/[^/]+$", + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.persistentResources.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "pipelineJobs": { "methods": { "batchCancel": { @@ -15676,7 +16039,7 @@ } } }, - "revision": "20240312", + "revision": "20240320", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionEmbedVideoResponse": { @@ -18567,6 +18930,21 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1CreatePersistentResourceOperationMetadata": { + "description": "Details of operations that perform create PersistentResource.", + "id": "GoogleCloudAiplatformV1CreatePersistentResourceOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Operation metadata for PersistentResource." + }, + "progressMessage": { + "description": "Progress Message for Create LRO", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1CreatePipelineJobRequest": { "description": "Request message for PipelineService.CreatePipelineJob.", "id": "GoogleCloudAiplatformV1CreatePipelineJobRequest", @@ -18815,6 +19193,10 @@ "description": "Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network.", "type": "string" }, + "persistentResourceId": { + "description": "Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected.", + "type": "string" + }, "protectedArtifactLocationId": { "description": "The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations", "type": "string" @@ -19790,10 +20172,6 @@ "$ref": "GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig", "description": "Configures the request-response logging for online prediction." }, - "privateServiceConnectConfig": { - "$ref": "GoogleCloudAiplatformV1PrivateServiceConnectConfig", - "description": "Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive." - }, "trafficSplit": { "additionalProperties": { "format": "int32", @@ -21845,6 +22223,10 @@ "description": "Response message for FeatureOnlineStoreService.FetchFeatureValues", "id": "GoogleCloudAiplatformV1FetchFeatureValuesResponse", "properties": { + "dataKey": { + "$ref": "GoogleCloudAiplatformV1FeatureViewDataKey", + "description": "The data key associated with this response. Will only be populated for FeatureOnlineStoreService.StreamingFetchFeatureValues RPCs." + }, "keyValues": { "$ref": "GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList", "description": "Feature values in KeyValue format." @@ -22074,12 +22456,12 @@ "type": "string" }, "name": { - "description": "Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.", + "description": "Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64.", "type": "string" }, "parameters": { "$ref": "GoogleCloudAiplatformV1Schema", - "description": "Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1" + "description": "Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1" } }, "type": "object" @@ -22321,6 +22703,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1GoogleSearchRetrieval": { + "description": "Tool to retrieve public web data for grounding, powered by Google.", + "id": "GoogleCloudAiplatformV1GoogleSearchRetrieval", + "properties": { + "disableAttribution": { + "description": "Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1GroundingAttribution": { "description": "Grounding attribution.", "id": "GoogleCloudAiplatformV1GroundingAttribution", @@ -23790,6 +24183,23 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1ListPersistentResourcesResponse": { + "description": "Response message for PersistentResourceService.ListPersistentResources", + "id": "GoogleCloudAiplatformV1ListPersistentResourcesResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve next page of results. Pass to ListPersistentResourcesRequest.page_token to obtain that page.", + "type": "string" + }, + "persistentResources": { + "items": { + "$ref": "GoogleCloudAiplatformV1PersistentResource" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1ListPipelineJobsResponse": { "description": "Response message for PipelineService.ListPipelineJobs", "id": "GoogleCloudAiplatformV1ListPipelineJobsResponse", @@ -26431,7 +26841,9 @@ "BEING_STARTED", "BEING_STOPPED", "STOPPED", - "BEING_UPGRADED" + "BEING_UPGRADED", + "ERROR", + "INVALID" ], "enumDescriptions": [ "Unspecified runtime state.", @@ -26439,7 +26851,9 @@ "NotebookRuntime is in starting state.", "NotebookRuntime is in stopping state.", "NotebookRuntime is in stopped state.", - "NotebookRuntime is in upgrading state. It is in the middle of upgrading process." + "NotebookRuntime is in upgrading state. It is in the middle of upgrading process.", + "NotebookRuntime was unable to start/stop properly.", + "NotebookRuntime is in invalid state. Cannot be recovered." ], "readOnly": true, "type": "string" @@ -26638,6 +27052,103 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1PersistentResource": { + "description": "Represents long-lasting resources that are dedicated to users to runs custom workloads. A PersistentResource can have multiple node pools and each node pool can have its own machine spec.", + "id": "GoogleCloudAiplatformV1PersistentResource", + "properties": { + "createTime": { + "description": "Output only. Time when the PersistentResource was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. The display name of the PersistentResource. The name can be up to 128 characters long and can consist of any UTF-8 characters.", + "type": "string" + }, + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1EncryptionSpec", + "description": "Optional. Customer-managed encryption key spec for a PersistentResource. If set, this PersistentResource and all sub-resources of this PersistentResource will be secured by this key." + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. Only populated when persistent resource's state is `STOPPING` or `ERROR`.", + "readOnly": true + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The labels with user-defined metadata to organize PersistentResource. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.", + "type": "object" + }, + "name": { + "description": "Immutable. Resource name of a PersistentResource.", + "type": "string" + }, + "network": { + "description": "Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network.", + "type": "string" + }, + "reservedIpRanges": { + "description": "Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].", + "items": { + "type": "string" + }, + "type": "array" + }, + "resourcePools": { + "description": "Required. The spec of the pools of different resources.", + "items": { + "$ref": "GoogleCloudAiplatformV1ResourcePool" + }, + "type": "array" + }, + "resourceRuntime": { + "$ref": "GoogleCloudAiplatformV1ResourceRuntime", + "description": "Output only. Runtime information of the Persistent Resource.", + "readOnly": true + }, + "resourceRuntimeSpec": { + "$ref": "GoogleCloudAiplatformV1ResourceRuntimeSpec", + "description": "Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration." + }, + "startTime": { + "description": "Output only. Time when the PersistentResource for the first time entered the `RUNNING` state.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The detailed state of a Study.", + "enum": [ + "STATE_UNSPECIFIED", + "PROVISIONING", + "RUNNING", + "STOPPING", + "ERROR", + "UPDATING" + ], + "enumDescriptions": [ + "Not set.", + "The PROVISIONING state indicates the persistent resources is being created.", + "The RUNNING state indicates the persistent resource is healthy and fully usable.", + "The STOPPING state indicates the persistent resource is being deleted.", + "The ERROR state indicates the persistent resource may be unusable. Details can be found in the `error` field.", + "The UPDATING state indicates the persistent resource is being updated." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Time when the PersistentResource was most recently updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1PipelineJob": { "description": "An instance of a machine learning PipelineJob.", "id": "GoogleCloudAiplatformV1PipelineJob", @@ -27460,6 +27971,10 @@ "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke", "description": "Optional. Deploy PublisherModel to Google Kubernetes Engine." }, + "multiDeployVertex": { + "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex", + "description": "Optional. Multiple setups to deploy the PublisherModel to Vertex Endpoint." + }, "openEvaluationPipeline": { "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences", "description": "Optional. Open evaluation pipeline of the PublisherModel." @@ -27560,6 +28075,20 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex": { + "description": "Multiple setups to deploy the PublisherModel.", + "id": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex", + "properties": { + "multiDeployVertex": { + "description": "Optional. One click deployment configurations.", + "items": { + "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionDeploy" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines": { "description": "Open fine tuning pipelines.", "id": "GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines", @@ -27894,6 +28423,43 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1RayMetricSpec": { + "description": "Configuration for the Ray metrics.", + "id": "GoogleCloudAiplatformV1RayMetricSpec", + "properties": { + "disabled": { + "description": "Optional. Flag to disable the Ray metrics collection.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RaySpec": { + "description": "Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes.", + "id": "GoogleCloudAiplatformV1RaySpec", + "properties": { + "headNodeResourcePoolId": { + "description": "Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set.", + "type": "string" + }, + "imageUri": { + "description": "Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field.", + "type": "string" + }, + "rayMetricSpec": { + "$ref": "GoogleCloudAiplatformV1RayMetricSpec", + "description": "Optional. Ray metrics configurations." + }, + "resourcePoolImages": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Required if image_uri isn't set. A map of resource_pool_id to prebuild Ray image if user need to use different images for different head/worker pools. This map needs to cover all the resource pool ids. Example: { \"ray_head_node_pool\": \"head image\" \"ray_worker_node_pool1\": \"worker image\" \"ray_worker_node_pool2\": \"another worker image\" }", + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1ReadFeatureValuesRequest": { "description": "Request message for FeaturestoreOnlineServingService.ReadFeatureValues.", "id": "GoogleCloudAiplatformV1ReadFeatureValuesRequest", @@ -28099,6 +28665,27 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata": { + "description": "Details of operations that perform reboot PersistentResource.", + "id": "GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Operation metadata for PersistentResource." + }, + "progressMessage": { + "description": "Progress Message for Reboot LRO", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RebootPersistentResourceRequest": { + "description": "Request message for PersistentResourceService.RebootPersistentResource.", + "id": "GoogleCloudAiplatformV1RebootPersistentResourceRequest", + "properties": {}, + "type": "object" + }, "GoogleCloudAiplatformV1RemoveContextChildrenRequest": { "description": "Request message for MetadataService.DeleteContextChildrenRequest.", "id": "GoogleCloudAiplatformV1RemoveContextChildrenRequest", @@ -28139,6 +28726,92 @@ "properties": {}, "type": "object" }, + "GoogleCloudAiplatformV1ResourcePool": { + "description": "Represents the spec of a group of resources of the same type, for example machine type, disk, and accelerators, in a PersistentResource.", + "id": "GoogleCloudAiplatformV1ResourcePool", + "properties": { + "autoscalingSpec": { + "$ref": "GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec", + "description": "Optional. Optional spec to configure GKE autoscaling" + }, + "diskSpec": { + "$ref": "GoogleCloudAiplatformV1DiskSpec", + "description": "Optional. Disk spec for the machine in this node pool." + }, + "id": { + "description": "Immutable. The unique ID in a PersistentResource for referring to this resource pool. User can specify it if necessary. Otherwise, it's generated automatically.", + "type": "string" + }, + "machineSpec": { + "$ref": "GoogleCloudAiplatformV1MachineSpec", + "description": "Required. Immutable. The specification of a single machine." + }, + "replicaCount": { + "description": "Optional. The total number of machines to use for this resource pool.", + "format": "int64", + "type": "string" + }, + "usedReplicaCount": { + "description": "Output only. The number of machines currently in use by training jobs for this resource pool. Will replace idle_replica_count.", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec": { + "description": "The min/max number of replicas allowed if enabling autoscaling", + "id": "GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec", + "properties": { + "maxReplicaCount": { + "description": "Optional. max replicas in the node pool, must be ≥ replica_count and > min_replica_count or will throw error", + "format": "int64", + "type": "string" + }, + "minReplicaCount": { + "description": "Optional. min replicas in the node pool, must be ≤ replica_count and < max_replica_count or will throw error", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ResourceRuntime": { + "description": "Persistent Cluster runtime information as output", + "id": "GoogleCloudAiplatformV1ResourceRuntime", + "properties": { + "accessUris": { + "additionalProperties": { + "type": "string" + }, + "description": "Output only. URIs for user to connect to the Cluster. Example: { \"RAY_HEAD_NODE_INTERNAL_IP\": \"head-node-IP:10001\" \"RAY_DASHBOARD_URI\": \"ray-dashboard-address:8888\" }", + "readOnly": true, + "type": "object" + }, + "notebookRuntimeTemplate": { + "description": "Output only. The resource name of NotebookRuntimeTemplate for the RoV Persistent Cluster The NotebokRuntimeTemplate is created in the same VPC (if set), and with the same Ray and Python version as the Persistent Cluster. Example: \"projects/1000/locations/us-central1/notebookRuntimeTemplates/abc123\"", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ResourceRuntimeSpec": { + "description": "Configuration for the runtime on a PersistentResource instance, including but not limited to: * Service accounts used to run the workloads. * Whether to make it a dedicated Ray Cluster.", + "id": "GoogleCloudAiplatformV1ResourceRuntimeSpec", + "properties": { + "raySpec": { + "$ref": "GoogleCloudAiplatformV1RaySpec", + "description": "Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource." + }, + "serviceAccountSpec": { + "$ref": "GoogleCloudAiplatformV1ServiceAccountSpec", + "description": "Optional. Configure the use of workload identity on the PersistentResource" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1ResourcesConsumed": { "description": "Statistics information about resource consumption.", "id": "GoogleCloudAiplatformV1ResourcesConsumed", @@ -28180,6 +28853,21 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1Retrieval": { + "description": "Defines a retrieval tool that model can call to access external knowledge.", + "id": "GoogleCloudAiplatformV1Retrieval", + "properties": { + "disableAttribution": { + "description": "Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.", + "type": "boolean" + }, + "vertexAiSearch": { + "$ref": "GoogleCloudAiplatformV1VertexAISearch", + "description": "Set to use data source powered by Vertex AI Search." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1SafetyRating": { "description": "Safety rating corresponding to the generated content.", "id": "GoogleCloudAiplatformV1SafetyRating", @@ -28283,6 +28971,20 @@ ], "type": "string" }, + "method": { + "description": "Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.", + "enum": [ + "HARM_BLOCK_METHOD_UNSPECIFIED", + "SEVERITY", + "PROBABILITY" + ], + "enumDescriptions": [ + "The harm block method is unspecified.", + "The harm block method uses both probability and severity scores.", + "The harm block method uses the probability score." + ], + "type": "string" + }, "threshold": { "description": "Required. The harm block threshold.", "enum": [ @@ -28586,6 +29288,10 @@ "description": "Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed.", "id": "GoogleCloudAiplatformV1Schema", "properties": { + "default": { + "description": "Optional. Default value of the data.", + "type": "any" + }, "description": { "description": "Optional. The description of the data.", "type": "string" @@ -28602,22 +29308,66 @@ "type": "any" }, "format": { - "description": "Optional. The format of the data. Supported formats: for NUMBER type: float, double for INTEGER type: int32, int64", + "description": "Optional. The format of the data. Supported formats: for NUMBER type: \"float\", \"double\" for INTEGER type: \"int32\", \"int64\" for STRING type: \"email\", \"byte\", etc", "type": "string" }, "items": { "$ref": "GoogleCloudAiplatformV1Schema", - "description": "Optional. Schema of the elements of Type.ARRAY." + "description": "Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY." + }, + "maxItems": { + "description": "Optional. Maximum number of the elements for Type.ARRAY.", + "format": "int64", + "type": "string" + }, + "maxLength": { + "description": "Optional. Maximum length of the Type.STRING", + "format": "int64", + "type": "string" + }, + "maxProperties": { + "description": "Optional. Maximum number of the properties for Type.OBJECT.", + "format": "int64", + "type": "string" + }, + "maximum": { + "description": "Optional. Maximum value of the Type.INTEGER and Type.NUMBER", + "format": "double", + "type": "number" + }, + "minItems": { + "description": "Optional. Minimum number of the elements for Type.ARRAY.", + "format": "int64", + "type": "string" + }, + "minLength": { + "description": "Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING", + "format": "int64", + "type": "string" + }, + "minProperties": { + "description": "Optional. Minimum number of the properties for Type.OBJECT.", + "format": "int64", + "type": "string" + }, + "minimum": { + "description": "Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER", + "format": "double", + "type": "number" }, "nullable": { "description": "Optional. Indicates if the value may be null.", "type": "boolean" }, + "pattern": { + "description": "Optional. Pattern of the Type.STRING to restrict a string to a regular expression.", + "type": "string" + }, "properties": { "additionalProperties": { "$ref": "GoogleCloudAiplatformV1Schema" }, - "description": "Optional. Properties of Type.OBJECT.", + "description": "Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.", "type": "object" }, "required": { @@ -28627,6 +29377,10 @@ }, "type": "array" }, + "title": { + "description": "Optional. The title of the Schema.", + "type": "string" + }, "type": { "description": "Optional. The type of the data.", "enum": [ @@ -32556,6 +33310,21 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1ServiceAccountSpec": { + "description": "Configuration for the use of custom service account to run the workloads.", + "id": "GoogleCloudAiplatformV1ServiceAccountSpec", + "properties": { + "enableCustomServiceAccount": { + "description": "Required. If true, custom user-managed service account is enforced to run any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).", + "type": "boolean" + }, + "serviceAccount": { + "description": "Optional. Default service account that this PersistentResource's workloads run as. The workloads include: * Any runtime specified via `ResourceRuntimeSpec` on creation time, for example, Ray. * Jobs submitted to PersistentResource, if no other service account specified in the job specs. Only works when custom service account is enabled and users have the `iam.serviceAccounts.actAs` permission on this service account. Required if any containers are specified in `ResourceRuntimeSpec`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1ShieldedVmConfig": { "description": "A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm).", "id": "GoogleCloudAiplatformV1ShieldedVmConfig", @@ -33916,6 +34685,14 @@ "$ref": "GoogleCloudAiplatformV1FunctionDeclaration" }, "type": "array" + }, + "googleSearchRetrieval": { + "$ref": "GoogleCloudAiplatformV1GoogleSearchRetrieval", + "description": "Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search." + }, + "retrieval": { + "$ref": "GoogleCloudAiplatformV1Retrieval", + "description": "Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation." } }, "type": "object" @@ -34376,6 +35153,21 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1UpdatePersistentResourceOperationMetadata": { + "description": "Details of operations that perform update PersistentResource.", + "id": "GoogleCloudAiplatformV1UpdatePersistentResourceOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Operation metadata for PersistentResource." + }, + "progressMessage": { + "description": "Progress Message for Update LRO", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1UpdateSpecialistPoolOperationMetadata": { "description": "Runtime operation metadata for SpecialistPoolService.UpdateSpecialistPool.", "id": "GoogleCloudAiplatformV1UpdateSpecialistPoolOperationMetadata", @@ -34539,6 +35331,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1VertexAISearch": { + "description": "Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation", + "id": "GoogleCloudAiplatformV1VertexAISearch", + "properties": { + "datastore": { + "description": "Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1VideoMetadata": { "description": "Metadata describes the input video content.", "id": "GoogleCloudAiplatformV1VideoMetadata", @@ -35285,6 +36088,8 @@ "DUET_GOOGLESQL_GENERATION", "DUET_CLOUD_IX_PROMPTS", "DUET_RAD", + "DUET_STACKOVERFLOW_ISSUES", + "DUET_STACKOVERFLOW_ANSWERS", "BARD_ARCADE_GITHUB", "MOBILE_ASSISTANT_MAGI_FILTERED_0825_373K", "MOBILE_ASSISTANT_PALM24B_FILTERED_400K", @@ -35610,6 +36415,8 @@ "", "", "", + "", + "", "Bard ARCADE finetune dataset.", "Mobile assistant finetune datasets.", "", @@ -36049,6 +36856,8 @@ "DUET_GOOGLESQL_GENERATION", "DUET_CLOUD_IX_PROMPTS", "DUET_RAD", + "DUET_STACKOVERFLOW_ISSUES", + "DUET_STACKOVERFLOW_ANSWERS", "BARD_ARCADE_GITHUB", "MOBILE_ASSISTANT_MAGI_FILTERED_0825_373K", "MOBILE_ASSISTANT_PALM24B_FILTERED_400K", @@ -36374,6 +37183,8 @@ "", "", "", + "", + "", "Bard ARCADE finetune dataset.", "Mobile assistant finetune datasets.", "", @@ -36824,6 +37635,8 @@ "DUET_GOOGLESQL_GENERATION", "DUET_CLOUD_IX_PROMPTS", "DUET_RAD", + "DUET_STACKOVERFLOW_ISSUES", + "DUET_STACKOVERFLOW_ANSWERS", "BARD_ARCADE_GITHUB", "MOBILE_ASSISTANT_MAGI_FILTERED_0825_373K", "MOBILE_ASSISTANT_PALM24B_FILTERED_400K", @@ -37149,6 +37962,8 @@ "", "", "", + "", + "", "Bard ARCADE finetune dataset", "Mobile assistant finetune datasets.", "", @@ -37588,6 +38403,8 @@ "DUET_GOOGLESQL_GENERATION", "DUET_CLOUD_IX_PROMPTS", "DUET_RAD", + "DUET_STACKOVERFLOW_ISSUES", + "DUET_STACKOVERFLOW_ANSWERS", "BARD_ARCADE_GITHUB", "MOBILE_ASSISTANT_MAGI_FILTERED_0825_373K", "MOBILE_ASSISTANT_PALM24B_FILTERED_400K", @@ -37913,6 +38730,8 @@ "", "", "", + "", + "", "Bard ARCADE finetune dataset", "Mobile assistant finetune datasets.", "", @@ -38605,7 +39424,7 @@ "id": "LearningGenaiRootGroundingMetadataCitation", "properties": { "endIndex": { - "description": "Index in the prediction output where the citation ends (exclusive). Must be > start_index and < len(output).", + "description": "Index in the prediction output where the citation ends (exclusive). Must be > start_index and <= len(output).", "format": "int32", "type": "integer" }, @@ -39395,14 +40214,16 @@ "RETURN", "STOP", "MAX_TOKENS", - "FILTER" + "FILTER", + "TOP_N_FILTERED" ], "enumDescriptions": [ "", "Return all the tokens back. This typically implies no filtering or stop sequence was triggered.", "Finished due to provided stop sequence.", "Model has emitted the maximum number of tokens as specified by max_decoding_steps.", - "Finished due to triggering some post-processing filter." + "Finished due to triggering some post-processing filter.", + "Filtered out due to Top_N < Response_Candidates.Size()" ], "type": "string" }, diff --git a/discovery/aiplatform-v1beta1.json b/discovery/aiplatform-v1beta1.json index 7279b385ea..637686fb10 100644 --- a/discovery/aiplatform-v1beta1.json +++ b/discovery/aiplatform-v1beta1.json @@ -20,34 +20,39 @@ "documentationLink": "https://cloud.google.com/vertex-ai/", "endpoints": [ { - "endpointUrl": "https://asia-east1-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "location": "asia-east1" + "location": "africa-south1", + "endpointUrl": "https://africa-south1-aiplatform.googleapis.com/" + }, + { + "location": "asia-east1", + "endpointUrl": "https://asia-east1-aiplatform.googleapis.com/", + "description": "Locational Endpoint" }, { "description": "Locational Endpoint", - "location": "asia-east2", - "endpointUrl": "https://asia-east2-aiplatform.googleapis.com/" + "endpointUrl": "https://asia-east2-aiplatform.googleapis.com/", + "location": "asia-east2" }, { - "endpointUrl": "https://asia-northeast1-aiplatform.googleapis.com/", + "location": "asia-northeast1", "description": "Locational Endpoint", - "location": "asia-northeast1" + "endpointUrl": "https://asia-northeast1-aiplatform.googleapis.com/" }, { "location": "asia-northeast2", - "endpointUrl": "https://asia-northeast2-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "endpointUrl": "https://asia-northeast2-aiplatform.googleapis.com/" }, { + "description": "Locational Endpoint", "endpointUrl": "https://asia-northeast3-aiplatform.googleapis.com/", - "location": "asia-northeast3", - "description": "Locational Endpoint" + "location": "asia-northeast3" }, { - "description": "Locational Endpoint", + "endpointUrl": "https://asia-south1-aiplatform.googleapis.com/", "location": "asia-south1", - "endpointUrl": "https://asia-south1-aiplatform.googleapis.com/" + "description": "Locational Endpoint" }, { "endpointUrl": "https://asia-southeast1-aiplatform.googleapis.com/", @@ -56,13 +61,13 @@ }, { "endpointUrl": "https://asia-southeast2-aiplatform.googleapis.com/", - "description": "Locational Endpoint", - "location": "asia-southeast2" + "location": "asia-southeast2", + "description": "Locational Endpoint" }, { - "endpointUrl": "https://australia-southeast1-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "location": "australia-southeast1" + "location": "australia-southeast1", + "endpointUrl": "https://australia-southeast1-aiplatform.googleapis.com/" }, { "location": "australia-southeast2", @@ -70,49 +75,49 @@ "endpointUrl": "https://australia-southeast2-aiplatform.googleapis.com/" }, { - "description": "Locational Endpoint", + "endpointUrl": "https://europe-central2-aiplatform.googleapis.com/", "location": "europe-central2", - "endpointUrl": "https://europe-central2-aiplatform.googleapis.com/" + "description": "Locational Endpoint" }, { "description": "Locational Endpoint", - "location": "europe-north1", - "endpointUrl": "https://europe-north1-aiplatform.googleapis.com/" + "endpointUrl": "https://europe-north1-aiplatform.googleapis.com/", + "location": "europe-north1" }, { - "endpointUrl": "https://europe-southwest1-aiplatform.googleapis.com/", "description": "Locational Endpoint", + "endpointUrl": "https://europe-southwest1-aiplatform.googleapis.com/", "location": "europe-southwest1" }, { "location": "europe-west1", - "description": "Locational Endpoint", - "endpointUrl": "https://europe-west1-aiplatform.googleapis.com/" + "endpointUrl": "https://europe-west1-aiplatform.googleapis.com/", + "description": "Locational Endpoint" }, { + "endpointUrl": "https://europe-west2-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "location": "europe-west2", - "endpointUrl": "https://europe-west2-aiplatform.googleapis.com/" + "location": "europe-west2" }, { - "location": "europe-west3", "description": "Locational Endpoint", + "location": "europe-west3", "endpointUrl": "https://europe-west3-aiplatform.googleapis.com/" }, { - "endpointUrl": "https://europe-west4-aiplatform.googleapis.com/", "location": "europe-west4", + "endpointUrl": "https://europe-west4-aiplatform.googleapis.com/", "description": "Locational Endpoint" }, { - "description": "Locational Endpoint", "location": "europe-west6", + "description": "Locational Endpoint", "endpointUrl": "https://europe-west6-aiplatform.googleapis.com/" }, { - "endpointUrl": "https://europe-west8-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "location": "europe-west8" + "location": "europe-west8", + "endpointUrl": "https://europe-west8-aiplatform.googleapis.com/" }, { "endpointUrl": "https://europe-west9-aiplatform.googleapis.com/", @@ -120,23 +125,38 @@ "location": "europe-west9" }, { - "location": "me-west1", - "endpointUrl": "https://me-west1-aiplatform.googleapis.com/", + "description": "Locational Endpoint", + "location": "europe-west12", + "endpointUrl": "https://europe-west12-aiplatform.googleapis.com/" + }, + { + "location": "me-central1", + "endpointUrl": "https://me-central1-aiplatform.googleapis.com/", "description": "Locational Endpoint" }, + { + "endpointUrl": "https://me-central2-aiplatform.googleapis.com/", + "description": "Locational Endpoint", + "location": "me-central2" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://me-west1-aiplatform.googleapis.com/", + "location": "me-west1" + }, { "location": "northamerica-northeast1", - "endpointUrl": "https://northamerica-northeast1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "endpointUrl": "https://northamerica-northeast1-aiplatform.googleapis.com/" }, { - "endpointUrl": "https://northamerica-northeast2-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "location": "northamerica-northeast2" + "location": "northamerica-northeast2", + "endpointUrl": "https://northamerica-northeast2-aiplatform.googleapis.com/" }, { - "location": "southamerica-east1", "description": "Locational Endpoint", + "location": "southamerica-east1", "endpointUrl": "https://southamerica-east1-aiplatform.googleapis.com/" }, { @@ -145,29 +165,29 @@ "endpointUrl": "https://southamerica-west1-aiplatform.googleapis.com/" }, { - "location": "us-central1", "endpointUrl": "https://us-central1-aiplatform.googleapis.com/", + "location": "us-central1", "description": "Locational Endpoint" }, { - "endpointUrl": "https://us-central2-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "location": "us-central2" + "location": "us-central2", + "endpointUrl": "https://us-central2-aiplatform.googleapis.com/" }, { - "endpointUrl": "https://us-east1-aiplatform.googleapis.com/", "description": "Locational Endpoint", + "endpointUrl": "https://us-east1-aiplatform.googleapis.com/", "location": "us-east1" }, { + "endpointUrl": "https://us-east4-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "location": "us-east4", - "endpointUrl": "https://us-east4-aiplatform.googleapis.com/" + "location": "us-east4" }, { "endpointUrl": "https://us-south1-aiplatform.googleapis.com/", - "location": "us-south1", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "us-south1" }, { "description": "Locational Endpoint", @@ -175,19 +195,24 @@ "location": "us-west1" }, { + "location": "us-west2", "endpointUrl": "https://us-west2-aiplatform.googleapis.com/", - "description": "Locational Endpoint", - "location": "us-west2" + "description": "Locational Endpoint" }, { - "description": "Locational Endpoint", "endpointUrl": "https://us-west3-aiplatform.googleapis.com/", + "description": "Locational Endpoint", "location": "us-west3" }, { - "endpointUrl": "https://us-west4-aiplatform.googleapis.com/", + "description": "Locational Endpoint", "location": "us-west4", - "description": "Locational Endpoint" + "endpointUrl": "https://us-west4-aiplatform.googleapis.com/" + }, + { + "endpointUrl": "https://us-east5-aiplatform.googleapis.com/", + "description": "Locational Endpoint", + "location": "us-east5" } ], "fullyEncodeReservedExpansion": true, @@ -3403,7 +3428,7 @@ ], "parameters": { "filter": { - "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports = and !=. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports = and, != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `base_model_name` only supports = Some examples: * `endpoint=1` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `baseModelName=\"text-bison\"`", + "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports `=` and `!=`. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports `=` and `!=`. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:*` or `labels:key` - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `base_model_name` only supports `=`. Some examples: * `endpoint=1` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `baseModelName=\"text-bison\"`", "location": "query", "type": "string" }, @@ -4297,6 +4322,222 @@ } }, "extensions": { + "methods": { + "delete": { + "description": "Deletes an Extension.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.extensions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Extension resource to be deleted. Format: `projects/{project}/locations/{location}/extensions/{extension}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "execute": { + "description": "Executes the request against a given extension.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}:execute", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.extensions.execute", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name (identifier) of the extension; Format: `projects/{project}/locations/{location}/extensions/{extension}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:execute", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ExecuteExtensionRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ExecuteExtensionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an Extension.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.extensions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Extension resource. Format: `projects/{project}/locations/{location}/extensions/{extension}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Extension" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "import": { + "description": "Imports an Extension.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions:import", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.extensions.import", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to import the Extension in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/extensions:import", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Extension" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Extensions in a location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.extensions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The standard list filter. Supported fields: * `display_name` * `create_time` * `update_time` More detail in [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list the Extensions from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/extensions", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListExtensionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an Extension.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.extensions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the Extension.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `tool_use_examples`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Extension" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Extension" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "query": { + "description": "Queries an extension with a default controller.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}:query", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.extensions.query", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name (identifier) of the extension; Format: `projects/{project}/locations/{location}/extensions/{extension}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:query", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1QueryExtensionRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1QueryExtensionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "deployments": { "resources": { @@ -5760,6 +6001,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "streamingFetchFeatureValues": { + "description": "Bidirectional streaming RPC to fetch feature values under a FeatureView. Requests may not have a one-to-one mapping to responses and responses may be returned out-of-order to reduce latency.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:streamingFetchFeatureValues", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.streamingFetchFeatureValues", + "parameterOrder": [ + "featureView" + ], + "parameters": { + "featureView": { + "description": "Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+featureView}:streamingFetchFeatureValues", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "sync": { "description": "Triggers on-demand sync for the FeatureView.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:sync", @@ -12741,7 +13010,7 @@ ], "parameters": { "filter": { - "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * `notebookRuntime=\"notebookRuntime123\"` * `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"` * `notebookRuntimeTemplate=\"notebookRuntimeTemplate321\"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser=\"test@google.com\"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED`", + "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * `notebookRuntime=\"notebookRuntime123\"` * `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"` * `notebookRuntimeTemplate=\"notebookRuntimeTemplate321\"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser=\"test@google.com\"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED`", "location": "query", "type": "string" }, @@ -13174,6 +13443,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "reboot": { + "description": "Reboots a PersistentResource.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}:reboot", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.persistentResources.reboot", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:reboot", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1RebootPersistentResourceRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -17955,7 +18252,7 @@ } } }, - "revision": "20240312", + "revision": "20240320", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionEmbedVideoResponse": { @@ -19424,6 +19721,153 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1AuthConfig": { + "description": "Auth configuration to run the extension.", + "id": "GoogleCloudAiplatformV1beta1AuthConfig", + "properties": { + "apiKeyConfig": { + "$ref": "GoogleCloudAiplatformV1beta1AuthConfigApiKeyConfig", + "description": "Config for API key auth." + }, + "authType": { + "description": "Type of auth scheme.", + "enum": [ + "AUTH_TYPE_UNSPECIFIED", + "NO_AUTH", + "API_KEY_AUTH", + "HTTP_BASIC_AUTH", + "GOOGLE_SERVICE_ACCOUNT_AUTH", + "OAUTH", + "OIDC_AUTH" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "googleServiceAccountConfig": { + "$ref": "GoogleCloudAiplatformV1beta1AuthConfigGoogleServiceAccountConfig", + "description": "Config for Google Service Account auth." + }, + "httpBasicAuthConfig": { + "$ref": "GoogleCloudAiplatformV1beta1AuthConfigHttpBasicAuthConfig", + "description": "Config for HTTP Basic auth." + }, + "noAuth": { + "$ref": "GoogleCloudAiplatformV1beta1AuthConfigNoAuth", + "deprecated": true, + "description": "Config for no auth." + }, + "oauthConfig": { + "$ref": "GoogleCloudAiplatformV1beta1AuthConfigOauthConfig", + "description": "Config for user oauth." + }, + "oidcConfig": { + "$ref": "GoogleCloudAiplatformV1beta1AuthConfigOidcConfig", + "description": "Config for user OIDC auth." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1AuthConfigApiKeyConfig": { + "description": "Config for authentication with API key.", + "id": "GoogleCloudAiplatformV1beta1AuthConfigApiKeyConfig", + "properties": { + "apiKeySecret": { + "description": "Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.", + "type": "string" + }, + "httpElementLocation": { + "description": "Required. The location of the API key.", + "enum": [ + "HTTP_IN_UNSPECIFIED", + "HTTP_IN_QUERY", + "HTTP_IN_HEADER", + "HTTP_IN_PATH", + "HTTP_IN_BODY", + "HTTP_IN_COOKIE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "name": { + "description": "Required. The parameter name of the API key. E.g. If the API request is \"https://example.com/act?api_key=\", \"api_key\" would be the parameter name.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1AuthConfigGoogleServiceAccountConfig": { + "description": "Config for Google Service Account Authentication.", + "id": "GoogleCloudAiplatformV1beta1AuthConfigGoogleServiceAccountConfig", + "properties": { + "serviceAccount": { + "description": "Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1AuthConfigHttpBasicAuthConfig": { + "description": "Config for HTTP Basic Authentication.", + "id": "GoogleCloudAiplatformV1beta1AuthConfigHttpBasicAuthConfig", + "properties": { + "credentialSecret": { + "description": "Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1AuthConfigNoAuth": { + "description": "Empty message, used to indicate no authentication for an endpoint.", + "id": "GoogleCloudAiplatformV1beta1AuthConfigNoAuth", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1AuthConfigOauthConfig": { + "description": "Config for user oauth.", + "id": "GoogleCloudAiplatformV1beta1AuthConfigOauthConfig", + "properties": { + "accessToken": { + "description": "Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.", + "type": "string" + }, + "serviceAccount": { + "description": "The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1AuthConfigOidcConfig": { + "description": "Config for user OIDC auth.", + "id": "GoogleCloudAiplatformV1beta1AuthConfigOidcConfig", + "properties": { + "idToken": { + "description": "OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.", + "type": "string" + }, + "serviceAccount": { + "description": "The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1AutomaticResources": { "description": "A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines.", "id": "GoogleCloudAiplatformV1beta1AutomaticResources", @@ -20311,6 +20755,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1CheckPoint": { + "description": "Placeholder for all checkpoint related data. Any data needed to restore a request and more go/vertex-extension-query-operation", + "id": "GoogleCloudAiplatformV1beta1CheckPoint", + "properties": { + "content": { + "description": "Required. encoded checkpoint", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1CheckTrialEarlyStoppingStateMetatdata": { "description": "This message will be placed in the metadata field of a google.longrunning.Operation associated with a CheckTrialEarlyStoppingState request.", "id": "GoogleCloudAiplatformV1beta1CheckTrialEarlyStoppingStateMetatdata", @@ -22169,10 +22624,6 @@ "$ref": "GoogleCloudAiplatformV1beta1PredictRequestResponseLoggingConfig", "description": "Configures the request-response logging for online prediction." }, - "privateServiceConnectConfig": { - "$ref": "GoogleCloudAiplatformV1beta1PrivateServiceConnectConfig", - "description": "Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive." - }, "trafficSplit": { "additionalProperties": { "format": "int32", @@ -22563,6 +23014,40 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ExecuteExtensionRequest": { + "description": "Request message for ExtensionExecutionService.ExecuteExtension.", + "id": "GoogleCloudAiplatformV1beta1ExecuteExtensionRequest", + "properties": { + "operationId": { + "description": "Required. The desired ID of the operation to be executed in this extension as defined in ExtensionOperation.operation_id.", + "type": "string" + }, + "operationParams": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Request parameters that will be used for executing this operation. The struct should be in a form of map with param name as the key and actual param value as the value. E.g. If this operation requires a param \"name\" to be set to \"abc\". you can set this to something like {\"name\": \"abc\"}.", + "type": "object" + }, + "runtimeAuthConfig": { + "$ref": "GoogleCloudAiplatformV1beta1AuthConfig", + "description": "Optional. Auth config provided at runtime to override the default value in Extension.manifest.auth_config. The AuthConfig.auth_type should match the value in Extension.manifest.auth_config." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ExecuteExtensionResponse": { + "description": "Response message for ExtensionExecutionService.ExecuteExtension.", + "id": "GoogleCloudAiplatformV1beta1ExecuteExtensionResponse", + "properties": { + "content": { + "description": "Response content from the extension. The content should be conformant to the response.content schema in the extension's manifest/OpenAPI spec.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1Execution": { "description": "Instance of a general execution.", "id": "GoogleCloudAiplatformV1beta1Execution", @@ -22644,6 +23129,56 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ExecutionPlan": { + "description": "Execution plan for a request.", + "id": "GoogleCloudAiplatformV1beta1ExecutionPlan", + "properties": { + "steps": { + "description": "Required. Sequence of steps to execute a request.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1ExecutionPlanStep" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ExecutionPlanStep": { + "description": "Single step in query execution plan.", + "id": "GoogleCloudAiplatformV1beta1ExecutionPlanStep", + "properties": { + "extensionExecution": { + "$ref": "GoogleCloudAiplatformV1beta1ExecutionPlanStepExtensionExecution", + "description": "Extension execution step." + }, + "respondToUser": { + "$ref": "GoogleCloudAiplatformV1beta1ExecutionPlanStepRespondToUser", + "description": "Respond to user step." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ExecutionPlanStepExtensionExecution": { + "description": "Extension execution step.", + "id": "GoogleCloudAiplatformV1beta1ExecutionPlanStepExtensionExecution", + "properties": { + "extension": { + "description": "Required. extension resource name", + "type": "string" + }, + "operationId": { + "description": "Required. the operation id", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ExecutionPlanStepRespondToUser": { + "description": "Respond to user step.", + "id": "GoogleCloudAiplatformV1beta1ExecutionPlanStepRespondToUser", + "properties": {}, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ExplainRequest": { "description": "Request message for PredictionService.Explain.", "id": "GoogleCloudAiplatformV1beta1ExplainRequest", @@ -23360,6 +23895,114 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1Extension": { + "description": "Extensions are tools for large language models to access external data, run computations, etc.", + "id": "GoogleCloudAiplatformV1beta1Extension", + "properties": { + "createTime": { + "description": "Output only. Timestamp when this Extension was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. The description of the Extension.", + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the Extension. The name can be up to 128 characters long and can consist of any UTF-8 characters.", + "type": "string" + }, + "etag": { + "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", + "type": "string" + }, + "extensionOperations": { + "description": "Output only. Supported operations.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1ExtensionOperation" + }, + "readOnly": true, + "type": "array" + }, + "manifest": { + "$ref": "GoogleCloudAiplatformV1beta1ExtensionManifest", + "description": "Required. Manifest of the Extension." + }, + "name": { + "description": "Identifier. The resource name of the Extension.", + "type": "string" + }, + "toolUseExamples": { + "description": "Optional. Examples to illustrate the usage of the extension as a tool.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1ToolUseExample" + }, + "type": "array" + }, + "updateTime": { + "description": "Output only. Timestamp when this Extension was most recently updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ExtensionManifest": { + "description": "Manifest spec of an Extension needed for runtime execution.", + "id": "GoogleCloudAiplatformV1beta1ExtensionManifest", + "properties": { + "apiSpec": { + "$ref": "GoogleCloudAiplatformV1beta1ExtensionManifestApiSpec", + "description": "Required. Immutable. The API specification shown to the LLM." + }, + "authConfig": { + "$ref": "GoogleCloudAiplatformV1beta1AuthConfig", + "description": "Required. Immutable. Type of auth supported by this extension." + }, + "description": { + "description": "Required. The natural language description shown to the LLM. It should describe the usage of the extension, and is essential for the LLM to perform reasoning.", + "type": "string" + }, + "name": { + "description": "Required. Extension name shown to the LLM. The name can be up to 128 characters long.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ExtensionManifestApiSpec": { + "description": "The API specification shown to the LLM.", + "id": "GoogleCloudAiplatformV1beta1ExtensionManifestApiSpec", + "properties": { + "openApiGcsUri": { + "description": "Cloud Storage URI pointing to the OpenAPI spec.", + "type": "string" + }, + "openApiYaml": { + "description": "The API spec in Open API standard and YAML format.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ExtensionOperation": { + "description": "Operation of an extension.", + "id": "GoogleCloudAiplatformV1beta1ExtensionOperation", + "properties": { + "functionDeclaration": { + "$ref": "GoogleCloudAiplatformV1beta1FunctionDeclaration", + "description": "Output only. Structured representation of a function declaration as defined by the OpenAPI Spec.", + "readOnly": true + }, + "operationId": { + "description": "Operation ID that uniquely identifies the operations among the extension. See: \"Operation Object\" in https://swagger.io/specification/. This field is parsed from the OpenAPI spec. For HTTP extensions, if it does not exist in the spec, we will generate one from the HTTP method and path.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1Feature": { "description": "Feature Metadata information. For example, color is a feature that describes an apple.", "id": "GoogleCloudAiplatformV1beta1Feature", @@ -24081,7 +24724,7 @@ "description": "Optional. Configuration options for using brute force search, which simply implements the standard linear search in the database for each query. It is primarily meant for benchmarking and to generate the ground truth for approximate search." }, "crowdingColumn": { - "description": "Optional. Column of crowding. This column contains crowding attribute which is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than some value k' of the k neighbors returned have the same value of crowding_attribute.", + "description": "Optional. Column of crowding. This column contains crowding attribute which is a constraint on a neighbor list produced by FeatureOnlineStoreService.SearchNearestEntities to diversify search results. If NearestNeighborQuery.per_crowding_attribute_neighbor_count is set to K in SearchNearestEntitiesRequest, it's guaranteed that no more than K entities of the same crowding attribute are returned in the response.", "type": "string" }, "distanceMeasureType": { @@ -24390,6 +25033,10 @@ "description": "Response message for FeatureOnlineStoreService.FetchFeatureValues", "id": "GoogleCloudAiplatformV1beta1FetchFeatureValuesResponse", "properties": { + "dataKey": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureViewDataKey", + "description": "The data key associated with this response. Will only be populated for FeatureOnlineStoreService.StreamingFetchFeatureValues RPCs." + }, "keyValues": { "$ref": "GoogleCloudAiplatformV1beta1FetchFeatureValuesResponseFeatureNameValuePairList", "description": "Feature values in KeyValue format." @@ -24619,12 +25266,12 @@ "type": "string" }, "name": { - "description": "Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.", + "description": "Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64.", "type": "string" }, "parameters": { "$ref": "GoogleCloudAiplatformV1beta1Schema", - "description": "Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1" + "description": "Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1" } }, "type": "object" @@ -26061,6 +26708,24 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ListExtensionsResponse": { + "description": "Response message for ExtensionRegistryService.ListExtensions", + "id": "GoogleCloudAiplatformV1beta1ListExtensionsResponse", + "properties": { + "extensions": { + "description": "List of Extension in the requested page.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Extension" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass to ListExtensionsRequest.page_token to obtain that page.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ListFeatureGroupsResponse": { "description": "Response message for FeatureRegistryService.ListFeatureGroups.", "id": "GoogleCloudAiplatformV1beta1ListFeatureGroupsResponse", @@ -29114,7 +29779,9 @@ "BEING_STARTED", "BEING_STOPPED", "STOPPED", - "BEING_UPGRADED" + "BEING_UPGRADED", + "ERROR", + "INVALID" ], "enumDescriptions": [ "Unspecified runtime state.", @@ -29122,7 +29789,9 @@ "NotebookRuntime is in starting state.", "NotebookRuntime is in stopping state.", "NotebookRuntime is in stopped state.", - "NotebookRuntime is in upgrading state. It is in the middle of upgrading process." + "NotebookRuntime is in upgrading state. It is in the middle of upgrading process.", + "NotebookRuntime was unable to start/stop properly.", + "NotebookRuntime is in invalid state. Cannot be recovered." ], "readOnly": true, "type": "string" @@ -30248,6 +30917,10 @@ "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployGke", "description": "Optional. Deploy PublisherModel to Google Kubernetes Engine." }, + "multiDeployVertex": { + "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployVertex", + "description": "Optional. Multiple setups to deploy the PublisherModel to Vertex Endpoint." + }, "openEvaluationPipeline": { "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionRegionalResourceReferences", "description": "Optional. Open evaluation pipeline of the PublisherModel." @@ -30348,6 +31021,20 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployVertex": { + "description": "Multiple setups to deploy the PublisherModel.", + "id": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployVertex", + "properties": { + "multiDeployVertex": { + "description": "Optional. One click deployment configurations.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeploy" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1PublisherModelCallToActionOpenFineTuningPipelines": { "description": "Open fine tuning pipelines.", "id": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionOpenFineTuningPipelines", @@ -30686,6 +31373,143 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1QueryExtensionRequest": { + "description": "Request message for ExtensionExecutionService.QueryExtension.", + "id": "GoogleCloudAiplatformV1beta1QueryExtensionRequest", + "properties": { + "contents": { + "description": "Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Content" + }, + "type": "array" + }, + "query": { + "$ref": "GoogleCloudAiplatformV1beta1QueryRequestQuery", + "deprecated": true, + "description": "Required. User provided input query message." + }, + "useFunctionCall": { + "description": "Optional. Experiment control on whether to use function call.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1QueryExtensionResponse": { + "description": "Response message for ExtensionExecutionService.QueryExtension.", + "id": "GoogleCloudAiplatformV1beta1QueryExtensionResponse", + "properties": { + "failureMessage": { + "description": "Failure message if any.", + "type": "string" + }, + "metadata": { + "$ref": "GoogleCloudAiplatformV1beta1QueryResponseResponseMetadata", + "deprecated": true, + "description": "Metadata related to the query execution." + }, + "queryResponseMetadata": { + "$ref": "GoogleCloudAiplatformV1beta1QueryResponseQueryResponseMetadata", + "deprecated": true + }, + "response": { + "deprecated": true, + "description": "Response to the user's query.", + "type": "string" + }, + "steps": { + "description": "Steps of extension or LLM interaction, can contain function call, function response, or text response. The last step contains the final response to the query.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Content" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1QueryRequestQuery": { + "description": "User provided query message.", + "id": "GoogleCloudAiplatformV1beta1QueryRequestQuery", + "properties": { + "query": { + "description": "Required. The query from user.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1QueryResponseQueryResponseMetadata": { + "id": "GoogleCloudAiplatformV1beta1QueryResponseQueryResponseMetadata", + "properties": { + "steps": { + "description": "ReAgent execution steps.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1QueryResponseQueryResponseMetadataReAgentSteps" + }, + "type": "array" + }, + "useCreativity": { + "description": "Whether the reasoning agent used creativity (instead of extensions provided) to build the response.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1QueryResponseQueryResponseMetadataReAgentSteps": { + "description": "ReAgent execution steps.", + "id": "GoogleCloudAiplatformV1beta1QueryResponseQueryResponseMetadataReAgentSteps", + "properties": { + "error": { + "description": "Error messages from the extension or during response parsing.", + "type": "string" + }, + "extensionInstruction": { + "description": "Planner's instruction to the extension.", + "type": "string" + }, + "extensionInvoked": { + "description": "Planner's choice of extension to invoke.", + "type": "string" + }, + "response": { + "description": "Response of the extension.", + "type": "string" + }, + "success": { + "description": "When set to False, either the extension fails to execute or the response cannot be summarized.", + "type": "boolean" + }, + "thought": { + "description": "Planner's thought.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1QueryResponseResponseMetadata": { + "description": "Metadata for response", + "id": "GoogleCloudAiplatformV1beta1QueryResponseResponseMetadata", + "properties": { + "checkpoint": { + "$ref": "GoogleCloudAiplatformV1beta1CheckPoint", + "description": "Optional. Checkpoint to restore a request" + }, + "executionPlan": { + "$ref": "GoogleCloudAiplatformV1beta1ExecutionPlan", + "description": "Optional. Execution plan for the request." + }, + "flowOutputs": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "To surface the v2 flow output.", + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1RawPredictRequest": { "description": "Request message for PredictionService.RawPredict.", "id": "GoogleCloudAiplatformV1beta1RawPredictRequest", @@ -30939,6 +31763,27 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1RebootPersistentResourceOperationMetadata": { + "description": "Details of operations that perform reboot PersistentResource.", + "id": "GoogleCloudAiplatformV1beta1RebootPersistentResourceOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", + "description": "Operation metadata for PersistentResource." + }, + "progressMessage": { + "description": "Progress Message for Reboot LRO", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RebootPersistentResourceRequest": { + "description": "Request message for PersistentResourceService.RebootPersistentResource.", + "id": "GoogleCloudAiplatformV1beta1RebootPersistentResourceRequest", + "properties": {}, + "type": "object" + }, "GoogleCloudAiplatformV1beta1RemoveContextChildrenRequest": { "description": "Request message for MetadataService.DeleteContextChildrenRequest.", "id": "GoogleCloudAiplatformV1beta1RemoveContextChildrenRequest", @@ -31319,6 +32164,20 @@ ], "type": "string" }, + "method": { + "description": "Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.", + "enum": [ + "HARM_BLOCK_METHOD_UNSPECIFIED", + "SEVERITY", + "PROBABILITY" + ], + "enumDescriptions": [ + "The harm block method is unspecified.", + "The harm block method uses both probability and severity scores.", + "The harm block method uses the probability score." + ], + "type": "string" + }, "threshold": { "description": "Required. The harm block threshold.", "enum": [ @@ -31622,6 +32481,10 @@ "description": "Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed.", "id": "GoogleCloudAiplatformV1beta1Schema", "properties": { + "default": { + "description": "Optional. Default value of the data.", + "type": "any" + }, "description": { "description": "Optional. The description of the data.", "type": "string" @@ -31638,22 +32501,66 @@ "type": "any" }, "format": { - "description": "Optional. The format of the data. Supported formats: for NUMBER type: float, double for INTEGER type: int32, int64", + "description": "Optional. The format of the data. Supported formats: for NUMBER type: \"float\", \"double\" for INTEGER type: \"int32\", \"int64\" for STRING type: \"email\", \"byte\", etc", "type": "string" }, "items": { "$ref": "GoogleCloudAiplatformV1beta1Schema", - "description": "Optional. Schema of the elements of Type.ARRAY." + "description": "Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY." + }, + "maxItems": { + "description": "Optional. Maximum number of the elements for Type.ARRAY.", + "format": "int64", + "type": "string" + }, + "maxLength": { + "description": "Optional. Maximum length of the Type.STRING", + "format": "int64", + "type": "string" + }, + "maxProperties": { + "description": "Optional. Maximum number of the properties for Type.OBJECT.", + "format": "int64", + "type": "string" + }, + "maximum": { + "description": "Optional. Maximum value of the Type.INTEGER and Type.NUMBER", + "format": "double", + "type": "number" + }, + "minItems": { + "description": "Optional. Minimum number of the elements for Type.ARRAY.", + "format": "int64", + "type": "string" + }, + "minLength": { + "description": "Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING", + "format": "int64", + "type": "string" + }, + "minProperties": { + "description": "Optional. Minimum number of the properties for Type.OBJECT.", + "format": "int64", + "type": "string" + }, + "minimum": { + "description": "Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER", + "format": "double", + "type": "number" }, "nullable": { "description": "Optional. Indicates if the value may be null.", "type": "boolean" }, + "pattern": { + "description": "Optional. Pattern of the Type.STRING to restrict a string to a regular expression.", + "type": "string" + }, "properties": { "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1Schema" }, - "description": "Optional. Properties of Type.OBJECT.", + "description": "Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.", "type": "object" }, "required": { @@ -31663,6 +32570,10 @@ }, "type": "array" }, + "title": { + "description": "Optional. The title of the Schema.", + "type": "string" + }, "type": { "description": "Optional. The type of the data.", "enum": [ @@ -35613,6 +36524,56 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesRequest": { + "description": "Request message for FeatureOnlineStoreService.StreamingFetchFeatureValues. For the entities requested, all features under the requested feature view will be returned.", + "id": "GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesRequest", + "properties": { + "dataFormat": { + "description": "Specify response data format. If not set, KeyValue format will be used.", + "enum": [ + "FEATURE_VIEW_DATA_FORMAT_UNSPECIFIED", + "KEY_VALUE", + "PROTO_STRUCT" + ], + "enumDescriptions": [ + "Not set. Will be treated as the KeyValue format.", + "Return response data in key-value format.", + "Return response data in proto Struct format." + ], + "type": "string" + }, + "dataKeys": { + "items": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureViewDataKey" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesResponse": { + "description": "Response message for FeatureOnlineStoreService.StreamingFetchFeatureValues.", + "id": "GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesResponse", + "properties": { + "data": { + "items": { + "$ref": "GoogleCloudAiplatformV1beta1FetchFeatureValuesResponse" + }, + "type": "array" + }, + "dataKeysWithError": { + "items": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureViewDataKey" + }, + "type": "array" + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "Response status. If OK, then StreamingFetchFeatureValuesResponse.data will be populated. Otherwise StreamingFetchFeatureValuesResponse.data_keys_with_error will be populated with the appropriate data keys. The error only applies to the listed data keys - the stream will remain open for further FeatureOnlineStoreService.StreamingFetchFeatureValuesRequest requests." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1StreamingPredictRequest": { "description": "Request message for PredictionService.StreamingPredict. The first message must contain endpoint field and optionally input. The subsequent messages must contain input.", "id": "GoogleCloudAiplatformV1beta1StreamingPredictRequest", @@ -36905,6 +37866,64 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ToolUseExample": { + "description": "A single example of the tool usage.", + "id": "GoogleCloudAiplatformV1beta1ToolUseExample", + "properties": { + "displayName": { + "description": "Required. The display name for example.", + "type": "string" + }, + "extensionOperation": { + "$ref": "GoogleCloudAiplatformV1beta1ToolUseExampleExtensionOperation", + "description": "Extension operation to call." + }, + "functionName": { + "description": "Function name to call.", + "type": "string" + }, + "query": { + "description": "Required. Query that should be routed to this tool.", + "type": "string" + }, + "requestParams": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Request parameters used for executing this tool.", + "type": "object" + }, + "responseParams": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Response parameters generated by this tool.", + "type": "object" + }, + "responseSummary": { + "description": "Summary of the tool response to the user query.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ToolUseExampleExtensionOperation": { + "description": "Identifies one operation of the extension.", + "id": "GoogleCloudAiplatformV1beta1ToolUseExampleExtensionOperation", + "properties": { + "extension": { + "description": "Resource name of the extension.", + "type": "string" + }, + "operationId": { + "description": "Required. Operation ID of the extension.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1TrainingConfig": { "description": "CMLE training config. For every active learning labeling iteration, system will train a machine learning model on CMLE. The trained model will be used by data sampling algorithm to select DataItems.", "id": "GoogleCloudAiplatformV1beta1TrainingConfig", @@ -37555,7 +38574,7 @@ "id": "GoogleCloudAiplatformV1beta1VertexAISearch", "properties": { "datastore": { - "description": "Required. Fully-qualified Vertex AI Search's datastore resource ID. projects/<>/locations/<>/collections/<>/dataStores/<>", + "description": "Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}", "type": "string" } }, @@ -38344,6 +39363,8 @@ "DUET_GOOGLESQL_GENERATION", "DUET_CLOUD_IX_PROMPTS", "DUET_RAD", + "DUET_STACKOVERFLOW_ISSUES", + "DUET_STACKOVERFLOW_ANSWERS", "BARD_ARCADE_GITHUB", "MOBILE_ASSISTANT_MAGI_FILTERED_0825_373K", "MOBILE_ASSISTANT_PALM24B_FILTERED_400K", @@ -38669,6 +39690,8 @@ "", "", "", + "", + "", "Bard ARCADE finetune dataset.", "Mobile assistant finetune datasets.", "", @@ -39108,6 +40131,8 @@ "DUET_GOOGLESQL_GENERATION", "DUET_CLOUD_IX_PROMPTS", "DUET_RAD", + "DUET_STACKOVERFLOW_ISSUES", + "DUET_STACKOVERFLOW_ANSWERS", "BARD_ARCADE_GITHUB", "MOBILE_ASSISTANT_MAGI_FILTERED_0825_373K", "MOBILE_ASSISTANT_PALM24B_FILTERED_400K", @@ -39433,6 +40458,8 @@ "", "", "", + "", + "", "Bard ARCADE finetune dataset.", "Mobile assistant finetune datasets.", "", @@ -39883,6 +40910,8 @@ "DUET_GOOGLESQL_GENERATION", "DUET_CLOUD_IX_PROMPTS", "DUET_RAD", + "DUET_STACKOVERFLOW_ISSUES", + "DUET_STACKOVERFLOW_ANSWERS", "BARD_ARCADE_GITHUB", "MOBILE_ASSISTANT_MAGI_FILTERED_0825_373K", "MOBILE_ASSISTANT_PALM24B_FILTERED_400K", @@ -40208,6 +41237,8 @@ "", "", "", + "", + "", "Bard ARCADE finetune dataset", "Mobile assistant finetune datasets.", "", @@ -40647,6 +41678,8 @@ "DUET_GOOGLESQL_GENERATION", "DUET_CLOUD_IX_PROMPTS", "DUET_RAD", + "DUET_STACKOVERFLOW_ISSUES", + "DUET_STACKOVERFLOW_ANSWERS", "BARD_ARCADE_GITHUB", "MOBILE_ASSISTANT_MAGI_FILTERED_0825_373K", "MOBILE_ASSISTANT_PALM24B_FILTERED_400K", @@ -40972,6 +42005,8 @@ "", "", "", + "", + "", "Bard ARCADE finetune dataset", "Mobile assistant finetune datasets.", "", @@ -41664,7 +42699,7 @@ "id": "LearningGenaiRootGroundingMetadataCitation", "properties": { "endIndex": { - "description": "Index in the prediction output where the citation ends (exclusive). Must be > start_index and < len(output).", + "description": "Index in the prediction output where the citation ends (exclusive). Must be > start_index and <= len(output).", "format": "int32", "type": "integer" }, @@ -42454,14 +43489,16 @@ "RETURN", "STOP", "MAX_TOKENS", - "FILTER" + "FILTER", + "TOP_N_FILTERED" ], "enumDescriptions": [ "", "Return all the tokens back. This typically implies no filtering or stop sequence was triggered.", "Finished due to provided stop sequence.", "Model has emitted the maximum number of tokens as specified by max_decoding_steps.", - "Finished due to triggering some post-processing filter." + "Finished due to triggering some post-processing filter.", + "Filtered out due to Top_N < Response_Candidates.Size()" ], "type": "string" }, diff --git a/discovery/alloydb-v1.json b/discovery/alloydb-v1.json index 71810aa41a..042d6e5200 100644 --- a/discovery/alloydb-v1.json +++ b/discovery/alloydb-v1.json @@ -517,34 +517,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "generateClientCertificate": { - "description": "Generate a client certificate signed by a Cluster CA. The sole purpose of this endpoint is to support AlloyDB connectors and the Auth Proxy client. The endpoint's behavior is subject to change without notice, so do not rely on its behavior remaining constant. Future changes will not break AlloyDB connectors or the Auth Proxy client.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:generateClientCertificate", - "httpMethod": "POST", - "id": "alloydb.projects.locations.clusters.generateClientCertificate", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the parent resource. The required format is: * projects/{project}/locations/{location}/clusters/{cluster}", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}:generateClientCertificate", - "request": { - "$ref": "GenerateClientCertificateRequest" - }, - "response": { - "$ref": "GenerateClientCertificateResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "get": { "description": "Gets details of a single Cluster.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}", @@ -1489,9 +1461,20 @@ } } }, - "revision": "20240228", + "revision": "20240315", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { + "AuthorizedNetwork": { + "description": "AuthorizedNetwork contains metadata for an authorized network.", + "id": "AuthorizedNetwork", + "properties": { + "cidrRange": { + "description": "CIDR range for one authorzied network of the instance.", + "type": "string" + } + }, + "type": "object" + }, "AutomatedBackupPolicy": { "description": "Message describing the user-specified automated backup policy. All fields in the automated backup policy are optional. Defaults for each field are provided if they are not set.", "id": "AutomatedBackupPolicy", @@ -1975,6 +1958,11 @@ "name": { "description": "The name of the ConnectionInfo singleton resource, e.g.: projects/{project}/locations/{location}/clusters/*/instances/*/connectionInfo This field currently has no semantic meaning.", "type": "string" + }, + "publicIpAddress": { + "description": "Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.", + "readOnly": true, + "type": "string" } }, "type": "object" @@ -2129,49 +2117,6 @@ }, "type": "object" }, - "GenerateClientCertificateRequest": { - "description": "Message for requests to generate a client certificate signed by the Cluster CA.", - "id": "GenerateClientCertificateRequest", - "properties": { - "certDuration": { - "description": "Optional. An optional hint to the endpoint to generate the client certificate with the requested duration. The duration can be from 1 hour to 24 hours. The endpoint may or may not honor the hint. If the hint is left unspecified or is not honored, then the endpoint will pick an appropriate default duration.", - "format": "google-duration", - "type": "string" - }, - "publicKey": { - "description": "Optional. The public key from the client.", - "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).", - "type": "string" - }, - "useMetadataExchange": { - "description": "Optional. An optional hint to the endpoint to generate a client ceritificate that can be used by AlloyDB connectors to exchange additional metadata with the server after TLS handshake.", - "type": "boolean" - } - }, - "type": "object" - }, - "GenerateClientCertificateResponse": { - "description": "Message returned by a GenerateClientCertificate operation.", - "id": "GenerateClientCertificateResponse", - "properties": { - "caCert": { - "description": "Optional. The pem-encoded cluster ca X.509 certificate.", - "type": "string" - }, - "pemCertificateChain": { - "description": "Output only. The pem-encoded chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246.", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" - } - }, - "type": "object" - }, "GoogleCloudLocationListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "id": "GoogleCloudLocationListLocationsResponse", @@ -2375,6 +2320,10 @@ "readOnly": true, "type": "string" }, + "networkConfig": { + "$ref": "InstanceNetworkConfig", + "description": "Optional. Instance level network configuration." + }, "nodes": { "description": "Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.", "items": { @@ -2383,6 +2332,11 @@ "readOnly": true, "type": "array" }, + "publicIpAddress": { + "description": "Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.", + "readOnly": true, + "type": "string" + }, "queryInsightsConfig": { "$ref": "QueryInsightsInstanceConfig", "description": "Configuration for query insights." @@ -2447,6 +2401,24 @@ }, "type": "object" }, + "InstanceNetworkConfig": { + "description": "Metadata related to instance level network configuration.", + "id": "InstanceNetworkConfig", + "properties": { + "authorizedExternalNetworks": { + "description": "Optional. A list of external network authorized to access this instance.", + "items": { + "$ref": "AuthorizedNetwork" + }, + "type": "array" + }, + "enablePublicIp": { + "description": "Optional. Enabling public ip for the instance.", + "type": "boolean" + } + }, + "type": "object" + }, "IntegerRestrictions": { "description": "Restrictions on INTEGER type values.", "id": "IntegerRestrictions", @@ -3327,7 +3299,13 @@ "SIGNAL_TYPE_SERVER_CERTIFICATE_NEAR_EXPIRY", "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", "SIGNAL_TYPE_RESTRICT_AUTHORIZED_NETWORKS", - "SIGNAL_TYPE_VIOLATE_POLICY_RESTRICT_PUBLIC_IP" + "SIGNAL_TYPE_VIOLATE_POLICY_RESTRICT_PUBLIC_IP", + "SIGNAL_TYPE_QUOTA_LIMIT", + "SIGNAL_TYPE_NO_PASSWORD_POLICY", + "SIGNAL_TYPE_CONNECTIONS_PERFORMANCE_IMPACT", + "SIGNAL_TYPE_TMP_TABLES_PERFORMANCE_IMPACT", + "SIGNAL_TYPE_TRANS_LOGS_PERFORMANCE_IMPACT", + "SIGNAL_TYPE_HIGH_JOINS_WITHOUT_INDEXES" ], "enumDeprecated": [ false, @@ -3390,6 +3368,12 @@ false, false, false, + false, + false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -3453,7 +3437,13 @@ "Represents server certificate is near expiry.", "Represents database auditing is disabled.", "Represents not restricted to authorized networks.", - "Represents violate org policy restrict public ip." + "Represents violate org policy restrict public ip.", + "Cluster nearing quota limit", + "No password policy set on resources", + "Performance impact of connections settings", + "Performance impact of temporary tables settings", + "Performance impact of transaction logs settings", + "Performance impact of high joins without indexes" ], "type": "string" }, @@ -3657,10 +3647,15 @@ "format": "google-datetime", "type": "string" }, + "userLabelSet": { + "$ref": "StorageDatabasecenterPartnerapiV1mainUserLabels", + "description": "User-provided labels associated with the resource" + }, "userLabels": { "additionalProperties": { "type": "string" }, + "deprecated": true, "description": "User-provided labels, represented as a dictionary where each label is a single key value pair.", "type": "object" } @@ -3783,7 +3778,13 @@ "SIGNAL_TYPE_SERVER_CERTIFICATE_NEAR_EXPIRY", "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", "SIGNAL_TYPE_RESTRICT_AUTHORIZED_NETWORKS", - "SIGNAL_TYPE_VIOLATE_POLICY_RESTRICT_PUBLIC_IP" + "SIGNAL_TYPE_VIOLATE_POLICY_RESTRICT_PUBLIC_IP", + "SIGNAL_TYPE_QUOTA_LIMIT", + "SIGNAL_TYPE_NO_PASSWORD_POLICY", + "SIGNAL_TYPE_CONNECTIONS_PERFORMANCE_IMPACT", + "SIGNAL_TYPE_TMP_TABLES_PERFORMANCE_IMPACT", + "SIGNAL_TYPE_TRANS_LOGS_PERFORMANCE_IMPACT", + "SIGNAL_TYPE_HIGH_JOINS_WITHOUT_INDEXES" ], "enumDeprecated": [ false, @@ -3846,6 +3847,12 @@ false, false, false, + false, + false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -3909,7 +3916,13 @@ "Represents server certificate is near expiry.", "Represents database auditing is disabled.", "Represents not restricted to authorized networks.", - "Represents violate org policy restrict public ip." + "Represents violate org policy restrict public ip.", + "Cluster nearing quota limit", + "No password policy set on resources", + "Performance impact of connections settings", + "Performance impact of temporary tables settings", + "Performance impact of transaction logs settings", + "Performance impact of high joins without indexes" ], "type": "string" } @@ -3938,11 +3951,18 @@ "description": "An enum that represents the type of this entitlement.", "enum": [ "ENTITLEMENT_TYPE_UNSPECIFIED", - "DUET_AI" + "DUET_AI", + "GEMINI" + ], + "enumDeprecated": [ + false, + true, + false ], "enumDescriptions": [ "", - "The root entitlement representing Duet AI package ownership." + "The root entitlement representing Duet AI package ownership.", + "The root entitlement representing Gemini package ownership." ], "type": "string" } @@ -4015,6 +4035,19 @@ }, "type": "object" }, + "StorageDatabasecenterPartnerapiV1mainUserLabels": { + "description": "Message type for storing user labels. User labels are used to tag App Engine resources, allowing users to search for resources matching a set of labels and to aggregate usage data by labels.", + "id": "StorageDatabasecenterPartnerapiV1mainUserLabels", + "properties": { + "labels": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "type": "object" + }, "StorageDatabasecenterProtoCommonProduct": { "description": "Product specification for Condor resources.", "id": "StorageDatabasecenterProtoCommonProduct", diff --git a/discovery/alloydb-v1alpha.json b/discovery/alloydb-v1alpha.json index 4924b92aa2..848d74e65d 100644 --- a/discovery/alloydb-v1alpha.json +++ b/discovery/alloydb-v1alpha.json @@ -517,34 +517,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "generateClientCertificate": { - "description": "Generate a client certificate signed by a Cluster CA. The sole purpose of this endpoint is to support AlloyDB connectors and the Auth Proxy client. The endpoint's behavior is subject to change without notice, so do not rely on its behavior remaining constant. Future changes will not break AlloyDB connectors or the Auth Proxy client.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:generateClientCertificate", - "httpMethod": "POST", - "id": "alloydb.projects.locations.clusters.generateClientCertificate", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the parent resource. The required format is: * projects/{project}/locations/{location}/clusters/{cluster}", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+parent}:generateClientCertificate", - "request": { - "$ref": "GenerateClientCertificateRequest" - }, - "response": { - "$ref": "GenerateClientCertificateResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "get": { "description": "Gets details of a single Cluster.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}", @@ -1489,7 +1461,7 @@ } } }, - "revision": "20240228", + "revision": "20240315", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -1878,6 +1850,10 @@ "description": "For Resource freshness validation (https://google.aip.dev/154)", "type": "string" }, + "geminiConfig": { + "$ref": "GeminiClusterConfig", + "description": "Optional. Configuration parameters related to the Gemini in Databases add-on. See go/prd-enable-duet-ai-databases for more details." + }, "initialUser": { "$ref": "UserPassword", "description": "Input only. Initial user to setup during cluster creation. Required. If used in `RestoreCluster` this is ignored." @@ -1889,6 +1865,10 @@ "description": "Labels as key value pairs", "type": "object" }, + "maintenanceUpdatePolicy": { + "$ref": "MaintenanceUpdatePolicy", + "description": "Optional. The maintenance update policy determines when to allow or deny updates." + }, "migrationSource": { "$ref": "MigrationSource", "description": "Output only. Cluster created via DMS migration.", @@ -2111,6 +2091,25 @@ }, "type": "object" }, + "DenyMaintenancePeriod": { + "description": "DenyMaintenancePeriod definition. Excepting emergencies, maintenance will not be scheduled to start within this deny period. The start_date must be less than the end_date.", + "id": "DenyMaintenancePeriod", + "properties": { + "endDate": { + "$ref": "GoogleTypeDate", + "description": "Deny period end date. This can be: * A full date, with non-zero year, month and day values. * A month and day value, with a zero year for recurring. Date matching this period will have to be before the end." + }, + "startDate": { + "$ref": "GoogleTypeDate", + "description": "Deny period start date. This can be: * A full date, with non-zero year, month and day values. * A month and day value, with a zero year for recurring. Date matching this period will have to be the same or after the start." + }, + "time": { + "$ref": "GoogleTypeTimeOfDay", + "description": "Time in UTC when the deny period starts on start_date and ends on end_date. This can be: * Full time. * All zeros for 00:00:00 UTC" + } + }, + "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", @@ -2173,56 +2172,26 @@ }, "type": "object" }, - "GenerateClientCertificateRequest": { - "description": "Message for requests to generate a client certificate signed by the Cluster CA.", - "id": "GenerateClientCertificateRequest", + "GeminiClusterConfig": { + "description": "Cluster level configuration parameters related to the Gemini in Databases add-on. See go/prd-enable-duet-ai-databases for more details.", + "id": "GeminiClusterConfig", "properties": { - "certDuration": { - "description": "Optional. An optional hint to the endpoint to generate the client certificate with the requested duration. The duration can be from 1 hour to 24 hours. The endpoint may or may not honor the hint. If the hint is left unspecified or is not honored, then the endpoint will pick an appropriate default duration.", - "format": "google-duration", - "type": "string" - }, - "pemCsr": { - "deprecated": true, - "description": "Optional. A pem-encoded X.509 certificate signing request (CSR). It is recommended to use public_key instead.", - "type": "string" - }, - "publicKey": { - "description": "Optional. The public key from the client.", - "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).", - "type": "string" - }, - "useMetadataExchange": { - "description": "Optional. An optional hint to the endpoint to generate a client ceritificate that can be used by AlloyDB connectors to exchange additional metadata with the server after TLS handshake.", + "entitled": { + "description": "Output only. Whether the Gemini in Databases add-on is enabled for the cluster. It will be true only if the add-on has been enabled for the billing account corresponding to the cluster. Its status is toggled from the Admin Control Center (ACC) and cannot be toggled using AlloyDB's APIs.", + "readOnly": true, "type": "boolean" } }, "type": "object" }, - "GenerateClientCertificateResponse": { - "description": "Message returned by a GenerateClientCertificate operation.", - "id": "GenerateClientCertificateResponse", + "GeminiInstanceConfig": { + "description": "Instance level configuration parameters related to the Gemini in Databases add-on. See go/prd-enable-duet-ai-databases for more details.", + "id": "GeminiInstanceConfig", "properties": { - "caCert": { - "description": "Optional. The pem-encoded cluster ca X.509 certificate.", - "type": "string" - }, - "pemCertificate": { - "deprecated": true, - "description": "Output only. The pem-encoded, signed X.509 certificate.", + "entitled": { + "description": "Output only. Whether the Gemini in Databases add-on is enabled for the instance. It will be true only if the add-on has been enabled for the billing account corresponding to the instance. Its status is toggled from the Admin Control Center (ACC) and cannot be toggled using AlloyDB's APIs.", "readOnly": true, - "type": "string" - }, - "pemCertificateChain": { - "description": "Output only. The pem-encoded chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246.", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" + "type": "boolean" } }, "type": "object" @@ -2279,6 +2248,28 @@ }, "type": "object" }, + "GoogleTypeDate": { + "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", + "id": "GoogleTypeDate", + "properties": { + "day": { + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", + "format": "int32", + "type": "integer" + }, + "month": { + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", + "format": "int32", + "type": "integer" + }, + "year": { + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleTypeTimeOfDay": { "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": "GoogleTypeTimeOfDay", @@ -2393,6 +2384,10 @@ "description": "The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.", "type": "string" }, + "geminiConfig": { + "$ref": "GeminiInstanceConfig", + "description": "Optional. Configuration parameters related to the Gemini in Databases add-on. See go/prd-enable-duet-ai-databases for more details." + }, "instanceType": { "description": "Required. The type of the instance. Specified at creation time.", "enum": [ @@ -2442,6 +2437,10 @@ "readOnly": true, "type": "array" }, + "observabilityConfig": { + "$ref": "ObservabilityInstanceConfig", + "description": "Configuration for observability." + }, "pscInstanceConfig": { "$ref": "PscInstanceConfig", "description": "Optional. The configuration for Private Service Connect (PSC) for the instance." @@ -2707,6 +2706,62 @@ }, "type": "object" }, + "MaintenanceUpdatePolicy": { + "description": "MaintenanceUpdatePolicy defines the policy for system updates.", + "id": "MaintenanceUpdatePolicy", + "properties": { + "denyMaintenancePeriods": { + "description": "Periods to deny maintenance. Currently limited to 1.", + "items": { + "$ref": "DenyMaintenancePeriod" + }, + "type": "array" + }, + "maintenanceWindows": { + "description": "Preferred windows to perform maintenance. Currently limited to 1.", + "items": { + "$ref": "MaintenanceWindow" + }, + "type": "array" + } + }, + "type": "object" + }, + "MaintenanceWindow": { + "description": "MaintenanceWindow specifies a preferred day and time for maintenance.", + "id": "MaintenanceWindow", + "properties": { + "day": { + "description": "Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.", + "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" + }, + "startTime": { + "$ref": "GoogleTypeTimeOfDay", + "description": "Preferred time to start the maintenance operation on the specified day. Maintenance will start within 1 hour of this time." + } + }, + "type": "object" + }, "MigrationSource": { "description": "Subset of the source instance configuration that is available when reading the cluster resource.", "id": "MigrationSource", @@ -2775,6 +2830,48 @@ }, "type": "object" }, + "ObservabilityInstanceConfig": { + "description": "Observability Instance specific configuration.", + "id": "ObservabilityInstanceConfig", + "properties": { + "enabled": { + "description": "Observability feature status for an instance. This is a read-only flag and modifiable only by producer API. This flag is turned \"off\" by default.", + "type": "boolean" + }, + "maxQueryStringLength": { + "description": "Query string length. The default value is 10k.", + "format": "int32", + "type": "integer" + }, + "preserveComments": { + "description": "Preserve comments in query string for an instance. This flag is turned \"off\" by default.", + "type": "boolean" + }, + "queryPlansPerMinute": { + "description": "Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 to 20 is considered valid.", + "format": "int32", + "type": "integer" + }, + "recordApplicationTags": { + "description": "Record application tags for an instance. This flag is turned \"off\" by default.", + "type": "boolean" + }, + "trackActiveQueries": { + "description": "Track actively running queries on the instance. If not set, this flag is \"off\" by default.", + "type": "boolean" + }, + "trackWaitEventTypes": { + "description": "Output only. Track wait event types during query execution for an instance. This flag is turned \"on\" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by producer API.", + "readOnly": true, + "type": "boolean" + }, + "trackWaitEvents": { + "description": "Track wait events during query execution for an instance. This flag is turned \"on\" by default but tracking is enabled only after observability enabled flag is also turned on.", + "type": "boolean" + } + }, + "type": "object" + }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -3500,7 +3597,13 @@ "SIGNAL_TYPE_SERVER_CERTIFICATE_NEAR_EXPIRY", "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", "SIGNAL_TYPE_RESTRICT_AUTHORIZED_NETWORKS", - "SIGNAL_TYPE_VIOLATE_POLICY_RESTRICT_PUBLIC_IP" + "SIGNAL_TYPE_VIOLATE_POLICY_RESTRICT_PUBLIC_IP", + "SIGNAL_TYPE_QUOTA_LIMIT", + "SIGNAL_TYPE_NO_PASSWORD_POLICY", + "SIGNAL_TYPE_CONNECTIONS_PERFORMANCE_IMPACT", + "SIGNAL_TYPE_TMP_TABLES_PERFORMANCE_IMPACT", + "SIGNAL_TYPE_TRANS_LOGS_PERFORMANCE_IMPACT", + "SIGNAL_TYPE_HIGH_JOINS_WITHOUT_INDEXES" ], "enumDeprecated": [ false, @@ -3563,6 +3666,12 @@ false, false, false, + false, + false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -3626,7 +3735,13 @@ "Represents server certificate is near expiry.", "Represents database auditing is disabled.", "Represents not restricted to authorized networks.", - "Represents violate org policy restrict public ip." + "Represents violate org policy restrict public ip.", + "Cluster nearing quota limit", + "No password policy set on resources", + "Performance impact of connections settings", + "Performance impact of temporary tables settings", + "Performance impact of transaction logs settings", + "Performance impact of high joins without indexes" ], "type": "string" }, @@ -3830,10 +3945,15 @@ "format": "google-datetime", "type": "string" }, + "userLabelSet": { + "$ref": "StorageDatabasecenterPartnerapiV1mainUserLabels", + "description": "User-provided labels associated with the resource" + }, "userLabels": { "additionalProperties": { "type": "string" }, + "deprecated": true, "description": "User-provided labels, represented as a dictionary where each label is a single key value pair.", "type": "object" } @@ -3956,7 +4076,13 @@ "SIGNAL_TYPE_SERVER_CERTIFICATE_NEAR_EXPIRY", "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", "SIGNAL_TYPE_RESTRICT_AUTHORIZED_NETWORKS", - "SIGNAL_TYPE_VIOLATE_POLICY_RESTRICT_PUBLIC_IP" + "SIGNAL_TYPE_VIOLATE_POLICY_RESTRICT_PUBLIC_IP", + "SIGNAL_TYPE_QUOTA_LIMIT", + "SIGNAL_TYPE_NO_PASSWORD_POLICY", + "SIGNAL_TYPE_CONNECTIONS_PERFORMANCE_IMPACT", + "SIGNAL_TYPE_TMP_TABLES_PERFORMANCE_IMPACT", + "SIGNAL_TYPE_TRANS_LOGS_PERFORMANCE_IMPACT", + "SIGNAL_TYPE_HIGH_JOINS_WITHOUT_INDEXES" ], "enumDeprecated": [ false, @@ -4019,6 +4145,12 @@ false, false, false, + false, + false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -4082,7 +4214,13 @@ "Represents server certificate is near expiry.", "Represents database auditing is disabled.", "Represents not restricted to authorized networks.", - "Represents violate org policy restrict public ip." + "Represents violate org policy restrict public ip.", + "Cluster nearing quota limit", + "No password policy set on resources", + "Performance impact of connections settings", + "Performance impact of temporary tables settings", + "Performance impact of transaction logs settings", + "Performance impact of high joins without indexes" ], "type": "string" } @@ -4111,11 +4249,18 @@ "description": "An enum that represents the type of this entitlement.", "enum": [ "ENTITLEMENT_TYPE_UNSPECIFIED", - "DUET_AI" + "DUET_AI", + "GEMINI" + ], + "enumDeprecated": [ + false, + true, + false ], "enumDescriptions": [ "", - "The root entitlement representing Duet AI package ownership." + "The root entitlement representing Duet AI package ownership.", + "The root entitlement representing Gemini package ownership." ], "type": "string" } @@ -4188,6 +4333,19 @@ }, "type": "object" }, + "StorageDatabasecenterPartnerapiV1mainUserLabels": { + "description": "Message type for storing user labels. User labels are used to tag App Engine resources, allowing users to search for resources matching a set of labels and to aggregate usage data by labels.", + "id": "StorageDatabasecenterPartnerapiV1mainUserLabels", + "properties": { + "labels": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "type": "object" + }, "StorageDatabasecenterProtoCommonProduct": { "description": "Product specification for Condor resources.", "id": "StorageDatabasecenterProtoCommonProduct", diff --git a/discovery/alloydb-v1beta.json b/discovery/alloydb-v1beta.json index 898c66a60b..08b43d97b2 100644 --- a/discovery/alloydb-v1beta.json +++ b/discovery/alloydb-v1beta.json @@ -517,34 +517,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "generateClientCertificate": { - "description": "Generate a client certificate signed by a Cluster CA. The sole purpose of this endpoint is to support AlloyDB connectors and the Auth Proxy client. The endpoint's behavior is subject to change without notice, so do not rely on its behavior remaining constant. Future changes will not break AlloyDB connectors or the Auth Proxy client.", - "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:generateClientCertificate", - "httpMethod": "POST", - "id": "alloydb.projects.locations.clusters.generateClientCertificate", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the parent resource. The required format is: * projects/{project}/locations/{location}/clusters/{cluster}", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta/{+parent}:generateClientCertificate", - "request": { - "$ref": "GenerateClientCertificateRequest" - }, - "response": { - "$ref": "GenerateClientCertificateResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "get": { "description": "Gets details of a single Cluster.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}", @@ -1486,7 +1458,7 @@ } } }, - "revision": "20240228", + "revision": "20240315", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -1864,6 +1836,10 @@ "description": "For Resource freshness validation (https://google.aip.dev/154)", "type": "string" }, + "geminiConfig": { + "$ref": "GeminiClusterConfig", + "description": "Optional. Configuration parameters related to the Gemini in Databases add-on. See go/prd-enable-duet-ai-databases for more details." + }, "initialUser": { "$ref": "UserPassword", "description": "Input only. Initial user to setup during cluster creation. Required. If used in `RestoreCluster` this is ignored." @@ -1875,6 +1851,10 @@ "description": "Labels as key value pairs", "type": "object" }, + "maintenanceUpdatePolicy": { + "$ref": "MaintenanceUpdatePolicy", + "description": "Optional. The maintenance update policy determines when to allow or deny updates." + }, "migrationSource": { "$ref": "MigrationSource", "description": "Output only. Cluster created via DMS migration.", @@ -2092,6 +2072,25 @@ }, "type": "object" }, + "DenyMaintenancePeriod": { + "description": "DenyMaintenancePeriod definition. Excepting emergencies, maintenance will not be scheduled to start within this deny period. The start_date must be less than the end_date.", + "id": "DenyMaintenancePeriod", + "properties": { + "endDate": { + "$ref": "GoogleTypeDate", + "description": "Deny period end date. This can be: * A full date, with non-zero year, month and day values. * A month and day value, with a zero year for recurring. Date matching this period will have to be before the end." + }, + "startDate": { + "$ref": "GoogleTypeDate", + "description": "Deny period start date. This can be: * A full date, with non-zero year, month and day values. * A month and day value, with a zero year for recurring. Date matching this period will have to be the same or after the start." + }, + "time": { + "$ref": "GoogleTypeTimeOfDay", + "description": "Time in UTC when the deny period starts on start_date and ends on end_date. This can be: * Full time. * All zeros for 00:00:00 UTC" + } + }, + "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", @@ -2154,56 +2153,26 @@ }, "type": "object" }, - "GenerateClientCertificateRequest": { - "description": "Message for requests to generate a client certificate signed by the Cluster CA.", - "id": "GenerateClientCertificateRequest", + "GeminiClusterConfig": { + "description": "Cluster level configuration parameters related to the Gemini in Databases add-on. See go/prd-enable-duet-ai-databases for more details.", + "id": "GeminiClusterConfig", "properties": { - "certDuration": { - "description": "Optional. An optional hint to the endpoint to generate the client certificate with the requested duration. The duration can be from 1 hour to 24 hours. The endpoint may or may not honor the hint. If the hint is left unspecified or is not honored, then the endpoint will pick an appropriate default duration.", - "format": "google-duration", - "type": "string" - }, - "pemCsr": { - "deprecated": true, - "description": "Optional. A pem-encoded X.509 certificate signing request (CSR). It is recommended to use public_key instead.", - "type": "string" - }, - "publicKey": { - "description": "Optional. The public key from the client.", - "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).", - "type": "string" - }, - "useMetadataExchange": { - "description": "Optional. An optional hint to the endpoint to generate a client ceritificate that can be used by AlloyDB connectors to exchange additional metadata with the server after TLS handshake.", + "entitled": { + "description": "Output only. Whether the Gemini in Databases add-on is enabled for the cluster. It will be true only if the add-on has been enabled for the billing account corresponding to the cluster. Its status is toggled from the Admin Control Center (ACC) and cannot be toggled using AlloyDB's APIs.", + "readOnly": true, "type": "boolean" } }, "type": "object" }, - "GenerateClientCertificateResponse": { - "description": "Message returned by a GenerateClientCertificate operation.", - "id": "GenerateClientCertificateResponse", + "GeminiInstanceConfig": { + "description": "Instance level configuration parameters related to the Gemini in Databases add-on. See go/prd-enable-duet-ai-databases for more details.", + "id": "GeminiInstanceConfig", "properties": { - "caCert": { - "description": "Optional. The pem-encoded cluster ca X.509 certificate.", - "type": "string" - }, - "pemCertificate": { - "deprecated": true, - "description": "Output only. The pem-encoded, signed X.509 certificate.", + "entitled": { + "description": "Output only. Whether the Gemini in Databases add-on is enabled for the instance. It will be true only if the add-on has been enabled for the billing account corresponding to the instance. Its status is toggled from the Admin Control Center (ACC) and cannot be toggled using AlloyDB's APIs.", "readOnly": true, - "type": "string" - }, - "pemCertificateChain": { - "description": "Output only. The pem-encoded chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246.", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" + "type": "boolean" } }, "type": "object" @@ -2260,6 +2229,28 @@ }, "type": "object" }, + "GoogleTypeDate": { + "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", + "id": "GoogleTypeDate", + "properties": { + "day": { + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", + "format": "int32", + "type": "integer" + }, + "month": { + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", + "format": "int32", + "type": "integer" + }, + "year": { + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleTypeTimeOfDay": { "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": "GoogleTypeTimeOfDay", @@ -2374,6 +2365,10 @@ "description": "The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.", "type": "string" }, + "geminiConfig": { + "$ref": "GeminiInstanceConfig", + "description": "Optional. Configuration parameters related to the Gemini in Databases add-on. See go/prd-enable-duet-ai-databases for more details." + }, "instanceType": { "description": "Required. The type of the instance. Specified at creation time.", "enum": [ @@ -2423,6 +2418,10 @@ "readOnly": true, "type": "array" }, + "observabilityConfig": { + "$ref": "ObservabilityInstanceConfig", + "description": "Configuration for observability." + }, "pscInstanceConfig": { "$ref": "PscInstanceConfig", "description": "Optional. The configuration for Private Service Connect (PSC) for the instance." @@ -2683,6 +2682,62 @@ }, "type": "object" }, + "MaintenanceUpdatePolicy": { + "description": "MaintenanceUpdatePolicy defines the policy for system updates.", + "id": "MaintenanceUpdatePolicy", + "properties": { + "denyMaintenancePeriods": { + "description": "Periods to deny maintenance. Currently limited to 1.", + "items": { + "$ref": "DenyMaintenancePeriod" + }, + "type": "array" + }, + "maintenanceWindows": { + "description": "Preferred windows to perform maintenance. Currently limited to 1.", + "items": { + "$ref": "MaintenanceWindow" + }, + "type": "array" + } + }, + "type": "object" + }, + "MaintenanceWindow": { + "description": "MaintenanceWindow specifies a preferred day and time for maintenance.", + "id": "MaintenanceWindow", + "properties": { + "day": { + "description": "Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.", + "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" + }, + "startTime": { + "$ref": "GoogleTypeTimeOfDay", + "description": "Preferred time to start the maintenance operation on the specified day. Maintenance will start within 1 hour of this time." + } + }, + "type": "object" + }, "MigrationSource": { "description": "Subset of the source instance configuration that is available when reading the cluster resource.", "id": "MigrationSource", @@ -2751,6 +2806,48 @@ }, "type": "object" }, + "ObservabilityInstanceConfig": { + "description": "Observability Instance specific configuration.", + "id": "ObservabilityInstanceConfig", + "properties": { + "enabled": { + "description": "Observability feature status for an instance. This is a read-only flag and modifiable only by producer API. This flag is turned \"off\" by default.", + "type": "boolean" + }, + "maxQueryStringLength": { + "description": "Query string length. The default value is 10k.", + "format": "int32", + "type": "integer" + }, + "preserveComments": { + "description": "Preserve comments in query string for an instance. This flag is turned \"off\" by default.", + "type": "boolean" + }, + "queryPlansPerMinute": { + "description": "Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 to 20 is considered valid.", + "format": "int32", + "type": "integer" + }, + "recordApplicationTags": { + "description": "Record application tags for an instance. This flag is turned \"off\" by default.", + "type": "boolean" + }, + "trackActiveQueries": { + "description": "Track actively running queries on the instance. If not set, this flag is \"off\" by default.", + "type": "boolean" + }, + "trackWaitEventTypes": { + "description": "Output only. Track wait event types during query execution for an instance. This flag is turned \"on\" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by producer API.", + "readOnly": true, + "type": "boolean" + }, + "trackWaitEvents": { + "description": "Track wait events during query execution for an instance. This flag is turned \"on\" by default but tracking is enabled only after observability enabled flag is also turned on.", + "type": "boolean" + } + }, + "type": "object" + }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -3476,7 +3573,13 @@ "SIGNAL_TYPE_SERVER_CERTIFICATE_NEAR_EXPIRY", "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", "SIGNAL_TYPE_RESTRICT_AUTHORIZED_NETWORKS", - "SIGNAL_TYPE_VIOLATE_POLICY_RESTRICT_PUBLIC_IP" + "SIGNAL_TYPE_VIOLATE_POLICY_RESTRICT_PUBLIC_IP", + "SIGNAL_TYPE_QUOTA_LIMIT", + "SIGNAL_TYPE_NO_PASSWORD_POLICY", + "SIGNAL_TYPE_CONNECTIONS_PERFORMANCE_IMPACT", + "SIGNAL_TYPE_TMP_TABLES_PERFORMANCE_IMPACT", + "SIGNAL_TYPE_TRANS_LOGS_PERFORMANCE_IMPACT", + "SIGNAL_TYPE_HIGH_JOINS_WITHOUT_INDEXES" ], "enumDeprecated": [ false, @@ -3539,6 +3642,12 @@ false, false, false, + false, + false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -3602,7 +3711,13 @@ "Represents server certificate is near expiry.", "Represents database auditing is disabled.", "Represents not restricted to authorized networks.", - "Represents violate org policy restrict public ip." + "Represents violate org policy restrict public ip.", + "Cluster nearing quota limit", + "No password policy set on resources", + "Performance impact of connections settings", + "Performance impact of temporary tables settings", + "Performance impact of transaction logs settings", + "Performance impact of high joins without indexes" ], "type": "string" }, @@ -3806,10 +3921,15 @@ "format": "google-datetime", "type": "string" }, + "userLabelSet": { + "$ref": "StorageDatabasecenterPartnerapiV1mainUserLabels", + "description": "User-provided labels associated with the resource" + }, "userLabels": { "additionalProperties": { "type": "string" }, + "deprecated": true, "description": "User-provided labels, represented as a dictionary where each label is a single key value pair.", "type": "object" } @@ -3932,7 +4052,13 @@ "SIGNAL_TYPE_SERVER_CERTIFICATE_NEAR_EXPIRY", "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", "SIGNAL_TYPE_RESTRICT_AUTHORIZED_NETWORKS", - "SIGNAL_TYPE_VIOLATE_POLICY_RESTRICT_PUBLIC_IP" + "SIGNAL_TYPE_VIOLATE_POLICY_RESTRICT_PUBLIC_IP", + "SIGNAL_TYPE_QUOTA_LIMIT", + "SIGNAL_TYPE_NO_PASSWORD_POLICY", + "SIGNAL_TYPE_CONNECTIONS_PERFORMANCE_IMPACT", + "SIGNAL_TYPE_TMP_TABLES_PERFORMANCE_IMPACT", + "SIGNAL_TYPE_TRANS_LOGS_PERFORMANCE_IMPACT", + "SIGNAL_TYPE_HIGH_JOINS_WITHOUT_INDEXES" ], "enumDeprecated": [ false, @@ -3995,6 +4121,12 @@ false, false, false, + false, + false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -4058,7 +4190,13 @@ "Represents server certificate is near expiry.", "Represents database auditing is disabled.", "Represents not restricted to authorized networks.", - "Represents violate org policy restrict public ip." + "Represents violate org policy restrict public ip.", + "Cluster nearing quota limit", + "No password policy set on resources", + "Performance impact of connections settings", + "Performance impact of temporary tables settings", + "Performance impact of transaction logs settings", + "Performance impact of high joins without indexes" ], "type": "string" } @@ -4087,11 +4225,18 @@ "description": "An enum that represents the type of this entitlement.", "enum": [ "ENTITLEMENT_TYPE_UNSPECIFIED", - "DUET_AI" + "DUET_AI", + "GEMINI" + ], + "enumDeprecated": [ + false, + true, + false ], "enumDescriptions": [ "", - "The root entitlement representing Duet AI package ownership." + "The root entitlement representing Duet AI package ownership.", + "The root entitlement representing Gemini package ownership." ], "type": "string" } @@ -4164,6 +4309,19 @@ }, "type": "object" }, + "StorageDatabasecenterPartnerapiV1mainUserLabels": { + "description": "Message type for storing user labels. User labels are used to tag App Engine resources, allowing users to search for resources matching a set of labels and to aggregate usage data by labels.", + "id": "StorageDatabasecenterPartnerapiV1mainUserLabels", + "properties": { + "labels": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "type": "object" + }, "StorageDatabasecenterProtoCommonProduct": { "description": "Product specification for Condor resources.", "id": "StorageDatabasecenterProtoCommonProduct", diff --git a/discovery/androidmanagement-v1.json b/discovery/androidmanagement-v1.json index fc5d634388..29f15933d8 100644 --- a/discovery/androidmanagement-v1.json +++ b/discovery/androidmanagement-v1.json @@ -1163,7 +1163,7 @@ } } }, - "revision": "20240221", + "revision": "20240320", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -2716,7 +2716,7 @@ "DISALLOW_USB_DATA_TRANSFER" ], "enumDescriptions": [ - "Unspecified. Defaults to ALLOW_USB_DATA_TRANSFER, unless usbFileTransferDisabled is set to true. If usbFileTransferDisabled is set to true, this is equivalent to DISALLOW_USB_FILE_TRANSFER.", + "Unspecified. Defaults to DISALLOW_USB_FILE_TRANSFER.", "All types of USB data transfers are allowed. usbFileTransferDisabled is ignored.", "Transferring files over USB is disallowed. Other types of USB data connections, such as mouse and keyboard connection, are allowed. usbFileTransferDisabled is ignored.", "When set, all types of USB data transfers are prohibited. Supported for devices running Android 12 or above with USB HAL 1.3 or above. If the setting is not supported, DISALLOW_USB_FILE_TRANSFER will be set. A nonComplianceDetail with API_LEVEL is reported if the Android version is less than 12. A nonComplianceDetail with DEVICE_INCOMPATIBLE is reported if the device does not have USB HAL 1.3 or above. usbFileTransferDisabled is ignored." @@ -2778,13 +2778,15 @@ "MINIMUM_WIFI_SECURITY_LEVEL_UNSPECIFIED", "OPEN_NETWORK_SECURITY", "PERSONAL_NETWORK_SECURITY", - "ENTERPRISE_NETWORK_SECURITY" + "ENTERPRISE_NETWORK_SECURITY", + "ENTERPRISE_BIT192_NETWORK_SECURITY" ], "enumDescriptions": [ "Defaults to OPEN_NETWORK_SECURITY, which means the device will be able to connect to all types of Wi-Fi networks.", "The device will be able to connect to all types of Wi-Fi networks.", "A personal network such as WEP, WPA2-PSK is the minimum required security. The device will not be able to connect to open wifi networks. This is stricter than OPEN_NETWORK_SECURITY. A nonComplianceDetail with API_LEVEL is reported if the Android version is less than 13.", - "An enterprise EAP network is the minimum required security level. The device will not be able to connect to Wi-Fi network below this security level. This is stricter than PERSONAL_NETWORK_SECURITY. A nonComplianceDetail with API_LEVEL is reported if the Android version is less than 13." + "An enterprise EAP network is the minimum required security level. The device will not be able to connect to Wi-Fi network below this security level. This is stricter than PERSONAL_NETWORK_SECURITY. A nonComplianceDetail with API_LEVEL is reported if the Android version is less than 13.", + "A 192-bit enterprise network is the minimum required security level. The device will not be able to connect to Wi-Fi network below this security level. This is stricter than ENTERPRISE_NETWORK_SECURITY. A nonComplianceDetail with API_LEVEL is reported if the Android version is less than 13." ], "type": "string" }, diff --git a/discovery/androidpublisher-v3.json b/discovery/androidpublisher-v3.json index 373ba60e1e..568e243127 100644 --- a/discovery/androidpublisher-v3.json +++ b/discovery/androidpublisher-v3.json @@ -2085,7 +2085,7 @@ ], "parameters": { "externalTransactionId": { - "description": "Required. The id to use for the external transaction. Must be unique across all other transactions for the app. This value should be 1-63 characters and valid characters are /a-z0-9_-/. Do not use this field to store any Personally Identifiable Information (PII) such as emails. Attempting to store PII in this field may result in requests being blocked.", + "description": "Required. The id to use for the external transaction. Must be unique across all other transactions for the app. This value should be 1-63 characters and valid characters are /a-zA-Z0-9_-/. Do not use this field to store any Personally Identifiable Information (PII) such as emails. Attempting to store PII in this field may result in requests being blocked.", "location": "query", "type": "string" }, @@ -4279,6 +4279,11 @@ "location": "query", "type": "string" }, + "includeQuantityBasedPartialRefund": { + "description": "Optional. Whether to include voided purchases of quantity-based partial refunds, which are applicable only to multi-quantity purchases. If true, additional voided purchases may be returned with voidedQuantity that indicates the refund quantity of a quantity-based partial refund. The default value is false.", + "location": "query", + "type": "boolean" + }, "maxResults": { "description": "Defines how many results the list operation should return. The default number depends on the resource collection.", "format": "uint32", @@ -4726,7 +4731,7 @@ } } }, - "revision": "20240313", + "revision": "20240321", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Abi": { @@ -7706,6 +7711,11 @@ "format": "int32", "type": "integer" }, + "refundableQuantity": { + "description": "The quantity eligible for refund, i.e. quantity that hasn't been refunded. The value reflects quantity-based partial refunds and full refunds.", + "format": "int32", + "type": "integer" + }, "regionCode": { "description": "ISO 3166-1 alpha-2 billing region code of the user at the time the product was granted.", "type": "string" @@ -9744,6 +9754,11 @@ "description": "The token which uniquely identifies a one-time purchase or subscription. To uniquely identify subscription renewals use order_id (available starting from version 3 of the API).", "type": "string" }, + "voidedQuantity": { + "description": "The voided quantity as the result of a quantity-based partial refund. Voided purchases of quantity-based partial refunds may only be returned when includeQuantityBasedPartialRefund is set to true.", + "format": "int32", + "type": "integer" + }, "voidedReason": { "description": "The reason why the purchase was voided, possible values are: 0. Other 1. Remorse 2. Not_received 3. Defective 4. Accidental_purchase 5. Fraud 6. Friendly_fraud 7. Chargeback", "format": "int32", diff --git a/discovery/apigee-v1.json b/discovery/apigee-v1.json index b1d1f5b96f..9b063791a1 100644 --- a/discovery/apigee-v1.json +++ b/discovery/apigee-v1.json @@ -10013,7 +10013,7 @@ } } }, - "revision": "20240312", + "revision": "20240318", "rootUrl": "https://apigee.googleapis.com/", "schemas": { "EdgeConfigstoreBundleBadBundle": { @@ -10115,6 +10115,21 @@ }, "type": "object" }, + "GoogleCloudApigeeV1AccessLoggingConfig": { + "description": "Access logging configuration enables customers to ship the access logs from the tenant projects to their own project's cloud logging. The feature is at the instance level ad disabled by default. It can be enabled during CreateInstance or UpdateInstance.", + "id": "GoogleCloudApigeeV1AccessLoggingConfig", + "properties": { + "enabled": { + "description": "Optional. Boolean flag that specifies whether the customer access log feature is enabled.", + "type": "boolean" + }, + "filter": { + "description": "Optional. Ship the access log entries that match the status_code defined in the filter. The status_code is the only expected/supported filter field. (Ex: status_code) The filter will parse it to the Common Expression Language semantics for expression evaluation to build the filter condition. (Ex: \"filter\": status_code >= 200 && status_code < 300 )", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1AccessRemove": { "description": "Remove action. For example, \"Remove\" : { \"name\" : \"target.name\", \"success\" : true }", "id": "GoogleCloudApigeeV1AccessRemove", @@ -13583,6 +13598,10 @@ "description": "Apigee runtime instance.", "id": "GoogleCloudApigeeV1Instance", "properties": { + "accessLoggingConfig": { + "$ref": "GoogleCloudApigeeV1AccessLoggingConfig", + "description": "Optional. Access logging configuration enables the access logging feature at the instance. Apigee customers can enable access logging to ship the access logs to their own project's cloud logging." + }, "consumerAcceptList": { "description": "Optional. Customer accept list represents the list of projects (id/number) on customer side that can privately connect to the service attachment. It is an optional field which the customers can provide during the instance creation. By default, the customer project associated with the Apigee organization will be included to the list.", "items": { diff --git a/discovery/assuredworkloads-v1.json b/discovery/assuredworkloads-v1.json index 4aeacc4494..b944d736b4 100644 --- a/discovery/assuredworkloads-v1.json +++ b/discovery/assuredworkloads-v1.json @@ -591,7 +591,7 @@ } } }, - "revision": "20231219", + "revision": "20240314", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest": { @@ -695,7 +695,8 @@ "CA_PROTECTED_B", "IL5", "IL2", - "JP_REGIONS_AND_SUPPORT" + "JP_REGIONS_AND_SUPPORT", + "KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS" ], "enumDescriptions": [ "Unknown compliance regime.", @@ -716,7 +717,8 @@ "Assured Workloads for Canada Protected B regime", "Information protection as per DoD IL5 requirements.", "Information protection as per DoD IL2 requirements.", - "Assured Workloads for Japan Regions" + "Assured Workloads for Japan Regions", + "KSA R5 Controls." ], "type": "string" }, @@ -1172,7 +1174,8 @@ "CA_PROTECTED_B", "IL5", "IL2", - "JP_REGIONS_AND_SUPPORT" + "JP_REGIONS_AND_SUPPORT", + "KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS" ], "enumDescriptions": [ "Unknown compliance regime.", @@ -1193,7 +1196,8 @@ "Assured Workloads for Canada Protected B regime", "Information protection as per DoD IL5 requirements.", "Information protection as per DoD IL2 requirements.", - "Assured Workloads for Japan Regions" + "Assured Workloads for Japan Regions", + "KSA R5 Controls." ], "type": "string" }, diff --git a/discovery/assuredworkloads-v1beta1.json b/discovery/assuredworkloads-v1beta1.json index 1b2d11287a..38a78d62f6 100644 --- a/discovery/assuredworkloads-v1beta1.json +++ b/discovery/assuredworkloads-v1beta1.json @@ -563,7 +563,7 @@ } } }, - "revision": "20231219", + "revision": "20240314", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationRequest": { @@ -667,7 +667,8 @@ "CA_PROTECTED_B", "IL5", "IL2", - "JP_REGIONS_AND_SUPPORT" + "JP_REGIONS_AND_SUPPORT", + "KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS" ], "enumDescriptions": [ "Unknown compliance regime.", @@ -688,7 +689,8 @@ "Assured Workloads for Canada Protected B regime", "Information protection as per DoD IL5 requirements.", "Information protection as per DoD IL2 requirements.", - "Assured Workloads for Japan Regions" + "Assured Workloads for Japan Regions", + "KSA R5 Controls." ], "type": "string" }, @@ -1136,7 +1138,8 @@ "CA_PROTECTED_B", "IL5", "IL2", - "JP_REGIONS_AND_SUPPORT" + "JP_REGIONS_AND_SUPPORT", + "KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS" ], "enumDescriptions": [ "Unknown compliance regime.", @@ -1157,7 +1160,8 @@ "Assured Workloads for Canada Protected B regime", "Information protection as per DoD IL5 requirements.", "Information protection as per DoD IL2 requirements.", - "Assured Workloads for Japan Regions" + "Assured Workloads for Japan Regions", + "KSA R5 Controls." ], "type": "string" }, diff --git a/discovery/batch-v1.json b/discovery/batch-v1.json index 7fce374cb9..2c4dccb5ef 100644 --- a/discovery/batch-v1.json +++ b/discovery/batch-v1.json @@ -12,7 +12,7 @@ "baseUrl": "https://batch.googleapis.com/", "batchPath": "batch", "canonicalName": "Batch", - "description": "An API to manage the running of batch resources on Google Cloud Platform.", + "description": "An API to manage the running of Batch resources on Google Cloud Platform.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/batch/", "fullyEncodeReservedExpansion": true, @@ -561,7 +561,7 @@ } } }, - "revision": "20240206", + "revision": "20240315", "rootUrl": "https://batch.googleapis.com/", "schemas": { "Accelerator": { @@ -907,7 +907,7 @@ "description": "Environment variables to set before running the Task." }, "maxRunDuration": { - "description": "Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit.", + "description": "Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit. The valid value range for max_run_duration in seconds is [0, 315576000000.999999999],", "format": "google-duration", "type": "string" }, @@ -2193,7 +2193,7 @@ "type": "integer" }, "maxRunDuration": { - "description": "Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit.", + "description": "Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit. The valid value range for max_run_duration in seconds is [0, 315576000000.999999999],", "format": "google-duration", "type": "string" }, diff --git a/discovery/bigqueryreservation-v1.json b/discovery/bigqueryreservation-v1.json index 4c73f131eb..5f3e21f5a1 100644 --- a/discovery/bigqueryreservation-v1.json +++ b/discovery/bigqueryreservation-v1.json @@ -579,6 +579,35 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "failoverReservation": { + "description": "Failover a reservation to the secondary location. The operation should be done in the current secondary location, which will be promoted to the new primary location for the reservation. Attempting to failover a reservation in the current primary location will fail with the error code `google.rpc.Code.FAILED_PRECONDITION`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}:failoverReservation", + "httpMethod": "POST", + "id": "bigqueryreservation.projects.locations.reservations.failoverReservation", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the reservation to failover. E.g., `projects/myproject/locations/US/reservations/team1-prod`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reservations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:failoverReservation", + "request": { + "$ref": "FailoverReservationRequest" + }, + "response": { + "$ref": "Reservation" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Returns information about the reservation.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}", @@ -851,7 +880,7 @@ } } }, - "revision": "20240306", + "revision": "20240321", "rootUrl": "https://bigqueryreservation.googleapis.com/", "schemas": { "Assignment": { @@ -1114,6 +1143,12 @@ "properties": {}, "type": "object" }, + "FailoverReservationRequest": { + "description": "The request for ReservationService.FailoverReservation.", + "id": "FailoverReservationRequest", + "properties": {}, + "type": "object" + }, "ListAssignmentsResponse": { "description": "The response for ReservationService.ListAssignments.", "id": "ListAssignmentsResponse", @@ -1244,6 +1279,18 @@ "description": "The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters.", "type": "string" }, + "originalPrimaryLocation": { + "description": "Optional. The original primary location of the reservation which is set only during its creation and remains unchanged afterwards. It can be used by the customer to answer questions about disaster recovery billing. The field is output only for customers and should not be specified, however, the google.api.field_behavior is not set to OUTPUT_ONLY since these fields are set in rerouted requests sent across regions.", + "type": "string" + }, + "primaryLocation": { + "description": "Optional. The primary location of the reservation. The field is only meaningful for reservation used for cross region disaster recovery. The field is output only for customers and should not be specified, however, the google.api.field_behavior is not set to OUTPUT_ONLY since these fields are set in rerouted requests sent across regions.", + "type": "string" + }, + "secondaryLocation": { + "description": "Optional. The secondary location of the reservation which is used for cross region disaster recovery purposes. Customer can set this in create/update reservation calls to create a failover reservation or convert a non-failover reservation to a failover reservation.", + "type": "string" + }, "slotCapacity": { "description": "Baseline slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false, or autoscaling is enabled. If edition is EDITION_UNSPECIFIED and total slot_capacity of the reservation and its siblings exceeds the total slot_count of all capacity commitments, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`. If edition is any value but EDITION_UNSPECIFIED, then the above requirement is not needed. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes.", "format": "int64", diff --git a/discovery/bigtableadmin-v2.json b/discovery/bigtableadmin-v2.json index 5567bdee07..787428e0dd 100644 --- a/discovery/bigtableadmin-v2.json +++ b/discovery/bigtableadmin-v2.json @@ -2098,13 +2098,17 @@ } } }, - "revision": "20240306", + "revision": "20240318", "rootUrl": "https://bigtableadmin.googleapis.com/", "schemas": { "AppProfile": { "description": "A configuration object describing how Cloud Bigtable should treat traffic from a particular end user application.", "id": "AppProfile", "properties": { + "dataBoostIsolationReadOnly": { + "$ref": "DataBoostIsolationReadOnly", + "description": "Specifies that this app profile is intended for read-only usage via the Data Boost feature." + }, "description": { "description": "Long form description of the use case for this AppProfile.", "type": "string" @@ -2409,6 +2413,14 @@ "consistencyToken": { "description": "Required. The token created using GenerateConsistencyToken for the Table.", "type": "string" + }, + "dataBoostReadLocalWrites": { + "$ref": "DataBoostReadLocalWrites", + "description": "Checks that reads using an app profile with `DataBoostIsolationReadOnly` can see all writes committed before the token was created, but only if the read and write target the same cluster." + }, + "standardReadRemoteWrites": { + "$ref": "StandardReadRemoteWrites", + "description": "Checks that reads using an app profile with `StandardIsolation` can see all writes committed before the token was created, even if the read and write target different clusters." } }, "type": "object" @@ -2559,6 +2571,10 @@ "$ref": "ColumnFamilyStats", "description": "Output only. Only available with STATS_VIEW, this includes summary statistics about column family contents. For statistics over an entire table, see TableStats above.", "readOnly": true + }, + "valueType": { + "$ref": "Type", + "description": "The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations" } }, "type": "object" @@ -2805,6 +2821,31 @@ }, "type": "object" }, + "DataBoostIsolationReadOnly": { + "description": "Data Boost is a serverless compute capability that lets you run high-throughput read jobs on your Bigtable data, without impacting the performance of the clusters that handle your application traffic. Currently, Data Boost exclusively supports read-only use-cases with single-cluster routing. Data Boost reads are only guaranteed to see the results of writes that were written at least 30 minutes ago. This means newly written values may not become visible for up to 30m, and also means that old values may remain visible for up to 30m after being deleted or overwritten. To mitigate the staleness of the data, users may either wait 30m, or use CheckConsistency.", + "id": "DataBoostIsolationReadOnly", + "properties": { + "computeBillingOwner": { + "description": "The Compute Billing Owner for this Data Boost App Profile.", + "enum": [ + "COMPUTE_BILLING_OWNER_UNSPECIFIED", + "HOST_PAYS" + ], + "enumDescriptions": [ + "Unspecified value.", + "The host Cloud Project containing the targeted Bigtable Instance / Table pays for compute." + ], + "type": "string" + } + }, + "type": "object" + }, + "DataBoostReadLocalWrites": { + "description": "Checks that all writes before the consistency token was generated in the same cluster are readable by Databoost.", + "id": "DataBoostReadLocalWrites", + "properties": {}, + "type": "object" + }, "DropRowRangeRequest": { "description": "Request message for google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange", "id": "DropRowRangeRequest", @@ -3003,6 +3044,93 @@ }, "type": "object" }, + "GoogleBigtableAdminV2TypeAggregate": { + "description": "A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` .", + "id": "GoogleBigtableAdminV2TypeAggregate", + "properties": { + "inputType": { + "$ref": "Type", + "description": "Type of the inputs that are accumulated by this `Aggregate`, which must specify a full encoding. Use `AddInput` mutations to accumulate new inputs." + }, + "stateType": { + "$ref": "Type", + "description": "Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen, and will always specify a full encoding.", + "readOnly": true + }, + "sum": { + "$ref": "GoogleBigtableAdminV2TypeAggregateSum", + "description": "Sum aggregator." + } + }, + "type": "object" + }, + "GoogleBigtableAdminV2TypeAggregateSum": { + "description": "Computes the sum of the input values. Allowed input: `Int64` State: same as input", + "id": "GoogleBigtableAdminV2TypeAggregateSum", + "properties": {}, + "type": "object" + }, + "GoogleBigtableAdminV2TypeBytes": { + "description": "Bytes Values of type `Bytes` are stored in `Value.bytes_value`.", + "id": "GoogleBigtableAdminV2TypeBytes", + "properties": { + "encoding": { + "$ref": "GoogleBigtableAdminV2TypeBytesEncoding", + "description": "The encoding to use when converting to/from lower level types." + } + }, + "type": "object" + }, + "GoogleBigtableAdminV2TypeBytesEncoding": { + "description": "Rules used to convert to/from lower level types.", + "id": "GoogleBigtableAdminV2TypeBytesEncoding", + "properties": { + "raw": { + "$ref": "GoogleBigtableAdminV2TypeBytesEncodingRaw", + "description": "Use `Raw` encoding." + } + }, + "type": "object" + }, + "GoogleBigtableAdminV2TypeBytesEncodingRaw": { + "description": "Leaves the value \"as-is\" * Natural sort? Yes * Self-delimiting? No * Compatibility? N/A", + "id": "GoogleBigtableAdminV2TypeBytesEncodingRaw", + "properties": {}, + "type": "object" + }, + "GoogleBigtableAdminV2TypeInt64": { + "description": "Int64 Values of type `Int64` are stored in `Value.int_value`.", + "id": "GoogleBigtableAdminV2TypeInt64", + "properties": { + "encoding": { + "$ref": "GoogleBigtableAdminV2TypeInt64Encoding", + "description": "The encoding to use when converting to/from lower level types." + } + }, + "type": "object" + }, + "GoogleBigtableAdminV2TypeInt64Encoding": { + "description": "Rules used to convert to/from lower level types.", + "id": "GoogleBigtableAdminV2TypeInt64Encoding", + "properties": { + "bigEndianBytes": { + "$ref": "GoogleBigtableAdminV2TypeInt64EncodingBigEndianBytes", + "description": "Use `BigEndianBytes` encoding." + } + }, + "type": "object" + }, + "GoogleBigtableAdminV2TypeInt64EncodingBigEndianBytes": { + "description": "Encodes the value as an 8-byte big endian twos complement `Bytes` value. * Natural sort? No (positive values only) * Self-delimiting? Yes * Compatibility? - BigQuery Federation `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN`", + "id": "GoogleBigtableAdminV2TypeInt64EncodingBigEndianBytes", + "properties": { + "bytesType": { + "$ref": "GoogleBigtableAdminV2TypeBytes", + "description": "The underlying `Bytes` type, which may be able to encode further." + } + }, + "type": "object" + }, "HotTablet": { "description": "A tablet is a defined by a start and end key and is explained in https://cloud.google.com/bigtable/docs/overview#architecture and https://cloud.google.com/bigtable/docs/performance#optimization. A Hot tablet is a tablet that exhibits high average cpu usage during the time interval from start time to end time.", "id": "HotTablet", @@ -3691,6 +3819,12 @@ }, "type": "object" }, + "StandardReadRemoteWrites": { + "description": "Checks that all writes before the consistency token was generated are replicated in every cluster and readable.", + "id": "StandardReadRemoteWrites", + "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", @@ -3867,6 +4001,25 @@ }, "type": "object" }, + "Type": { + "description": "`Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. This might involve composing a series of steps into an \"encoding chain,\" for example to convert from INT64 -> STRING -> raw bytes. In most cases, a \"link\" in the encoding chain will be based an on existing GoogleSQL conversion function like `CAST`. Each link in the encoding chain also defines the following properties: * Natural sort: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: STRING values sort in the same order as their UTF-8 encodings. - Counterexample: Encoding INT64 to a fixed-width STRING does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING(\"-00001\") > STRING(\"00001). - The overall encoding chain sorts naturally if *every* link does. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. - The overall encoding chain is self-delimiting if *any* link is. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java?", + "id": "Type", + "properties": { + "aggregateType": { + "$ref": "GoogleBigtableAdminV2TypeAggregate", + "description": "Aggregate" + }, + "bytesType": { + "$ref": "GoogleBigtableAdminV2TypeBytes", + "description": "Bytes" + }, + "int64Type": { + "$ref": "GoogleBigtableAdminV2TypeInt64", + "description": "Int64" + } + }, + "type": "object" + }, "UndeleteTableMetadata": { "description": "Metadata type for the operation returned by google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTable.", "id": "UndeleteTableMetadata", diff --git a/discovery/certificatemanager-v1.json b/discovery/certificatemanager-v1.json index 14ac07a0fb..5eba355778 100644 --- a/discovery/certificatemanager-v1.json +++ b/discovery/certificatemanager-v1.json @@ -1280,9 +1280,20 @@ } } }, - "revision": "20240209", + "revision": "20240313", "rootUrl": "https://certificatemanager.googleapis.com/", "schemas": { + "AllowlistedCertificate": { + "description": "Defines an allowlisted certificate.", + "id": "AllowlistedCertificate", + "properties": { + "pemCertificate": { + "description": "Required. PEM certificate that is allowlisted. The certificate can be up to 5k bytes, and must be a parseable X.509 certificate.", + "type": "string" + } + }, + "type": "object" + }, "AuthorizationAttemptInfo": { "description": "State of the latest attempt to authorize a domain for certificate issuance.", "id": "AuthorizationAttemptInfo", @@ -2185,6 +2196,13 @@ "description": "Defines a trust config.", "id": "TrustConfig", "properties": { + "allowlistedCertificates": { + "description": "Optional. A certificate matching an allowlisted certificate is always considered valid as long as the certificate is parseable, proof of private key possession is established, and constraints on the certificate’s SAN field are met.", + "items": { + "$ref": "AllowlistedCertificate" + }, + "type": "array" + }, "createTime": { "description": "Output only. The creation timestamp of a TrustConfig.", "format": "google-datetime", diff --git a/discovery/chat-v1.json b/discovery/chat-v1.json index 453a8f21ad..b285500a25 100644 --- a/discovery/chat-v1.json +++ b/discovery/chat-v1.json @@ -990,7 +990,7 @@ } } }, - "revision": "20240310", + "revision": "20240319", "rootUrl": "https://chat.googleapis.com/", "schemas": { "ActionParameter": { @@ -1559,7 +1559,7 @@ "type": "object" }, "DeprecatedEvent": { - "description": "A Google Chat app interaction event. To learn about interaction events, see [Receive and respond to interactions with your Google Chat app](https://developers.google.com/chat/api/guides/message-formats). To learn about event types and for example event payloads, see [Types of Google Chat app interaction events](https://developers.google.com/chat/api/guides/message-formats/events).", + "description": "A Google Chat app interaction event. To learn about interaction events, see [Receive and respond to interactions with your Google Chat app](https://developers.google.com/workspace/chat/api/guides/message-formats). To learn about event types and for example event payloads, see [Types of Google Chat app interaction events](https://developers.google.com/workspace/chat/events). In addition to receiving events from user interactions, Chat apps can receive events about changes to spaces, such as when a new member is added to a space. To learn about space events, see [Work with events from Google Chat](https://developers.google.com/workspace/chat/events-overview).", "id": "DeprecatedEvent", "properties": { "action": { @@ -1616,7 +1616,7 @@ "type": "string" }, "type": { - "description": "The type of interaction event. For details, see [Types of Google Chat app interaction events](https://developers.google.com/chat/api/guides/message-formats/events).", + "description": "The type of interaction event. For details, see [Types of Google Chat app interaction events](https://developers.google.com/workspace/chat/events).", "enum": [ "UNSPECIFIED", "MESSAGE", @@ -2282,6 +2282,10 @@ "knownIcon": { "description": "Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/chat/format-messages#builtinicons).", "type": "string" + }, + "materialIcon": { + "$ref": "GoogleAppsCardV1MaterialIcon", + "description": "Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use \"material_icon\": { \"name\": \"check_box\" } Available for Chat apps and in [Developer Preview](https://developers.google.com/workspace/preview) for Google Workspace Add-ons." } }, "type": "object" @@ -2358,6 +2362,31 @@ }, "type": "object" }, + "GoogleAppsCardV1MaterialIcon": { + "description": "A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write { \"name\": \"check_box\", \"fill\": true, \"weight\": 300, \"grade\": -25 } Available for Chat apps and in [Developer Preview](https://developers.google.com/workspace/preview) for Google Workspace Add-ons.", + "id": "GoogleAppsCardV1MaterialIcon", + "properties": { + "fill": { + "description": "Whether it renders a filled icon. Default value is false. See Customization in [Google Font Icon](https://fonts.google.com/icons) for details.", + "type": "boolean" + }, + "grade": { + "description": "Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, a broken image icon is displayed. See Customization in [Google Font Icon](https://fonts.google.com/icons) for details.", + "format": "int32", + "type": "integer" + }, + "name": { + "description": "The icon name defined in the [Google Material Icon Icon](https://fonts.google.com/icons) in snake_case. e.g. \"check_box\". Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.", + "type": "string" + }, + "weight": { + "description": "The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, a broken image icon is displayed. See Customization in [Google Font Icon](https://fonts.google.com/icons) for details.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleAppsCardV1OnClick": { "description": "Represents how to respond when users click an interactive element on a card, such as a button. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", "id": "GoogleAppsCardV1OnClick", diff --git a/discovery/checks-v1alpha.json b/discovery/checks-v1alpha.json index 296f619035..68f8b3f739 100644 --- a/discovery/checks-v1alpha.json +++ b/discovery/checks-v1alpha.json @@ -414,7 +414,7 @@ } } }, - "revision": "20240312", + "revision": "20240321", "rootUrl": "https://checks.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -796,7 +796,9 @@ "QUEBEC_ACT", "QUEBEC_BILL_64", "CHINA_PIPL", - "SOUTH_KOREA_PIPA" + "SOUTH_KOREA_PIPA", + "SOUTH_AFRICA_POPIA", + "JAPAN_APPI" ], "enumDescriptions": [ "Not specified.", @@ -819,7 +821,9 @@ "Quebec: Act Respecting the Protection of Personal Information in the Private Sector.", "Quebec Bill 64: An Act to Modernize Legislative Provisions as Regards the Protection of Personal Information.", "China Personal Information Protection Law.", - "South Korea Personal Information Protection Act." + "South Korea Personal Information Protection Act.", + "South Africa Protection of Personal Information Act.", + "Japan Act on the Protection of Personal Information." ], "type": "string" } diff --git a/discovery/chromemanagement-v1.json b/discovery/chromemanagement-v1.json index bdf519ae2b..32f3440fe8 100644 --- a/discovery/chromemanagement-v1.json +++ b/discovery/chromemanagement-v1.json @@ -376,6 +376,46 @@ "https://www.googleapis.com/auth/chrome.management.reports.readonly" ] }, + "countChromeCrashEvents": { + "description": "Get a count of Chrome crash events.", + "flatPath": "v1/customers/{customersId}/reports:countChromeCrashEvents", + "httpMethod": "GET", + "id": "chromemanagement.customers.reports.countChromeCrashEvents", + "parameterOrder": [ + "customer" + ], + "parameters": { + "customer": { + "description": "Customer ID.", + "location": "path", + "pattern": "^customers/[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Query string to filter results, AND-separated fields in EBNF syntax. Supported filter fields: * major_browser_version * minor_browser_version * browser_channel * device_platform * past_number_days Example: `major_browser_version = 'M115' AND past_number_days = '28'`.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field used to order results. Supported order by fields: * browser_version * count * date", + "location": "query", + "type": "string" + }, + "orgUnitId": { + "description": "If specified, only count the number of crash events of the devices in this organizational unit.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+customer}/reports:countChromeCrashEvents", + "response": { + "$ref": "GoogleChromeManagementV1CountChromeCrashEventsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/chrome.management.reports.readonly" + ] + }, "countChromeDevicesReachingAutoExpirationDate": { "description": "Generate report of the number of devices expiring in each month of the selected time frame. Devices are grouped by auto update expiration date and model. Further information can be found [here](https://support.google.com/chrome/a/answer/10564947).", "flatPath": "v1/customers/{customersId}/reports:countChromeDevicesReachingAutoExpirationDate", @@ -862,7 +902,7 @@ ], "parameters": { "filter": { - "description": "Optional. Only include resources that match the filter. Supported filter fields: - org_unit_id - serial_number - device_id - reports_timestamp The \"reports_timestamp\" filter accepts either the Unix Epoch milliseconds format or the RFC3339 UTC \"Zulu\" format with nanosecond resolution and up to nine fractional digits. Both formats should be surrounded by simple double quotes. Examples: \"2014-10-02T15:01:23Z\", \"2014-10-02T15:01:23.045123456Z\", \"1679283943823\".", + "description": "Optional. Only include resources that match the filter. Requests that don't specify a \"reports_timestamp\" value will default to returning only recent reports. Specify \"reports_timestamp>=0\" to get all report data. Supported filter fields: - org_unit_id - serial_number - device_id - reports_timestamp The \"reports_timestamp\" filter accepts either the Unix Epoch milliseconds format or the RFC3339 UTC \"Zulu\" format with nanosecond resolution and up to nine fractional digits. Both formats should be surrounded by simple double quotes. Examples: \"2014-10-02T15:01:23Z\", \"2014-10-02T15:01:23.045123456Z\", \"1679283943823\".", "location": "query", "type": "string" }, @@ -1132,7 +1172,7 @@ } } }, - "revision": "20240312", + "revision": "20240321", "rootUrl": "https://chromemanagement.googleapis.com/", "schemas": { "GoogleChromeManagementV1AndroidAppInfo": { @@ -1792,6 +1832,40 @@ }, "type": "object" }, + "GoogleChromeManagementV1CountChromeCrashEventsResponse": { + "description": "Response contains a list of CrashEventCountByVersionPerDay which count the chrome crash at the certain date.", + "id": "GoogleChromeManagementV1CountChromeCrashEventsResponse", + "properties": { + "crashEventCounts": { + "description": "Crash event counts grouped by date and browser version.", + "items": { + "$ref": "GoogleChromeManagementV1CountChromeCrashEventsResponseCrashEventCount" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleChromeManagementV1CountChromeCrashEventsResponseCrashEventCount": { + "description": "The `count` of the Chrome crash events at the `date`.", + "id": "GoogleChromeManagementV1CountChromeCrashEventsResponseCrashEventCount", + "properties": { + "browserVersion": { + "description": "Browser version this is counting.", + "type": "string" + }, + "count": { + "description": "Total count of crash events.", + "format": "int64", + "type": "string" + }, + "date": { + "$ref": "GoogleTypeDate", + "description": "Date of the crash event." + } + }, + "type": "object" + }, "GoogleChromeManagementV1CountChromeDevicesReachingAutoExpirationDateResponse": { "description": "Response containing a list of devices expiring in each month of a selected time frame. Counts are grouped by model and Auto Update Expiration date.", "id": "GoogleChromeManagementV1CountChromeDevicesReachingAutoExpirationDateResponse", diff --git a/discovery/cloudbilling-v1beta.json b/discovery/cloudbilling-v1beta.json index b262a54667..ba0cde585b 100644 --- a/discovery/cloudbilling-v1beta.json +++ b/discovery/cloudbilling-v1beta.json @@ -145,80 +145,6 @@ } }, "resources": { - "anomalies": { - "methods": { - "get": { - "description": "Gets an anomaly for a billing account or a project.", - "flatPath": "v1beta/billingAccounts/{billingAccountsId}/anomalies/{anomaliesId}", - "httpMethod": "GET", - "id": "cloudbilling.billingAccounts.anomalies.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Format for project: projects/{project}/anomalies/{anomalies}. Format for billing account: billingAccounts/{billing_account}/anomalies/{anomalies}.", - "location": "path", - "pattern": "^billingAccounts/[^/]+/anomalies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta/{+name}", - "response": { - "$ref": "GoogleCloudBillingAnomaliesV1betaAnomaly" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-billing", - "https://www.googleapis.com/auth/cloud-billing.readonly", - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists anomalies for a billing account or a project.", - "flatPath": "v1beta/billingAccounts/{billingAccountsId}/anomalies", - "httpMethod": "GET", - "id": "cloudbilling.billingAccounts.anomalies.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. Options for how to filter the anomalies. Currently, only filter on `start_time` and `end_time` is supported. Only =, AND operators are supported. If start_time and/or end_time empty, we only retrieve the most recent 30 days' anomalies. Examples: - start_time = \"20231201\" AND end_time = \"20240120\" .", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. Maximum number of anomalies to return. Results may return fewer than this value. Default value is 50 and maximum value is 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. Page token received from a previous ListAnomalies call to retrieve the next page of results. If this field is empty, the first page is returned.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The project to list Anomaly for the project. Format for project: projects/{project}. Format for billing account: billingAccounts/{billing_account}.", - "location": "path", - "pattern": "^billingAccounts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta/{+parent}/anomalies", - "response": { - "$ref": "GoogleCloudBillingAnomaliesV1betaListAnomaliesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-billing", - "https://www.googleapis.com/auth/cloud-billing.readonly", - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, "services": { "methods": { "get": { @@ -589,84 +515,6 @@ } } }, - "projects": { - "resources": { - "anomalies": { - "methods": { - "get": { - "description": "Gets an anomaly for a billing account or a project.", - "flatPath": "v1beta/projects/{projectsId}/anomalies/{anomaliesId}", - "httpMethod": "GET", - "id": "cloudbilling.projects.anomalies.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Format for project: projects/{project}/anomalies/{anomalies}. Format for billing account: billingAccounts/{billing_account}/anomalies/{anomalies}.", - "location": "path", - "pattern": "^projects/[^/]+/anomalies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta/{+name}", - "response": { - "$ref": "GoogleCloudBillingAnomaliesV1betaAnomaly" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-billing", - "https://www.googleapis.com/auth/cloud-billing.readonly", - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists anomalies for a billing account or a project.", - "flatPath": "v1beta/projects/{projectsId}/anomalies", - "httpMethod": "GET", - "id": "cloudbilling.projects.anomalies.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. Options for how to filter the anomalies. Currently, only filter on `start_time` and `end_time` is supported. Only =, AND operators are supported. If start_time and/or end_time empty, we only retrieve the most recent 30 days' anomalies. Examples: - start_time = \"20231201\" AND end_time = \"20240120\" .", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. Maximum number of anomalies to return. Results may return fewer than this value. Default value is 50 and maximum value is 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. Page token received from a previous ListAnomalies call to retrieve the next page of results. If this field is empty, the first page is returned.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The project to list Anomaly for the project. Format for project: projects/{project}. Format for billing account: billingAccounts/{billing_account}.", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta/{+parent}/anomalies", - "response": { - "$ref": "GoogleCloudBillingAnomaliesV1betaListAnomaliesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-billing", - "https://www.googleapis.com/auth/cloud-billing.readonly", - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - }, "skuGroups": { "methods": { "get": { @@ -910,7 +758,7 @@ } } }, - "revision": "20240311", + "revision": "20240315", "rootUrl": "https://cloudbilling.googleapis.com/", "schemas": { "CacheFillRegions": { @@ -1471,159 +1319,6 @@ }, "type": "object" }, - "GoogleCloudBillingAnomaliesV1betaAnomaly": { - "description": "Encapsulates an anomaly.", - "id": "GoogleCloudBillingAnomaliesV1betaAnomaly", - "properties": { - "detectionTime": { - "description": "Time that the anomaly was detected. Will be set to 00:00 google time of the detected date.", - "format": "google-datetime", - "type": "string" - }, - "deviation": { - "$ref": "GoogleCloudBillingAnomaliesV1betaAnomalyDeviation", - "description": "Deviation information of the anomaly." - }, - "name": { - "description": "Identifier. Resource name for the anomaly.", - "type": "string" - }, - "resourceDisplayName": { - "description": "The display name of the resource that the anomaly occurred in/belongs to.", - "type": "string" - }, - "rootCauses": { - "description": "A list of causes which contribute to the anomaly.", - "items": { - "$ref": "GoogleCloudBillingAnomaliesV1betaCause" - }, - "type": "array" - }, - "scope": { - "description": "Indicate the scope of the anomaly.", - "enum": [ - "SCOPE_UNSPECIFIED", - "SCOPE_BILLING_ACCOUNT", - "SCOPE_PROJECT" - ], - "enumDescriptions": [ - "Default unspecified value.", - "Indicates the anomaly is for a billing account.", - "Indicates the anomaly is for a project." - ], - "type": "string" - }, - "severity": { - "description": "Severity of the anomaly. Unspecified if severity is not met/assigned.", - "enum": [ - "ANOMALY_SEVERITY_UNSPECIFIED", - "ANOMALY_SEVERITY_LOW", - "ANOMALY_SEVERITY_MEDIUM", - "ANOMALY_SEVERITY_HIGH" - ], - "enumDescriptions": [ - "Default unspecified value.", - "Indicates the anomaly's severity is low.", - "Indicates the anomaly's severity is medium.", - "Indicates the anomaly's severity is high." - ], - "type": "string" - }, - "updateTime": { - "description": "Output only. The most recent anomaly's last updated time.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudBillingAnomaliesV1betaAnomalyDeviation": { - "description": "Encapsulates the deviation information.", - "id": "GoogleCloudBillingAnomaliesV1betaAnomalyDeviation", - "properties": { - "actualSpend": { - "$ref": "Money", - "description": "The actual spend for the anomaly." - }, - "deviationAmount": { - "$ref": "Money", - "description": "The difference between the actual spend and expected spend's upper bound. Calculation formula: deviation_amount = actual_spend - expected_spend." - }, - "deviationPercentage": { - "description": "The percentage of devition amount from expected spend's upper bound. Calculation formula: deviation_percentage = divation_amount / expected_spend * 100.", - "format": "double", - "type": "number" - }, - "expectedSpend": { - "$ref": "Money", - "description": "The expected spend for the anomaly." - } - }, - "type": "object" - }, - "GoogleCloudBillingAnomaliesV1betaCause": { - "description": "Encapsulates the information of the reason which caused the anomaly.", - "id": "GoogleCloudBillingAnomaliesV1betaCause", - "properties": { - "causeType": { - "description": "The cause type.", - "enum": [ - "CAUSE_TYPE_UNSPECIFIED", - "CAUSE_TYPE_PROJECT", - "CAUSE_TYPE_SERVICE", - "CAUSE_TYPE_SKU", - "CAUSE_TYPE_LOCATION" - ], - "enumDescriptions": [ - "Default unspecified value.", - "Caused by a project.", - "Caused by a service.", - "Caused by a SKU.", - "Caused by a location." - ], - "type": "string" - }, - "deviation": { - "$ref": "GoogleCloudBillingAnomaliesV1betaAnomalyDeviation", - "description": "The deviation information for the cause." - }, - "displayName": { - "description": "The display name of the cause.", - "type": "string" - }, - "resource": { - "description": "The resource name of the cause. project: projects/{project}. service: services/{service}. sku: services/{service}/skus/{sku}. location: locations/{location}.", - "type": "string" - }, - "subCauses": { - "description": "The sub causes.", - "items": { - "$ref": "GoogleCloudBillingAnomaliesV1betaCause" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudBillingAnomaliesV1betaListAnomaliesResponse": { - "description": "Response message for ListAnomalies.", - "id": "GoogleCloudBillingAnomaliesV1betaListAnomaliesResponse", - "properties": { - "anomalies": { - "description": "The returned anomalies.", - "items": { - "$ref": "GoogleCloudBillingAnomaliesV1betaAnomaly" - }, - "type": "array" - }, - "nextPageToken": { - "description": "Token that can be sent as `page_token` in the subsequent request to retrieve the next page. If this field is empty, there are no subsequent pages.", - "type": "string" - } - }, - "type": "object" - }, "GoogleCloudBillingBillingaccountpricesV1betaAggregationInfo": { "description": "Encapsulates the aggregation information such as aggregation level and interval for a billing account price.", "id": "GoogleCloudBillingBillingaccountpricesV1betaAggregationInfo", diff --git a/discovery/cloudbuild-v2.json b/discovery/cloudbuild-v2.json index 4c382ba710..61bca89ed3 100644 --- a/discovery/cloudbuild-v2.json +++ b/discovery/cloudbuild-v2.json @@ -671,7 +671,7 @@ ], "parameters": { "pageSize": { - "description": "Optional. Number of results to return in the list. Default to 100.", + "description": "Optional. Number of results to return in the list. Default to 20.", "format": "int32", "location": "query", "type": "integer" @@ -844,7 +844,7 @@ } } }, - "revision": "20240310", + "revision": "20240314", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/discovery/clouderrorreporting-v1beta1.json b/discovery/clouderrorreporting-v1beta1.json index 55825afe25..4d0e65484c 100644 --- a/discovery/clouderrorreporting-v1beta1.json +++ b/discovery/clouderrorreporting-v1beta1.json @@ -214,7 +214,7 @@ ] }, "report": { - "description": "Report an individual error event and record the event to a log. This endpoint accepts **either** an OAuth token, **or** an [API key](https://support.google.com/cloud/answer/6158862) for authentication. To use an API key, append it to the URL as the value of a `key` parameter. For example: `POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName}/events:report?key=123ABC456` **Note:** [Error Reporting] (https://cloud.google.com/error-reporting) is a global service built on Cloud Logging and doesn't analyze logs stored in regional log buckets or logs routed to other Google Cloud projects.", + "description": "Report an individual error event and record the event to a log. This endpoint accepts **either** an OAuth token, **or** an [API key](https://support.google.com/cloud/answer/6158862) for authentication. To use an API key, append it to the URL as the value of a `key` parameter. For example: `POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName}/events:report?key=123ABC456` **Note:** [Error Reporting] (https://cloud.google.com/error-reporting) is a global service built on Cloud Logging and doesn't analyze logs stored in regional log buckets.", "flatPath": "v1beta1/projects/{projectsId}/events:report", "httpMethod": "POST", "id": "clouderrorreporting.projects.events.report", @@ -431,7 +431,7 @@ } } }, - "revision": "20231106", + "revision": "20240315", "rootUrl": "https://clouderrorreporting.googleapis.com/", "schemas": { "DeleteEventsResponse": { diff --git a/discovery/cloudsupport-v2beta.json b/discovery/cloudsupport-v2beta.json index 734b6c8bfd..b973a1aa48 100644 --- a/discovery/cloudsupport-v2beta.json +++ b/discovery/cloudsupport-v2beta.json @@ -125,26 +125,6 @@ "location": "query", "type": "string" }, - "product.productLine": { - "description": "The Product Line of the Product.", - "enum": [ - "PRODUCT_LINE_UNSPECIFIED", - "GOOGLE_CLOUD", - "GOOGLE_MAPS" - ], - "enumDescriptions": [ - "Unknown product type.", - "Google Cloud", - "Google Maps" - ], - "location": "query", - "type": "string" - }, - "product.productSubline": { - "description": "The Product Subline of the Product, such as \"Maps Billing\".", - "location": "query", - "type": "string" - }, "query": { "description": "An expression used to filter case classifications. If it's an empty string, then no filtering happens. Otherwise, case classifications will be returned that match the filter.", "location": "query", @@ -303,21 +283,6 @@ "pattern": "^[^/]+/[^/]+$", "required": true, "type": "string" - }, - "productLine": { - "description": "The product line for which to request cases for. If unspecified, only Google Cloud cases will be returned.", - "enum": [ - "PRODUCT_LINE_UNSPECIFIED", - "GOOGLE_CLOUD", - "GOOGLE_MAPS" - ], - "enumDescriptions": [ - "Unknown product type.", - "Google Cloud", - "Google Maps" - ], - "location": "query", - "type": "string" } }, "path": "v2beta/{+parent}/cases", @@ -583,7 +548,7 @@ } } }, - "revision": "20240312", + "revision": "20240320", "rootUrl": "https://cloudsupport.googleapis.com/", "schemas": { "Actor": { @@ -818,10 +783,6 @@ "id": { "description": "The unique ID for a classification. Must be specified for case creation. To retrieve valid classification IDs for case creation, use `caseClassifications.search`. Classification IDs returned by `caseClassifications.search` are guaranteed to be valid for at least 6 months. If a given classification is deactiveated, it will immediately stop being returned. After 6 months, `case.create` requests using the classification ID will fail.", "type": "string" - }, - "product": { - "$ref": "Product", - "description": "The full product the classification corresponds to." } }, "type": "object" @@ -1367,31 +1328,6 @@ }, "type": "object" }, - "Product": { - "description": "The full product a case may be associated with, including Product Line and Product Subline.", - "id": "Product", - "properties": { - "productLine": { - "description": "The Product Line of the Product.", - "enum": [ - "PRODUCT_LINE_UNSPECIFIED", - "GOOGLE_CLOUD", - "GOOGLE_MAPS" - ], - "enumDescriptions": [ - "Unknown product type.", - "Google Cloud", - "Google Maps" - ], - "type": "string" - }, - "productSubline": { - "description": "The Product Subline of the Product, such as \"Maps Billing\".", - "type": "string" - } - }, - "type": "object" - }, "SearchCaseClassificationsResponse": { "description": "The response message for SearchCaseClassifications endpoint.", "id": "SearchCaseClassificationsResponse", diff --git a/discovery/composer-v1.json b/discovery/composer-v1.json index d017c22747..a8951304b6 100644 --- a/discovery/composer-v1.json +++ b/discovery/composer-v1.json @@ -938,7 +938,7 @@ } } }, - "revision": "20240227", + "revision": "20240317", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AirflowMetadataRetentionPolicyConfig": { @@ -1134,7 +1134,7 @@ "type": "object" }, "DagProcessorResource": { - "description": "Configuration for resources used by Airflow DAG processors.", + "description": "Configuration for resources used by Airflow DAG processors. This field is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.", "id": "DagProcessorResource", "properties": { "count": { @@ -1166,7 +1166,7 @@ "properties": { "airflowMetadataRetentionConfig": { "$ref": "AirflowMetadataRetentionPolicyConfig", - "description": "Optional. The retention policy for airflow metadata database. Details: go/composer-database-retention-2" + "description": "Optional. The retention policy for airflow metadata database." }, "taskLogsRetentionConfig": { "$ref": "TaskLogsRetentionConfig", @@ -1357,7 +1357,7 @@ }, "maintenanceWindow": { "$ref": "MaintenanceWindow", - "description": "Optional. The maintenance window is the period when Cloud Composer components may undergo maintenance. It is defined so that maintenance is not executed during peak hours or critical time periods. The system will not be under maintenance for every occurrence of this window, but when maintenance is planned, it will be scheduled during the window. The maintenance window period must encompass at least 12 hours per week. This may be split into multiple chunks, each with a size of at least 4 hours. If this value is omitted, the default value for maintenance window will be applied. The default value is Saturday and Sunday 00-06 GMT." + "description": "Optional. The maintenance window is the period when Cloud Composer components may undergo maintenance. It is defined so that maintenance is not executed during peak hours or critical time periods. The system will not be under maintenance for every occurrence of this window, but when maintenance is planned, it will be scheduled during the window. The maintenance window period must encompass at least 12 hours per week. This may be split into multiple chunks, each with a size of at least 4 hours. If this value is omitted, the default value for maintenance window is applied. By default, maintenance windows are from 00:00:00 to 04:00:00 (GMT) on Friday, Saturday, and Sunday every week." }, "masterAuthorizedNetworksConfig": { "$ref": "MasterAuthorizedNetworksConfig", @@ -2280,7 +2280,7 @@ "id": "TaskLogsRetentionConfig", "properties": { "storageMode": { - "description": "Optional. The mode of storage for Airflow workers task logs. For details, see go/composer-store-task-logs-in-cloud-logging-only-design-doc", + "description": "Optional. The mode of storage for Airflow workers task logs.", "enum": [ "TASK_LOGS_STORAGE_MODE_UNSPECIFIED", "CLOUD_LOGGING_AND_CLOUD_STORAGE", diff --git a/discovery/composer-v1beta1.json b/discovery/composer-v1beta1.json index 7e8fe4f1e5..e0749f6893 100644 --- a/discovery/composer-v1beta1.json +++ b/discovery/composer-v1beta1.json @@ -994,7 +994,7 @@ } } }, - "revision": "20240227", + "revision": "20240317", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AirflowMetadataRetentionPolicyConfig": { @@ -1201,7 +1201,7 @@ "type": "object" }, "DagProcessorResource": { - "description": "Configuration for resources used by Airflow DAG processors.", + "description": "Configuration for resources used by Airflow DAG processors. This field is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.", "id": "DagProcessorResource", "properties": { "count": { @@ -1436,7 +1436,7 @@ }, "maintenanceWindow": { "$ref": "MaintenanceWindow", - "description": "Optional. The maintenance window is the period when Cloud Composer components may undergo maintenance. It is defined so that maintenance is not executed during peak hours or critical time periods. The system will not be under maintenance for every occurrence of this window, but when maintenance is planned, it will be scheduled during the window. The maintenance window period must encompass at least 12 hours per week. This may be split into multiple chunks, each with a size of at least 4 hours. If this value is omitted, Cloud Composer components may be subject to maintenance at any time." + "description": "Optional. The maintenance window is the period when Cloud Composer components may undergo maintenance. It is defined so that maintenance is not executed during peak hours or critical time periods. The system will not be under maintenance for every occurrence of this window, but when maintenance is planned, it will be scheduled during the window. The maintenance window period must encompass at least 12 hours per week. This may be split into multiple chunks, each with a size of at least 4 hours. If this value is omitted, the default value for maintenance window is applied. By default, maintenance windows are from 00:00:00 to 04:00:00 (GMT) on Friday, Saturday, and Sunday every week." }, "masterAuthorizedNetworksConfig": { "$ref": "MasterAuthorizedNetworksConfig", @@ -2368,7 +2368,7 @@ "id": "TaskLogsRetentionConfig", "properties": { "storageMode": { - "description": "Optional. The mode of storage for Airflow workers task logs. For details, see go/composer-store-task-logs-in-cloud-logging-only-design-doc", + "description": "Optional. The mode of storage for Airflow workers task logs.", "enum": [ "TASK_LOGS_STORAGE_MODE_UNSPECIFIED", "CLOUD_LOGGING_AND_CLOUD_STORAGE", diff --git a/discovery/compute-alpha.json b/discovery/compute-alpha.json index d7d6ef2877..68f39b0a22 100644 --- a/discovery/compute-alpha.json +++ b/discovery/compute-alpha.json @@ -18438,6 +18438,100 @@ } } }, + "networkPlacements": { + "methods": { + "get": { + "description": "Returns the specified network placement.", + "flatPath": "projects/{project}/global/networkPlacements/{networkPlacement}", + "httpMethod": "GET", + "id": "compute.networkPlacements.get", + "parameterOrder": [ + "project", + "networkPlacement" + ], + "parameters": { + "networkPlacement": { + "description": "Name of the network placement to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/networkPlacements/{networkPlacement}", + "response": { + "$ref": "NetworkPlacement" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "list": { + "description": "Retrieves a list of network placements available to the specified project.", + "flatPath": "projects/{project}/global/networkPlacements", + "httpMethod": "GET", + "id": "compute.networkPlacements.list", + "parameterOrder": [ + "project" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + } + }, + "path": "projects/{project}/global/networkPlacements", + "response": { + "$ref": "NetworkPlacementsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + } + } + }, "networks": { "methods": { "addPeering": { @@ -43897,7 +43991,7 @@ } } }, - "revision": "20240305", + "revision": "20240312", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -59360,7 +59454,7 @@ "additionalProperties": { "type": "string" }, - "description": "Resource manager tags to be bound to the instance group manager. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/123`, and values are in the format `tagValues/456`. The field is allowed for INSERT only.", + "description": "Resource manager tags to bind to the managed instance group. The tags are key-value pairs. Keys must be in the format tagKeys/123 and values in the format tagValues/456. For more information, see Manage tags for resources.", "type": "object" } }, @@ -62184,7 +62278,7 @@ "type": "string" }, "type": { - "description": "[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL.", + "description": "[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, SYSTEM_REGIONAL.", "enum": [ "HIERARCHY", "NETWORK", @@ -69768,11 +69862,13 @@ "description": "The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.", "enum": [ "GVNIC", + "IDPF", "UNSPECIFIED_NIC_TYPE", "VIRTIO_NET" ], "enumDescriptions": [ "GVNIC", + "IDPF", "No type specified.", "VIRTIO" ], @@ -70108,6 +70204,485 @@ }, "type": "object" }, + "NetworkPlacement": { + "description": "NetworkPlacement Represents a Google managed network placement resource.", + "id": "NetworkPlacement", + "properties": { + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, + "description": { + "description": "[Output Only] An optional description of this resource.", + "type": "string" + }, + "features": { + "$ref": "NetworkPlacementNetworkFeatures", + "description": "[Output Only] Features supported by the network." + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#networkPlacement", + "description": "[Output Only] Type of the resource. Always compute#networkPlacement for network placements.", + "type": "string" + }, + "name": { + "description": "[Output Only] Name of the resource.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for the resource.", + "type": "string" + }, + "selfLinkWithId": { + "description": "[Output Only] Server-defined URL for this resource with the resource id.", + "type": "string" + }, + "zone": { + "description": "[Output Only] Zone to which the network is restricted.", + "type": "string" + } + }, + "type": "object" + }, + "NetworkPlacementNetworkFeatures": { + "id": "NetworkPlacementNetworkFeatures", + "properties": { + "allowAutoModeSubnet": { + "description": "Specifies whether auto mode subnet creation is allowed.", + "enum": [ + "AUTO_MODE_SUBNET_ALLOWED", + "AUTO_MODE_SUBNET_BLOCKED", + "AUTO_MODE_SUBNET_UNSPECIFIED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "allowCloudNat": { + "description": "Specifies whether cloud NAT creation is allowed.", + "enum": [ + "CLOUD_NAT_ALLOWED", + "CLOUD_NAT_BLOCKED", + "CLOUD_NAT_UNSPECIFIED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "allowCloudRouter": { + "description": "Specifies whether cloud router creation is allowed.", + "enum": [ + "CLOUD_ROUTER_ALLOWED", + "CLOUD_ROUTER_BLOCKED", + "CLOUD_ROUTER_UNSPECIFIED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "allowInterconnect": { + "description": "Specifies whether Cloud Interconnect creation is allowed.", + "enum": [ + "INTERCONNECT_ALLOWED", + "INTERCONNECT_BLOCKED", + "INTERCONNECT_UNSPECIFIED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "allowLoadBalancing": { + "description": "Specifies whether cloud load balancing is allowed.", + "enum": [ + "LOAD_BALANCING_ALLOWED", + "LOAD_BALANCING_BLOCKED", + "LOAD_BALANCING_UNSPECIFIED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "allowMultiNicInSameNetwork": { + "description": "Specifies whether multi-nic in the same network is allowed.", + "enum": [ + "MULTI_NIC_IN_SAME_NETWORK_ALLOWED", + "MULTI_NIC_IN_SAME_NETWORK_BLOCKED", + "MULTI_NIC_IN_SAME_NETWORK_UNSPECIFIED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "allowPacketMirroring": { + "description": "Specifies whether Packet Mirroring 1.0 is supported.", + "enum": [ + "PACKET_MIRRORING_ALLOWED", + "PACKET_MIRRORING_BLOCKED", + "PACKET_MIRRORING_UNSPECIFIED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "allowPrivateGoogleAccess": { + "description": "Specifies whether private Google access is allowed.", + "enum": [ + "PRIVATE_GOOGLE_ACCESS_ALLOWED", + "PRIVATE_GOOGLE_ACCESS_BLOCKED", + "PRIVATE_GOOGLE_ACCESS_UNSPECIFIED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "allowPsc": { + "description": "Specifies whether PSC creation is allowed.", + "enum": [ + "PSC_ALLOWED", + "PSC_BLOCKED", + "PSC_UNSPECIFIED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "allowSameNetworkUnicast": { + "description": "Specifies whether unicast within the same network is allowed.", + "enum": [ + "SAME_NETWORK_UNICAST_ALLOWED", + "SAME_NETWORK_UNICAST_BLOCKED", + "SAME_NETWORK_UNICAST_UNSPECIFIED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "allowStaticRoutes": { + "description": "Specifies whether static route creation is allowed.", + "enum": [ + "STATIC_ROUTES_ALLOWED", + "STATIC_ROUTES_BLOCKED", + "STATIC_ROUTES_UNSPECIFIED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "allowVpcPeering": { + "description": "Specifies whether VPC peering is allowed.", + "enum": [ + "VPC_PEERING_ALLOWED", + "VPC_PEERING_BLOCKED", + "VPC_PEERING_UNSPECIFIED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "allowVpn": { + "description": "Specifies whether VPN creation is allowed.", + "enum": [ + "VPN_ALLOWED", + "VPN_BLOCKED", + "VPN_UNSPECIFIED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "allowedSubnetPurposes": { + "description": "Specifies which subnetwork purposes are supported.", + "items": { + "enum": [ + "SUBNET_PURPOSE_CUSTOM_HARDWARE", + "SUBNET_PURPOSE_PRIVATE", + "SUBNET_PURPOSE_UNSPECIFIED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "type": "array" + }, + "allowedSubnetStackTypes": { + "description": "Specifies which subnetwork stack types are supported.", + "items": { + "enum": [ + "SUBNET_STACK_TYPE_IPV4_IPV6", + "SUBNET_STACK_TYPE_IPV4_ONLY", + "SUBNET_STACK_TYPE_IPV6_ONLY", + "SUBNET_STACK_TYPE_UNSPECIFIED" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "type": "array" + }, + "interfaceTypes": { + "description": "If set, limits the interface types that the network supports. If empty, all interface types are supported.", + "items": { + "enum": [ + "GVNIC", + "IDPF", + "UNSPECIFIED_NIC_TYPE", + "VIRTIO_NET" + ], + "enumDescriptions": [ + "GVNIC", + "IDPF", + "No type specified.", + "VIRTIO" + ], + "type": "string" + }, + "type": "array" + }, + "multicast": { + "description": "Specifies which type of multicast is supported.", + "enum": [ + "MULTICAST_SDN", + "MULTICAST_ULL", + "MULTICAST_UNSPECIFIED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "unicast": { + "description": "Specifies which type of unicast is supported.", + "enum": [ + "UNICAST_SDN", + "UNICAST_ULL", + "UNICAST_UNSPECIFIED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "NetworkPlacementsListResponse": { + "description": "Contains a list of network placements.", + "id": "NetworkPlacementsListResponse", + "properties": { + "etag": { + "type": "string" + }, + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of NetworkPlacement resources.", + "items": { + "$ref": "NetworkPlacement" + }, + "type": "array" + }, + "kind": { + "default": "compute#networkPlacementList", + "description": "[Output Only] Type of resource. Always compute#networkPlacementList for network placements.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "unreachables": { + "description": "[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder", + "items": { + "type": "string" + }, + "type": "array" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, "NetworkRoutingConfig": { "description": "A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide.", "id": "NetworkRoutingConfig", @@ -78088,11 +78663,6 @@ }, "type": "array" }, - "skipInapplicableInstances": { - "deprecated": true, - "description": "Skip instances which cannot be deleted (instances not belonging to this managed group, already being deleted or being abandoned). If `false`, fail whole flow, if such instance is passed. DEPRECATED: Use skip_instances_on_validation_error instead.", - "type": "boolean" - }, "skipInstancesOnValidationError": { "description": "Specifies whether the request should proceed despite the inclusion of instances that are not members of the group or that are already in the process of being deleted or abandoned. If this field is set to `false` and such an instance is specified in the request, the operation fails. The operation always fails if the request contains a malformed instance URL or a reference to an instance that exists in a zone or region other than the group's zone or region.", "type": "boolean" diff --git a/discovery/compute-beta.json b/discovery/compute-beta.json index 90478d8335..381e253bf1 100644 --- a/discovery/compute-beta.json +++ b/discovery/compute-beta.json @@ -10679,6 +10679,21 @@ "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" + }, + "view": { + "description": "View of the instance template.", + "enum": [ + "BASIC", + "FULL", + "INSTANCE_VIEW_UNSPECIFIED" + ], + "enumDescriptions": [ + "Include everything except Partner Metadata.", + "Include everything.", + "The default / unset value. The API will default to the BASIC view." + ], + "location": "query", + "type": "string" } }, "path": "projects/{project}/global/instanceTemplates/{instanceTemplate}", @@ -10809,6 +10824,21 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" + }, + "view": { + "description": "View of the instance template.", + "enum": [ + "BASIC", + "FULL", + "INSTANCE_VIEW_UNSPECIFIED" + ], + "enumDescriptions": [ + "Include everything except Partner Metadata.", + "Include everything.", + "The default / unset value. The API will default to the BASIC view." + ], + "location": "query", + "type": "string" } }, "path": "projects/{project}/global/instanceTemplates", @@ -11357,6 +11387,21 @@ "required": true, "type": "string" }, + "view": { + "description": "View of the instance.", + "enum": [ + "BASIC", + "FULL", + "INSTANCE_VIEW_UNSPECIFIED" + ], + "enumDescriptions": [ + "Include everything except Partner Metadata.", + "Include everything.", + "The default / unset value. The API will default to the BASIC view." + ], + "location": "query", + "type": "string" + }, "zone": { "description": "The name of the zone for this request.", "location": "path", @@ -11527,6 +11572,54 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, + "getPartnerMetadata": { + "description": "Gets partner metadata of the specified instance and namespaces.", + "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/getPartnerMetadata", + "httpMethod": "GET", + "id": "compute.instances.getPartnerMetadata", + "parameterOrder": [ + "project", + "zone", + "instance" + ], + "parameters": { + "instance": { + "description": "Name of the instance scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "namespaces": { + "description": "Comma separated partner metadata namespaces.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instances/{instance}/getPartnerMetadata", + "response": { + "$ref": "PartnerMetadata" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, "getScreenshot": { "description": "Returns the screenshot from the specified instance.", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/screenshot", @@ -11811,6 +11904,21 @@ "location": "query", "type": "boolean" }, + "view": { + "description": "View of the instance.", + "enum": [ + "BASIC", + "FULL", + "INSTANCE_VIEW_UNSPECIFIED" + ], + "enumDescriptions": [ + "Include everything except Partner Metadata.", + "Include everything.", + "The default / unset value. The API will default to the BASIC view." + ], + "location": "query", + "type": "string" + }, "zone": { "description": "The name of the zone for this request.", "location": "path", @@ -11900,6 +12008,56 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, + "patchPartnerMetadata": { + "description": "Patches partner metadata of the specified instance.", + "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/patchPartnerMetadata", + "httpMethod": "POST", + "id": "compute.instances.patchPartnerMetadata", + "parameterOrder": [ + "project", + "zone", + "instance" + ], + "parameters": { + "instance": { + "description": "Name of the instance scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so 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).", + "location": "query", + "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instances/{instance}/patchPartnerMetadata", + "request": { + "$ref": "PartnerMetadata" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "performMaintenance": { "description": "Perform a manual maintenance on the instance.", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/performMaintenance", @@ -26275,6 +26433,21 @@ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" + }, + "view": { + "description": "View of the instance template.", + "enum": [ + "BASIC", + "FULL", + "INSTANCE_VIEW_UNSPECIFIED" + ], + "enumDescriptions": [ + "Include everything except Partner Metadata.", + "Include everything.", + "The default / unset value. The API will default to the BASIC view." + ], + "location": "query", + "type": "string" } }, "path": "projects/{project}/regions/{region}/instanceTemplates/{instanceTemplate}", @@ -26380,6 +26553,21 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" + }, + "view": { + "description": "View of the instance template.", + "enum": [ + "BASIC", + "FULL", + "INSTANCE_VIEW_UNSPECIFIED" + ], + "enumDescriptions": [ + "Include everything except Partner Metadata.", + "Include everything.", + "The default / unset value. The API will default to the BASIC view." + ], + "location": "query", + "type": "string" } }, "path": "projects/{project}/regions/{region}/instanceTemplates", @@ -32179,62 +32367,19 @@ "https://www.googleapis.com/auth/compute" ] }, - "get": { - "description": "Returns the specified Router resource.", - "flatPath": "projects/{project}/regions/{region}/routers/{router}", - "httpMethod": "GET", - "id": "compute.routers.get", - "parameterOrder": [ - "project", - "region", - "router" - ], - "parameters": { - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "region": { - "description": "Name of the region for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, - "router": { - "description": "Name of the Router resource to return.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" - } - }, - "path": "projects/{project}/regions/{region}/routers/{router}", - "response": { - "$ref": "Router" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] - }, - "getNatIpInfo": { - "description": "Retrieves runtime NAT IP information.", - "flatPath": "projects/{project}/regions/{region}/routers/{router}/getNatIpInfo", - "httpMethod": "GET", - "id": "compute.routers.getNatIpInfo", + "deleteRoutePolicy": { + "description": "Deletes Route Policy", + "flatPath": "projects/{project}/regions/{region}/routers/{router}/deleteRoutePolicy", + "httpMethod": "POST", + "id": "compute.routers.deleteRoutePolicy", "parameterOrder": [ "project", "region", "router" ], "parameters": { - "natName": { - "description": "Name of the nat service to filter the NAT IP information. If it is omitted, all nats for this router will be returned. Name should conform to RFC1035.", + "policy": { + "description": "The Policy name for this request. Name must conform to RFC1035", "location": "query", "type": "string" }, @@ -32252,104 +32397,246 @@ "required": true, "type": "string" }, - "router": { - "description": "Name of the Router resource to query for Nat IP information. The name should conform to RFC1035.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "projects/{project}/regions/{region}/routers/{router}/getNatIpInfo", - "response": { - "$ref": "NatIpInfoResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] - }, - "getNatMappingInfo": { - "description": "Retrieves runtime Nat mapping information of VM endpoints.", - "flatPath": "projects/{project}/regions/{region}/routers/{router}/getNatMappingInfo", - "httpMethod": "GET", - "id": "compute.routers.getNatMappingInfo", - "parameterOrder": [ - "project", - "region", - "router" - ], - "parameters": { - "filter": { - "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", - "location": "query", - "type": "string" - }, - "maxResults": { - "default": "500", - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", - "format": "uint32", - "location": "query", - "minimum": "0", - "type": "integer" - }, - "natName": { - "description": "Name of the nat service to filter the Nat Mapping information. If it is omitted, all nats for this router will be returned. Name should conform to RFC1035.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", - "location": "query", - "type": "string" - }, - "pageToken": { - "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "requestId": { + "description": "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).", "location": "query", "type": "string" }, - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "region": { - "description": "Name of the region for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, - "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", - "location": "query", - "type": "boolean" - }, "router": { - "description": "Name of the Router resource to query for Nat Mapping information of VM endpoints.", + "description": "Name of the Router resource where Route Policy is defined.", "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}/regions/{region}/routers/{router}/getNatMappingInfo", + "path": "projects/{project}/regions/{region}/routers/{router}/deleteRoutePolicy", "response": { - "$ref": "VmEndpointNatMappingsList" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, - "getRouterStatus": { - "description": "Retrieves runtime information of the specified router.", - "flatPath": "projects/{project}/regions/{region}/routers/{router}/getRouterStatus", + "get": { + "description": "Returns the specified Router resource.", + "flatPath": "projects/{project}/regions/{region}/routers/{router}", "httpMethod": "GET", - "id": "compute.routers.getRouterStatus", + "id": "compute.routers.get", + "parameterOrder": [ + "project", + "region", + "router" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "router": { + "description": "Name of the Router resource to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/routers/{router}", + "response": { + "$ref": "Router" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "getNatIpInfo": { + "description": "Retrieves runtime NAT IP information.", + "flatPath": "projects/{project}/regions/{region}/routers/{router}/getNatIpInfo", + "httpMethod": "GET", + "id": "compute.routers.getNatIpInfo", + "parameterOrder": [ + "project", + "region", + "router" + ], + "parameters": { + "natName": { + "description": "Name of the nat service to filter the NAT IP information. If it is omitted, all nats for this router will be returned. Name should conform to RFC1035.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "router": { + "description": "Name of the Router resource to query for Nat IP information. The name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/routers/{router}/getNatIpInfo", + "response": { + "$ref": "NatIpInfoResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "getNatMappingInfo": { + "description": "Retrieves runtime Nat mapping information of VM endpoints.", + "flatPath": "projects/{project}/regions/{region}/routers/{router}/getNatMappingInfo", + "httpMethod": "GET", + "id": "compute.routers.getNatMappingInfo", + "parameterOrder": [ + "project", + "region", + "router" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "natName": { + "description": "Name of the nat service to filter the Nat Mapping information. If it is omitted, all nats for this router will be returned. Name should conform to RFC1035.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + }, + "router": { + "description": "Name of the Router resource to query for Nat Mapping information of VM endpoints.", + "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}/regions/{region}/routers/{router}/getNatMappingInfo", + "response": { + "$ref": "VmEndpointNatMappingsList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "getRoutePolicy": { + "description": "Returns specified Route Policy", + "flatPath": "projects/{project}/regions/{region}/routers/{router}/getRoutePolicy", + "httpMethod": "GET", + "id": "compute.routers.getRoutePolicy", + "parameterOrder": [ + "project", + "region", + "router" + ], + "parameters": { + "policy": { + "description": "The Policy name for this request. Name must conform to RFC1035", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "router": { + "description": "Name of the Router resource to query for the route policy. The name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/routers/{router}/getRoutePolicy", + "response": { + "$ref": "RoutersGetRoutePolicyResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "getRouterStatus": { + "description": "Retrieves runtime information of the specified router.", + "flatPath": "projects/{project}/regions/{region}/routers/{router}/getRouterStatus", + "httpMethod": "GET", + "id": "compute.routers.getRouterStatus", "parameterOrder": [ "project", "region", @@ -32493,6 +32780,196 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, + "listBgpRoutes": { + "description": "Retrieves a list of router bgp routes available to the specified project.", + "flatPath": "projects/{project}/regions/{region}/routers/{router}/listBgpRoutes", + "httpMethod": "GET", + "id": "compute.routers.listBgpRoutes", + "parameterOrder": [ + "project", + "region", + "router" + ], + "parameters": { + "addressFamily": { + "default": "UNSPECIFIED_IP_VERSION", + "description": "(Required) limit results to this address family (either IPv4 or IPv6)", + "enum": [ + "IPV4", + "IPV6", + "UNSPECIFIED_IP_VERSION" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "location": "query", + "type": "string" + }, + "destinationPrefix": { + "description": "Limit results to destinations that are subnets of this CIDR range", + "location": "query", + "type": "string" + }, + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "peer": { + "description": "(Required) limit results to the BGP peer with the given name. Name should conform to RFC1035.", + "location": "query", + "type": "string" + }, + "policyApplied": { + "default": "true", + "description": "When true, the method returns post-policy routes. Otherwise, it returns pre-policy routes.", + "location": "query", + "type": "boolean" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + }, + "routeType": { + "default": "UNSPECIFIED_ROUTE_TYPE", + "description": "(Required) limit results to this type of route (either LEARNED or ADVERTISED)", + "enum": [ + "ADVERTISED", + "LEARNED", + "UNSPECIFIED_ROUTE_TYPE" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "location": "query", + "type": "string" + }, + "router": { + "description": "Name or id of the resource for this request. Name should conform to RFC1035.", + "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}/regions/{region}/routers/{router}/listBgpRoutes", + "response": { + "$ref": "RoutersListBgpRoutes" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "listRoutePolicies": { + "description": "Retrieves a list of router route policy subresources available to the specified project.", + "flatPath": "projects/{project}/regions/{region}/routers/{router}/listRoutePolicies", + "httpMethod": "GET", + "id": "compute.routers.listRoutePolicies", + "parameterOrder": [ + "project", + "region", + "router" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + }, + "router": { + "description": "Name or id of the resource for this request. Name should conform to RFC1035.", + "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}/regions/{region}/routers/{router}/listRoutePolicies", + "response": { + "$ref": "RoutersListRoutePolicies" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, "patch": { "description": "Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", "flatPath": "projects/{project}/regions/{region}/routers/{router}", @@ -32684,6 +33161,56 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] + }, + "updateRoutePolicy": { + "description": "Updates or creates new Route Policy", + "flatPath": "projects/{project}/regions/{region}/routers/{router}/updateRoutePolicy", + "httpMethod": "POST", + "id": "compute.routers.updateRoutePolicy", + "parameterOrder": [ + "project", + "region", + "router" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-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 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).", + "location": "query", + "type": "string" + }, + "router": { + "description": "Name of the Router resource where Route Policy is defined.", + "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}/regions/{region}/routers/{router}/updateRoutePolicy", + "request": { + "$ref": "RoutePolicy" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] } } }, @@ -41052,7 +41579,7 @@ } } }, - "revision": "20240305", + "revision": "20240312", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -45593,6 +46120,91 @@ }, "type": "object" }, + "BgpRoute": { + "id": "BgpRoute", + "properties": { + "asPaths": { + "description": "[Output only] AS-PATH for the route", + "items": { + "$ref": "BgpRouteAsPath" + }, + "type": "array" + }, + "communities": { + "description": "[Output only] BGP communities in human-readable A:B format.", + "items": { + "type": "string" + }, + "type": "array" + }, + "destination": { + "$ref": "BgpRouteNetworkLayerReachabilityInformation", + "description": "[Output only] Destination IP range for the route, in human-readable CIDR format" + }, + "med": { + "description": "[Output only] BGP multi-exit discriminator", + "format": "uint32", + "type": "integer" + }, + "origin": { + "description": "[Output only] BGP origin (EGP, IGP or INCOMPLETE)", + "enum": [ + "BGP_ORIGIN_EGP", + "BGP_ORIGIN_IGP", + "BGP_ORIGIN_INCOMPLETE" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "BgpRouteAsPath": { + "id": "BgpRouteAsPath", + "properties": { + "asns": { + "description": "[Output only] ASNs in the path segment. When type is SEQUENCE, these are ordered.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "type": { + "description": "[Output only] Type of AS-PATH segment (SEQUENCE or SET)", + "enum": [ + "AS_PATH_TYPE_SEQUENCE", + "AS_PATH_TYPE_SET" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "BgpRouteNetworkLayerReachabilityInformation": { + "description": "Network Layer Reachability Information (NLRI) for a route.", + "id": "BgpRouteNetworkLayerReachabilityInformation", + "properties": { + "pathId": { + "description": "If the BGP session supports multiple paths (RFC 7911), the path identifier for this route.", + "format": "uint32", + "type": "integer" + }, + "prefix": { + "description": "Human readable CIDR notation for a prefix. E.g. 10.42.0.0/16.", + "type": "string" + } + }, + "type": "object" + }, "Binding": { "description": "Associates `members`, or principals, with a `role`.", "id": "Binding", @@ -53967,6 +54579,13 @@ "$ref": "InstanceParams", "description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload." }, + "partnerMetadata": { + "additionalProperties": { + "$ref": "StructuredEntries" + }, + "description": "Partner Metadata assigned to the instance. A map from a subdomain (namespace) to entries map.", + "type": "object" + }, "postKeyRevocationActionType": { "description": "PostKeyRevocationActionType of the instance.", "enum": [ @@ -55352,7 +55971,7 @@ "additionalProperties": { "type": "string" }, - "description": "Resource manager tags to be bound to the instance group manager. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/123`, and values are in the format `tagValues/456`. The field is allowed for INSERT only.", + "description": "Resource manager tags to bind to the managed instance group. The tags are key-value pairs. Keys must be in the format tagKeys/123 and values in the format tagValues/456. For more information, see Manage tags for resources.", "type": "object" } }, @@ -57341,6 +57960,13 @@ "$ref": "NetworkPerformanceConfig", "description": "Note that for MachineImage, this is not supported yet." }, + "partnerMetadata": { + "additionalProperties": { + "$ref": "StructuredEntries" + }, + "description": "Partner Metadata assigned to the instance properties. A map from a subdomain (namespace) to entries map.", + "type": "object" + }, "postKeyRevocationActionType": { "description": "PostKeyRevocationActionType of the instance.", "enum": [ @@ -58103,7 +58729,7 @@ "type": "string" }, "type": { - "description": "[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL.", + "description": "[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, SYSTEM_REGIONAL.", "enum": [ "HIERARCHY", "NETWORK", @@ -69166,6 +69792,25 @@ }, "type": "object" }, + "PartnerMetadata": { + "description": "Model definition of partner_metadata field. To be used in dedicated Partner Metadata methods and to be inlined in the Instance and InstanceTemplate resources.", + "id": "PartnerMetadata", + "properties": { + "fingerprint": { + "description": "Instance-level hash to be used for optimistic locking.", + "format": "byte", + "type": "string" + }, + "partnerMetadata": { + "additionalProperties": { + "$ref": "StructuredEntries" + }, + "description": "Partner Metadata assigned to the instance. A map from a subdomain to entries map. Subdomain name must be compliant with RFC1035 definition. The total size of all keys and values must be less than 2MB. Subdomain 'metadata.compute.googleapis.com' is reserverd for instance's metadata.", + "type": "object" + } + }, + "type": "object" + }, "PathMatcher": { "description": "A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service is used.", "id": "PathMatcher", @@ -74643,6 +75288,61 @@ }, "type": "object" }, + "RoutePolicy": { + "id": "RoutePolicy", + "properties": { + "fingerprint": { + "description": "A fingerprint for the Route Policy being applied to this Router, which is essentially a hash of the Route Policy used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update Route Policy. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make a getRoutePolicy() request to retrieve a Route Policy.", + "format": "byte", + "type": "string" + }, + "name": { + "description": "Route Policy name, which must be a resource ID segment and unique within all the router's Route Policies. Name should conform to RFC1035.", + "type": "string" + }, + "terms": { + "description": "List of terms (the order in the list is not important, they are evaluated in order of priority). Order of policies is not retained and might change when getting policy later.", + "items": { + "$ref": "RoutePolicyPolicyTerm" + }, + "type": "array" + }, + "type": { + "enum": [ + "ROUTE_POLICY_TYPE_EXPORT", + "ROUTE_POLICY_TYPE_IMPORT" + ], + "enumDescriptions": [ + "The Route Policy is an Export Policy.", + "The Route Policy is an Import Policy." + ], + "type": "string" + } + }, + "type": "object" + }, + "RoutePolicyPolicyTerm": { + "id": "RoutePolicyPolicyTerm", + "properties": { + "actions": { + "description": "CEL expressions to evaluate to modify a route when this term matches.", + "items": { + "$ref": "Expr" + }, + "type": "array" + }, + "match": { + "$ref": "Expr", + "description": "CEL expression evaluated against a route to determine if this term applies. When not set, the term applies to all routes." + }, + "priority": { + "description": "The evaluation priority for this term, which must be between 0 (inclusive) and 2^31 (exclusive), and unique within the list.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "Router": { "description": "Represents a Cloud Router resource. For more information about Cloud Router, read the Cloud Router overview.", "id": "Router", @@ -75927,6 +76627,337 @@ }, "type": "object" }, + "RoutersGetRoutePolicyResponse": { + "id": "RoutersGetRoutePolicyResponse", + "properties": { + "resource": { + "$ref": "RoutePolicy" + } + }, + "type": "object" + }, + "RoutersListBgpRoutes": { + "id": "RoutersListBgpRoutes", + "properties": { + "etag": { + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "type": "string" + }, + "kind": { + "default": "compute#routersListBgpRoutes", + "description": "[Output Only] Type of resource. Always compute#routersListBgpRoutes for lists of bgp routes.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "result": { + "description": "[Output Only] A list of bgp routes.", + "items": { + "$ref": "BgpRoute" + }, + "type": "array" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "unreachables": { + "description": "[Output Only] Unreachable resources.", + "items": { + "type": "string" + }, + "type": "array" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "RoutersListRoutePolicies": { + "id": "RoutersListRoutePolicies", + "properties": { + "etag": { + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "type": "string" + }, + "kind": { + "default": "compute#routersListRoutePolicies", + "description": "[Output Only] Type of resource. Always compute#routersListRoutePolicies for lists of route policies.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "result": { + "description": "[Output Only] A list of route policies.", + "items": { + "$ref": "RoutePolicy" + }, + "type": "array" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "unreachables": { + "description": "[Output Only] Unreachable resources.", + "items": { + "type": "string" + }, + "type": "array" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, "RoutersPreviewResponse": { "id": "RoutersPreviewResponse", "properties": { @@ -82343,6 +83374,19 @@ }, "type": "object" }, + "StructuredEntries": { + "id": "StructuredEntries", + "properties": { + "entries": { + "additionalProperties": { + "type": "any" + }, + "description": "Map of a partner metadata that belong to the same subdomain. It accepts any value including google.protobuf.Struct.", + "type": "object" + } + }, + "type": "object" + }, "Subnetwork": { "description": "Represents a Subnetwork resource. A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network.", "id": "Subnetwork", diff --git a/discovery/compute-v1.json b/discovery/compute-v1.json index f205a5ef67..3d985ae09f 100644 --- a/discovery/compute-v1.json +++ b/discovery/compute-v1.json @@ -9304,6 +9304,92 @@ } } }, + "instanceSettings": { + "methods": { + "get": { + "description": "Get Instance settings.", + "flatPath": "projects/{project}/zones/{zone}/instanceSettings", + "httpMethod": "GET", + "id": "compute.instanceSettings.get", + "parameterOrder": [ + "project", + "zone" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "zone": { + "description": "Name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instanceSettings", + "response": { + "$ref": "InstanceSettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "patch": { + "description": "Patch Instance settings", + "flatPath": "projects/{project}/zones/{zone}/instanceSettings", + "httpMethod": "PATCH", + "id": "compute.instanceSettings.patch", + "parameterOrder": [ + "project", + "zone" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so 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).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "update_mask indicates fields to be updated as part of this request.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "zone": { + "description": "The zone scoping this request. It should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instanceSettings", + "request": { + "$ref": "InstanceSettings" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + } + } + }, "instanceTemplates": { "methods": { "aggregatedList": { @@ -37285,7 +37371,7 @@ } } }, - "revision": "20240305", + "revision": "20240312", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -52326,6 +52412,49 @@ }, "type": "object" }, + "InstanceSettings": { + "description": "Represents a Instance Settings resource. You can use instance settings to configure default settings for Compute Engine VM instances. For example, you can use it to configure default machine type of Compute Engine VM instances.", + "id": "InstanceSettings", + "properties": { + "fingerprint": { + "description": "Specifies a fingerprint for instance settings, which is essentially a hash of the instance settings resource's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance settings resource. You must always provide an up-to-date fingerprint hash in order to update or change the resource, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the resource.", + "format": "byte", + "type": "string" + }, + "kind": { + "default": "compute#instanceSettings", + "description": "[Output Only] Type of the resource. Always compute#instance_settings for instance settings.", + "type": "string" + }, + "metadata": { + "$ref": "InstanceSettingsMetadata", + "description": "The metadata key/value pairs assigned to all the instances in the corresponding scope." + }, + "zone": { + "description": "[Output Only] URL of the zone where the resource resides You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", + "type": "string" + } + }, + "type": "object" + }, + "InstanceSettingsMetadata": { + "id": "InstanceSettingsMetadata", + "properties": { + "items": { + "additionalProperties": { + "type": "string" + }, + "description": "A metadata key/value items map. The total size of all keys and values must be less than 512KB.", + "type": "object" + }, + "kind": { + "default": "compute#metadata", + "description": "[Output Only] Type of the resource. Always compute#metadata for metadata.", + "type": "string" + } + }, + "type": "object" + }, "InstanceTemplate": { "description": "Represents an Instance Template resource. Google Compute Engine has two Instance Template resources: * [Global](/compute/docs/reference/rest/v1/instanceTemplates) * [Regional](/compute/docs/reference/rest/v1/regionInstanceTemplates) You can reuse a global instance template in different regions whereas you can use a regional instance template in a specified region only. If you want to reduce cross-region dependency or achieve data residency, use a regional instance template. To create VMs, managed instance groups, and reservations, you can use either global or regional instance templates. For more information, read Instance Templates.", "id": "InstanceTemplate", @@ -52935,7 +53064,7 @@ "type": "string" }, "type": { - "description": "[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL.", + "description": "[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, SYSTEM_REGIONAL.", "enum": [ "HIERARCHY", "NETWORK", diff --git a/discovery/connectors-v1.json b/discovery/connectors-v1.json index 5469885d3a..1d7365dafc 100644 --- a/discovery/connectors-v1.json +++ b/discovery/connectors-v1.json @@ -1143,6 +1143,37 @@ "https://www.googleapis.com/auth/cloud-platform" ] } + }, + "resources": { + "customConnectorVersions": { + "methods": { + "delete": { + "description": "Deletes a single CustomConnectorVersion.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customConnectors/{customConnectorsId}/customConnectorVersions/{customConnectorVersionsId}", + "httpMethod": "DELETE", + "id": "connectors.projects.locations.customConnectors.customConnectorVersions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the form: `projects/{project}/locations/{location}/customConnectors/{custom_connector}/customConnectorVersions/{custom_connector_version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customConnectors/[^/]+/customConnectorVersions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } } }, "endpointAttachments": { @@ -2327,7 +2358,7 @@ } } }, - "revision": "20240305", + "revision": "20240319", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AuditConfig": { @@ -3117,6 +3148,11 @@ "readOnly": true, "type": "array" }, + "authOverrideEnabled": { + "description": "Output only. Flag to mark the dynamic auth override.", + "readOnly": true, + "type": "boolean" + }, "configVariableTemplates": { "description": "Output only. List of config variables needed to create a connection.", "items": { @@ -3209,6 +3245,10 @@ "readOnly": true, "type": "array" }, + "schemaRefreshConfig": { + "$ref": "SchemaRefreshConfig", + "description": "Connection Schema Refresh Config" + }, "sslConfigTemplate": { "$ref": "SslConfigTemplate", "description": "Output only. Ssl configuration supported by the Connector.", @@ -5501,7 +5541,7 @@ "type": "object" }, "MaintenancePolicy": { - "description": "LINT.IfChange Defines policies to service maintenance events.", + "description": "Defines policies to service maintenance events.", "id": "MaintenancePolicy", "properties": { "createTime": { @@ -6532,6 +6572,21 @@ }, "type": "object" }, + "SchemaRefreshConfig": { + "description": "Config for connection schema refresh", + "id": "SchemaRefreshConfig", + "properties": { + "useActionDisplayNames": { + "description": "Whether to use displayName for actions in UI.", + "type": "boolean" + }, + "useSynchronousSchemaRefresh": { + "description": "Whether to use synchronous schema refresh.", + "type": "boolean" + } + }, + "type": "object" + }, "Secret": { "description": "Secret provides a reference to entries in Secret Manager.", "id": "Secret", diff --git a/discovery/connectors-v2.json b/discovery/connectors-v2.json index f1d2326fd1..a8211fef41 100644 --- a/discovery/connectors-v2.json +++ b/discovery/connectors-v2.json @@ -660,7 +660,7 @@ } } }, - "revision": "20231213", + "revision": "20240319", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AccessCredentials": { @@ -1707,7 +1707,7 @@ "type": "object" }, "MaintenancePolicy": { - "description": "LINT.IfChange Defines policies to service maintenance events.", + "description": "Defines policies to service maintenance events.", "id": "MaintenancePolicy", "properties": { "createTime": { diff --git a/discovery/container-v1.json b/discovery/container-v1.json index a06c094554..2d7b3b65b9 100644 --- a/discovery/container-v1.json +++ b/discovery/container-v1.json @@ -2540,7 +2540,7 @@ } } }, - "revision": "20240213", + "revision": "20240304", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -3542,6 +3542,10 @@ "description": "Enable/Disable FQDN Network Policy for the cluster.", "type": "boolean" }, + "desiredEnableMultiNetworking": { + "description": "Enable/Disable Multi-Networking for the cluster", + "type": "boolean" + }, "desiredEnablePrivateEndpoint": { "description": "Enable/Disable private endpoint for the cluster's master.", "type": "boolean" @@ -5274,6 +5278,10 @@ "$ref": "SandboxConfig", "description": "Sandbox configuration for this node." }, + "secondaryBootDiskUpdateStrategy": { + "$ref": "SecondaryBootDiskUpdateStrategy", + "description": "Secondary boot disk update strategy." + }, "secondaryBootDisks": { "description": "List of secondary boot disks attached to the nodes.", "items": { @@ -6317,6 +6325,12 @@ }, "type": "object" }, + "SecondaryBootDiskUpdateStrategy": { + "description": "SecondaryBootDiskUpdateStrategy is a placeholder which will be extended in the future to define different options for updating secondary boot disks.", + "id": "SecondaryBootDiskUpdateStrategy", + "properties": {}, + "type": "object" + }, "SecurityBulletinEvent": { "description": "SecurityBulletinEvent is a notification sent to customers when a security bulletin has been posted that they are vulnerable to.", "id": "SecurityBulletinEvent", diff --git a/discovery/container-v1beta1.json b/discovery/container-v1beta1.json index f817bad86e..77be98fb26 100644 --- a/discovery/container-v1beta1.json +++ b/discovery/container-v1beta1.json @@ -2565,7 +2565,7 @@ } } }, - "revision": "20240229", + "revision": "20240313", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -4143,10 +4143,49 @@ "description": "Configuration of etcd encryption.", "id": "DatabaseEncryption", "properties": { + "currentState": { + "description": "Output only. The current state of etcd encryption.", + "enum": [ + "CURRENT_STATE_UNSPECIFIED", + "CURRENT_STATE_ENCRYPTED", + "CURRENT_STATE_DECRYPTED", + "CURRENT_STATE_ENCRYPTION_PENDING", + "CURRENT_STATE_ENCRYPTION_ERROR", + "CURRENT_STATE_DECRYPTION_PENDING", + "CURRENT_STATE_DECRYPTION_ERROR" + ], + "enumDescriptions": [ + "Should never be set", + "Secrets in etcd are encrypted.", + "Secrets in etcd are stored in plain text (at etcd level) - this is unrelated to Compute Engine level full disk encryption.", + "Encryption (or re-encryption with a different CloudKMS key) of Secrets is in progress.", + "Encryption (or re-encryption with a different CloudKMS key) of Secrets in etcd encountered an error.", + "De-crypting Secrets to plain text in etcd is in progress.", + "De-crypting Secrets to plain text in etcd encountered an error." + ], + "readOnly": true, + "type": "string" + }, + "decryptionKeys": { + "description": "Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "keyName": { "description": "Name of CloudKMS key to use for the encryption of secrets in etcd. Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key", "type": "string" }, + "lastOperationErrors": { + "description": "Output only. Records errors seen during DatabaseEncryption update operations.", + "items": { + "$ref": "OperationError" + }, + "readOnly": true, + "type": "array" + }, "state": { "description": "The desired state of etcd encryption.", "enum": [ @@ -6277,6 +6316,26 @@ }, "type": "object" }, + "OperationError": { + "description": "OperationError records errors seen from CloudKMS keys encountered during updates to DatabaseEncryption configuration.", + "id": "OperationError", + "properties": { + "errorMessage": { + "description": "Description of the error seen during the operation.", + "type": "string" + }, + "keyName": { + "description": "CloudKMS key resource that had the error.", + "type": "string" + }, + "timestamp": { + "description": "Time when the CloudKMS error was seen.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "OperationProgress": { "description": "Information about operation (or operation stage) progress.", "id": "OperationProgress", diff --git a/discovery/content-v2.1.json b/discovery/content-v2.1.json index fb36d11008..32460c0671 100644 --- a/discovery/content-v2.1.json +++ b/discovery/content-v2.1.json @@ -6186,7 +6186,7 @@ } } }, - "revision": "20240312", + "revision": "20240320", "rootUrl": "https://shoppingcontent.googleapis.com/", "schemas": { "Account": { @@ -16192,7 +16192,7 @@ }, "topicTrends": { "$ref": "TopicTrends", - "description": "Topic trends fields requested by the merchant in the query. Field values are only set if the merchant queries `TopicTrendsView`. https://support.google.com/merchants/answer/13542370." + "description": "[Topic trends](https://support.google.com/merchants/answer/13542370) fields requested by the merchant in the query. Field values are only set if the merchant queries `TopicTrendsView`." } }, "type": "object" @@ -18068,7 +18068,7 @@ "type": "object" }, "TopicTrends": { - "description": "Topic trends fields requested by the merchant in the query. Field values are only set if the merchant queries `TopicTrendsView`.", + "description": "Topic trends fields requested by the merchant in the query. Field values are only set if the merchant queries `TopicTrendsView`. Forecast data can be queried up to 13 weeks by passing a future date in the `date` field. Historical data is measured daily, and forecasted data is projected weekly. All data points are normalized based on the highest data points returned in the response. If you make separate queries with different date ranges, you might see different values for the same date in each response. The recommended way to get a trend score of a topic is `last7_days_search_interest / last{$day}_days_search_interest - 1`. You can view trends for up to eight topics at a time.", "id": "TopicTrends", "properties": { "customerCountryCode": { diff --git a/discovery/customsearch-v1.json b/discovery/customsearch-v1.json index 2e0d15e571..32a597cf76 100644 --- a/discovery/customsearch-v1.json +++ b/discovery/customsearch-v1.json @@ -372,6 +372,12 @@ "location": "query", "type": "string" }, + "snippetLength": { + "description": "Optional. Maximum length of snippet text, in characters, to be returned with results. * Valid values are integers between 1 and 160, inclusive.", + "format": "int32", + "location": "query", + "type": "integer" + }, "sort": { "description": "The sort expression to apply to the results. The sort parameter specifies that the results be sorted according to the specified expression i.e. sort by date. [Example: sort=date](https://developers.google.com/custom-search/docs/structured_search#sort-by-attribute).", "location": "query", @@ -668,6 +674,12 @@ "location": "query", "type": "string" }, + "snippetLength": { + "description": "Optional. Maximum length of snippet text, in characters, to be returned with results. * Valid values are integers between 1 and 160, inclusive.", + "format": "int32", + "location": "query", + "type": "integer" + }, "sort": { "description": "The sort expression to apply to the results. The sort parameter specifies that the results be sorted according to the specified expression i.e. sort by date. [Example: sort=date](https://developers.google.com/custom-search/docs/structured_search#sort-by-attribute).", "location": "query", @@ -690,7 +702,7 @@ } } }, - "revision": "20240103", + "revision": "20240320", "rootUrl": "https://customsearch.googleapis.com/", "schemas": { "Promotion": { diff --git a/discovery/datacatalog-v1.json b/discovery/datacatalog-v1.json index 3da2c9458b..56bf504987 100644 --- a/discovery/datacatalog-v1.json +++ b/discovery/datacatalog-v1.json @@ -346,7 +346,7 @@ ], "parameters": { "name": { - "description": "The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name.", + "description": "Identifier. The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$", "required": true, @@ -677,7 +677,7 @@ ], "parameters": { "name": { - "description": "Output only. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name.", + "description": "Output only. Identifier. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$", "required": true, @@ -888,7 +888,7 @@ ], "parameters": { "name": { - "description": "The resource name of the tag in URL format where tag ID is a system-generated identifier. Note: The tag itself might not be stored in the location specified in its name.", + "description": "Identifier. The resource name of the tag in URL format where tag ID is a system-generated identifier. Note: The tag itself might not be stored in the location specified in its name.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+/tags/[^/]+$", "required": true, @@ -1045,7 +1045,7 @@ ], "parameters": { "name": { - "description": "The resource name of the tag in URL format where tag ID is a system-generated identifier. Note: The tag itself might not be stored in the location specified in its name.", + "description": "Identifier. The resource name of the tag in URL format where tag ID is a system-generated identifier. Note: The tag itself might not be stored in the location specified in its name.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/tags/[^/]+$", "required": true, @@ -1321,7 +1321,7 @@ ], "parameters": { "name": { - "description": "The resource name of the tag template in URL format. Note: The tag template itself and its child resources might not be stored in the location specified in its name.", + "description": "Identifier. The resource name of the tag template in URL format. Note: The tag template itself and its child resources might not be stored in the location specified in its name.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+$", "required": true, @@ -2144,7 +2144,7 @@ } } }, - "revision": "20240220", + "revision": "20240315", "rootUrl": "https://datacatalog.googleapis.com/", "schemas": { "Binding": { @@ -2914,7 +2914,7 @@ "description": "Model specification." }, "name": { - "description": "Output only. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name.", + "description": "Output only. Identifier. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name.", "readOnly": true, "type": "string" }, @@ -3022,7 +3022,7 @@ "type": "string" }, "name": { - "description": "The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name.", + "description": "Identifier. The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name.", "type": "string" } }, @@ -4131,7 +4131,7 @@ "type": "object" }, "name": { - "description": "The resource name of the tag in URL format where tag ID is a system-generated identifier. Note: The tag itself might not be stored in the location specified in its name.", + "description": "Identifier. The resource name of the tag in URL format where tag ID is a system-generated identifier. Note: The tag itself might not be stored in the location specified in its name.", "type": "string" }, "template": { @@ -4205,6 +4205,18 @@ "description": "A tag template defines a tag that can have one or more typed fields. The template is used to create tags that are attached to Google Cloud resources. [Tag template roles] (https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles) provide permissions to create, edit, and use the template. For example, see the [TagTemplate User] (https://cloud.google.com/data-catalog/docs/how-to/template-user) role that includes a permission to use the tag template to tag resources.", "id": "GoogleCloudDatacatalogV1TagTemplate", "properties": { + "dataplexTransferStatus": { + "description": "Optional. Transfer status of the TagTemplate", + "enum": [ + "DATAPLEX_TRANSFER_STATUS_UNSPECIFIED", + "MIGRATED" + ], + "enumDescriptions": [ + "Default value. TagTemplate and its tags are only visible and editable in DataCatalog.", + "TagTemplate and its tags are auto-copied to Dataplex service. Visible in both services. Editable in DataCatalog, read-only in Dataplex." + ], + "type": "string" + }, "displayName": { "description": "Display name for this template. Defaults to an empty string. The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum length is 200 characters.", "type": "string" @@ -4221,7 +4233,7 @@ "type": "boolean" }, "name": { - "description": "The resource name of the tag template in URL format. Note: The tag template itself and its child resources might not be stored in the location specified in its name.", + "description": "Identifier. The resource name of the tag template in URL format. Note: The tag template itself and its child resources might not be stored in the location specified in its name.", "type": "string" } }, @@ -4244,8 +4256,7 @@ "type": "boolean" }, "name": { - "description": "Output only. The resource name of the tag template field in URL format. Example: `projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE}/fields/{FIELD}` Note: The tag template field itself might not be stored in the location specified in its name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 64 characters.", - "readOnly": true, + "description": "Identifier. The resource name of the tag template field in URL format. Example: `projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE}/fields/{FIELD}` Note: The tag template field itself might not be stored in the location specified in its name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 64 characters.", "type": "string" }, "order": { diff --git a/discovery/datacatalog-v1beta1.json b/discovery/datacatalog-v1beta1.json index 36d07d36fe..0576f23810 100644 --- a/discovery/datacatalog-v1beta1.json +++ b/discovery/datacatalog-v1beta1.json @@ -331,7 +331,7 @@ ], "parameters": { "name": { - "description": "The resource name of the entry group in URL format. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id} Note that this EntryGroup and its child resources may not actually be stored in the location in this name.", + "description": "Identifier. The resource name of the entry group in URL format. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id} Note that this EntryGroup and its child resources may not actually be stored in the location in this name.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$", "required": true, @@ -578,7 +578,7 @@ ], "parameters": { "name": { - "description": "Output only. The Data Catalog resource name of the entry in URL format. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} Note that this Entry and its child resources may not actually be stored in the location in this name.", + "description": "Output only. Identifier. The Data Catalog resource name of the entry in URL format. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} Note that this Entry and its child resources may not actually be stored in the location in this name.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+$", "required": true, @@ -733,7 +733,7 @@ ], "parameters": { "name": { - "description": "The resource name of the tag in URL format. Example: * projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id} where `tag_id` is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.", + "description": "Identifier. The resource name of the tag in URL format. Example: * projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id} where `tag_id` is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/[^/]+/tags/[^/]+$", "required": true, @@ -862,7 +862,7 @@ ], "parameters": { "name": { - "description": "The resource name of the tag in URL format. Example: * projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id} where `tag_id` is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.", + "description": "Identifier. The resource name of the tag in URL format. Example: * projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id} where `tag_id` is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/tags/[^/]+$", "required": true, @@ -1018,7 +1018,7 @@ ], "parameters": { "name": { - "description": "The resource name of the tag template in URL format. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id} Note that this TagTemplate and its child resources may not actually be stored in the location in this name.", + "description": "Identifier. The resource name of the tag template in URL format. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id} Note that this TagTemplate and its child resources may not actually be stored in the location in this name.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/tagTemplates/[^/]+$", "required": true, @@ -1813,7 +1813,7 @@ } } }, - "revision": "20240220", + "revision": "20240315", "rootUrl": "https://datacatalog.googleapis.com/", "schemas": { "Binding": { @@ -2572,7 +2572,7 @@ "description": "Model specification." }, "name": { - "description": "Output only. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name.", + "description": "Output only. Identifier. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name.", "readOnly": true, "type": "string" }, @@ -3179,7 +3179,7 @@ "type": "object" }, "name": { - "description": "The resource name of the tag in URL format where tag ID is a system-generated identifier. Note: The tag itself might not be stored in the location specified in its name.", + "description": "Identifier. The resource name of the tag in URL format where tag ID is a system-generated identifier. Note: The tag itself might not be stored in the location specified in its name.", "type": "string" }, "template": { @@ -3579,7 +3579,7 @@ "type": "string" }, "name": { - "description": "Output only. The Data Catalog resource name of the entry in URL format. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} Note that this Entry and its child resources may not actually be stored in the location in this name.", + "description": "Output only. Identifier. The Data Catalog resource name of the entry in URL format. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} Note that this Entry and its child resources may not actually be stored in the location in this name.", "readOnly": true, "type": "string" }, @@ -3644,7 +3644,7 @@ "type": "string" }, "name": { - "description": "The resource name of the entry group in URL format. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id} Note that this EntryGroup and its child resources may not actually be stored in the location in this name.", + "description": "Identifier. The resource name of the entry group in URL format. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id} Note that this EntryGroup and its child resources may not actually be stored in the location in this name.", "type": "string" } }, @@ -4198,7 +4198,7 @@ "type": "object" }, "name": { - "description": "The resource name of the tag in URL format. Example: * projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id} where `tag_id` is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.", + "description": "Identifier. The resource name of the tag in URL format. Example: * projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id} where `tag_id` is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.", "type": "string" }, "template": { @@ -4268,6 +4268,19 @@ "description": "A tag template defines a tag, which can have one or more typed fields. The template is used to create and attach the tag to Google Cloud resources. [Tag template roles](https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles) provide permissions to create, edit, and use the template. See, for example, the [TagTemplate User](https://cloud.google.com/data-catalog/docs/how-to/template-user) role, which includes permission to use the tag template to tag resources.", "id": "GoogleCloudDatacatalogV1beta1TagTemplate", "properties": { + "dataplexTransferStatus": { + "description": "Output only. Transfer status of the TagTemplate", + "enum": [ + "DATAPLEX_TRANSFER_STATUS_UNSPECIFIED", + "MIGRATED" + ], + "enumDescriptions": [ + "Default value. TagTemplate and its tags are only visible and editable in DataCatalog.", + "TagTemplate and its tags are auto-copied to Dataplex service. Visible in both services. Editable in DataCatalog, read-only in Dataplex." + ], + "readOnly": true, + "type": "string" + }, "displayName": { "description": "The display name for this template. Defaults to an empty string.", "type": "string" @@ -4280,7 +4293,7 @@ "type": "object" }, "name": { - "description": "The resource name of the tag template in URL format. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id} Note that this TagTemplate and its child resources may not actually be stored in the location in this name.", + "description": "Identifier. The resource name of the tag template in URL format. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id} Note that this TagTemplate and its child resources may not actually be stored in the location in this name.", "type": "string" } }, @@ -4303,7 +4316,7 @@ "type": "boolean" }, "name": { - "description": "Output only. The resource name of the tag template field in URL format. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template}/fields/{field} Note that this TagTemplateField may not actually be stored in the location in this name.", + "description": "Output only. Identifier. The resource name of the tag template field in URL format. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template}/fields/{field} Note that this TagTemplateField may not actually be stored in the location in this name.", "readOnly": true, "type": "string" }, diff --git a/discovery/dataflow-v1b3.json b/discovery/dataflow-v1b3.json index fe1b89e86e..b3894becfa 100644 --- a/discovery/dataflow-v1b3.json +++ b/discovery/dataflow-v1b3.json @@ -31,6 +31,11 @@ "endpointUrl": "https://dataflow.europe-west3.rep.googleapis.com/", "location": "europe-west3", "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://dataflow.europe-west9.rep.googleapis.com/", + "location": "europe-west9", + "description": "Regional Endpoint" } ], "fullyEncodeReservedExpansion": true, @@ -1918,7 +1923,7 @@ ], "parameters": { "dynamicTemplate.gcsPath": { - "description": "Path to dynamic template spec file on Cloud Storage. The file must be a Json serialized DynamicTemplateFieSpec object.", + "description": "Path to the dynamic template specification file on Cloud Storage. The file must be a JSON serialized `DynamicTemplateFileSpec` object.", "location": "query", "type": "string" }, @@ -1928,7 +1933,7 @@ "type": "string" }, "gcsPath": { - "description": "A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'.", + "description": "A Cloud Storage path to the template to use to create the job. Must be valid Cloud Storage URL, beginning with `gs://`.", "location": "query", "type": "string" }, @@ -2133,7 +2138,7 @@ ], "parameters": { "dynamicTemplate.gcsPath": { - "description": "Path to dynamic template spec file on Cloud Storage. The file must be a Json serialized DynamicTemplateFieSpec object.", + "description": "Path to the dynamic template specification file on Cloud Storage. The file must be a JSON serialized `DynamicTemplateFileSpec` object.", "location": "query", "type": "string" }, @@ -2143,7 +2148,7 @@ "type": "string" }, "gcsPath": { - "description": "A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'.", + "description": "A Cloud Storage path to the template to use to create the job. Must be valid Cloud Storage URL, beginning with `gs://`.", "location": "query", "type": "string" }, @@ -2182,7 +2187,7 @@ } } }, - "revision": "20240303", + "revision": "20240317", "rootUrl": "https://dataflow.googleapis.com/", "schemas": { "ApproximateProgress": { @@ -3201,7 +3206,7 @@ "type": "string" }, "streamingMode": { - "description": "Optional. Specifies the Streaming Engine message processing guarantees. Reduces cost and latency but might result in duplicate messages committed to storage. Designed to run simple mapping streaming ETL jobs at the lowest cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use case.", + "description": "Optional. Specifies the Streaming Engine message processing guarantees. Reduces cost and latency but might result in duplicate messages committed to storage. Designed to run simple mapping streaming ETL jobs at the lowest cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use case. For more information, see [Set the pipeline streaming mode](https://cloud.google.com/dataflow/docs/guides/streaming-modes).", "enum": [ "STREAMING_MODE_UNSPECIFIED", "STREAMING_MODE_EXACTLY_ONCE", @@ -3539,7 +3544,7 @@ "type": "string" }, "streamingMode": { - "description": "Optional. Specifies the Streaming Engine message processing guarantees. Reduces cost and latency but might result in duplicate messages committed to storage. Designed to run simple mapping streaming ETL jobs at the lowest cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use case.", + "description": "Optional. Specifies the Streaming Engine message processing guarantees. Reduces cost and latency but might result in duplicate messages committed to storage. Designed to run simple mapping streaming ETL jobs at the lowest cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use case. For more information, see [Set the pipeline streaming mode](https://cloud.google.com/dataflow/docs/guides/streaming-modes).", "enum": [ "STREAMING_MODE_UNSPECIFIED", "STREAMING_MODE_EXACTLY_ONCE", @@ -5413,7 +5418,7 @@ "type": "object" }, "RuntimeEnvironment": { - "description": "The environment values to set at runtime.", + "description": "The environment values to set at runtime. LINT.IfChange", "id": "RuntimeEnvironment", "properties": { "additionalExperiments": { @@ -5484,7 +5489,7 @@ "type": "string" }, "streamingMode": { - "description": "Optional. Specifies the Streaming Engine message processing guarantees. Reduces cost and latency but might result in duplicate messages committed to storage. Designed to run simple mapping streaming ETL jobs at the lowest cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use case.", + "description": "Optional. Specifies the Streaming Engine message processing guarantees. Reduces cost and latency but might result in duplicate messages committed to storage. Designed to run simple mapping streaming ETL jobs at the lowest cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use case. For more information, see [Set the pipeline streaming mode](https://cloud.google.com/dataflow/docs/guides/streaming-modes).", "enum": [ "STREAMING_MODE_UNSPECIFIED", "STREAMING_MODE_EXACTLY_ONCE", @@ -5553,7 +5558,7 @@ "type": "integer" }, "workerUtilizationHint": { - "description": "Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog.", + "description": "Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline).", "format": "double", "type": "number" } diff --git a/discovery/datamigration-v1.json b/discovery/datamigration-v1.json index 2559577786..efeeda8b37 100644 --- a/discovery/datamigration-v1.json +++ b/discovery/datamigration-v1.json @@ -2125,7 +2125,7 @@ } } }, - "revision": "20240221", + "revision": "20240315", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AlloyDbConnectionProfile": { @@ -2811,14 +2811,18 @@ "ALLOYDB" ], "enumDescriptions": [ - "The database provider is unknown.", - "CloudSQL runs the database.", - "RDS runs the database.", - "Amazon Aurora.", - "AlloyDB." + "Use this value for on-premise source database instances.", + "Cloud SQL is the source instance provider.", + "Amazon RDS is the source instance provider.", + "Amazon Aurora is the source instance provider.", + "AlloyDB for PostgreSQL is the source instance provider." ], "type": "string" }, + "sqlserver": { + "$ref": "SqlServerConnectionProfile", + "description": "Connection profile for a SQL Server data source." + }, "state": { "description": "The current connection profile state (e.g. DRAFT, READY, or FAILED).", "enum": [ @@ -3033,12 +3037,14 @@ "DATABASE_ENGINE_UNSPECIFIED", "MYSQL", "POSTGRESQL", + "SQLSERVER", "ORACLE" ], "enumDescriptions": [ "The source database engine of the migration job is unknown.", "The source engine is MySQL.", "The source engine is PostgreSQL.", + "The source engine is SQL Server.", "The source engine is Oracle." ], "type": "string" @@ -3211,12 +3217,14 @@ "DATABASE_ENGINE_UNSPECIFIED", "MYSQL", "POSTGRESQL", + "SQLSERVER", "ORACLE" ], "enumDescriptions": [ "The source database engine of the migration job is unknown.", "The source engine is MySQL.", "The source engine is PostgreSQL.", + "The source engine is SQL Server.", "The source engine is Oracle." ], "type": "string" @@ -3231,11 +3239,11 @@ "ALLOYDB" ], "enumDescriptions": [ - "The database provider is unknown.", - "CloudSQL runs the database.", - "RDS runs the database.", - "Amazon Aurora.", - "AlloyDB." + "Use this value for on-premise source database instances.", + "Cloud SQL is the source instance provider.", + "Amazon RDS is the source instance provider.", + "Amazon Aurora is the source instance provider.", + "AlloyDB for PostgreSQL is the source instance provider." ], "type": "string" } @@ -4445,7 +4453,8 @@ "CDC", "PROMOTE_IN_PROGRESS", "WAITING_FOR_SOURCE_WRITES_TO_STOP", - "PREPARING_THE_DUMP" + "PREPARING_THE_DUMP", + "READY_FOR_PROMOTE" ], "enumDescriptions": [ "The phase of the migration job is unknown.", @@ -4453,7 +4462,8 @@ "The migration job is CDC phase.", "The migration job is running the promote phase.", "Only RDS flow - waiting for source writes to stop", - "Only RDS flow - the sources writes stopped, waiting for dump to begin" + "Only RDS flow - the sources writes stopped, waiting for dump to begin", + "The migration job is ready to be promoted." ], "readOnly": true, "type": "string" @@ -4470,6 +4480,10 @@ "$ref": "DatabaseType", "description": "The database engine type and provider of the source." }, + "sqlserverHomogeneousMigrationJobConfig": { + "$ref": "SqlServerHomogeneousMigrationJobConfig", + "description": "Optional. Configuration for SQL Server homogeneous migration." + }, "state": { "description": "The current migration job state.", "enum": [ @@ -5567,6 +5581,130 @@ }, "type": "object" }, + "SqlServerBackups": { + "description": "Specifies the backup details in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server.", + "id": "SqlServerBackups", + "properties": { + "gcsBucket": { + "description": "Required. The Cloud Storage bucket that stores backups for all replicated databases.", + "type": "string" + }, + "gcsPrefix": { + "description": "Optional. Cloud Storage path inside the bucket that stores backups.", + "type": "string" + } + }, + "type": "object" + }, + "SqlServerConnectionProfile": { + "description": "Specifies connection parameters required specifically for SQL Server databases.", + "id": "SqlServerConnectionProfile", + "properties": { + "backups": { + "$ref": "SqlServerBackups", + "description": "The backup details in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server." + }, + "cloudSqlId": { + "description": "If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.", + "type": "string" + }, + "forwardSshConnectivity": { + "$ref": "ForwardSshTunnelConnectivity", + "description": "Forward SSH tunnel connectivity." + }, + "host": { + "description": "Required. The IP or hostname of the source SQL Server database.", + "type": "string" + }, + "password": { + "description": "Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.", + "type": "string" + }, + "passwordSet": { + "description": "Output only. Indicates whether a new password is included in the request.", + "readOnly": true, + "type": "boolean" + }, + "port": { + "description": "Required. The network port of the source SQL Server database.", + "format": "int32", + "type": "integer" + }, + "privateConnectivity": { + "$ref": "PrivateConnectivity", + "description": "Private connectivity." + }, + "privateServiceConnectConnectivity": { + "$ref": "PrivateServiceConnectConnectivity", + "description": "Private Service Connect connectivity." + }, + "ssl": { + "$ref": "SslConfig", + "description": "SSL configuration for the destination to connect to the source database." + }, + "staticIpConnectivity": { + "$ref": "StaticIpConnectivity", + "description": "Static IP connectivity data (default, no additional details needed)." + }, + "username": { + "description": "Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.", + "type": "string" + } + }, + "type": "object" + }, + "SqlServerDatabaseBackup": { + "description": "Specifies the backup details for a single database in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server.", + "id": "SqlServerDatabaseBackup", + "properties": { + "database": { + "description": "Required. Name of a SQL Server database for which to define backup configuration.", + "type": "string" + }, + "encryptionOptions": { + "$ref": "SqlServerEncryptionOptions", + "description": "Optional. Encryption settings for the database. Required if provided database backups are encrypted. Encryption settings include path to certificate, path to certificate private key, and key password." + } + }, + "type": "object" + }, + "SqlServerEncryptionOptions": { + "description": "Encryption settings for the SQL Server database.", + "id": "SqlServerEncryptionOptions", + "properties": { + "certPath": { + "description": "Required. Path to certificate.", + "type": "string" + }, + "pvkPassword": { + "description": "Required. Input only. Private key password.", + "type": "string" + }, + "pvkPath": { + "description": "Required. Path to certificate private key.", + "type": "string" + } + }, + "type": "object" + }, + "SqlServerHomogeneousMigrationJobConfig": { + "description": "Configuration for homogeneous migration to Cloud SQL for SQL Server.", + "id": "SqlServerHomogeneousMigrationJobConfig", + "properties": { + "backupFilePattern": { + "description": "Required. Pattern that describes the default backup naming strategy. The specified pattern should ensure lexicographical order of backups. The pattern must define one of the following capture group sets: Capture group set #1 yy/yyyy - year, 2 or 4 digits mm - month number, 1-12 dd - day of month, 1-31 hh - hour of day, 00-23 mi - minutes, 00-59 ss - seconds, 00-59 Example: For backup file TestDB_20230802_155400.trn, use pattern: (?.*)_backup_(?\\d{4})(?\\d{2})(?\\d{2})_(?\\d{2})(?\\d{2})(?\\d{2}).trn Capture group set #2 timestamp - unix timestamp Example: For backup file TestDB.1691448254.trn, use pattern: (?.*)\\.(?\\d*).trn or (?.*)\\.(?\\d*).trn", + "type": "string" + }, + "databaseBackups": { + "description": "Required. Backup details per database in Cloud Storage.", + "items": { + "$ref": "SqlServerDatabaseBackup" + }, + "type": "array" + } + }, + "type": "object" + }, "SshScript": { "description": "Response message for 'GenerateSshScript' request.", "id": "SshScript", diff --git a/discovery/dataplex-v1.json b/discovery/dataplex-v1.json index 3d77505fb5..03b9d76fd8 100644 --- a/discovery/dataplex-v1.json +++ b/discovery/dataplex-v1.json @@ -174,11 +174,215 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "lookupEntry": { + "description": "Looks up a single entry.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:lookupEntry", + "httpMethod": "GET", + "id": "dataplex.projects.locations.lookupEntry", + "parameterOrder": [ + "name" + ], + "parameters": { + "aspectTypes": { + "description": "Optional. Limits the aspects returned to the provided aspect types. Only works if the CUSTOM view is selected.", + "location": "query", + "repeated": true, + "type": "string" + }, + "entry": { + "description": "Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "paths": { + "description": "Optional. Limits the aspects returned to those associated with the provided paths within the Entry. Only works if the CUSTOM view is selected.", + "location": "query", + "repeated": true, + "type": "string" + }, + "view": { + "description": "Optional. View for controlling which parts of an entry are to be returned.", + "enum": [ + "ENTRY_VIEW_UNSPECIFIED", + "BASIC", + "FULL", + "CUSTOM", + "ALL" + ], + "enumDescriptions": [ + "Unspecified EntryView. Defaults to FULL.", + "Returns entry only, without aspects.", + "Returns all required aspects as well as the keys of all non-required aspects.", + "Returns aspects matching custom fields in GetEntryRequest. If the number of aspects would exceed 100, the first 100 will be returned.", + "Returns all aspects. If the number of aspects would exceed 100, the first 100 will be returned." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:lookupEntry", + "response": { + "$ref": "GoogleCloudDataplexV1Entry" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "searchEntries": { + "description": "Searches for entries matching given query and scope.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:searchEntries", + "httpMethod": "POST", + "id": "dataplex.projects.locations.searchEntries", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "orderBy": { + "description": "Optional. Ordering of the results. Supported options to be added later.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Pagination.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "location": "query", + "type": "string" + }, + "query": { + "description": "Required. The query against which entries in scope should be matched.", + "location": "query", + "type": "string" + }, + "scope": { + "description": "Optional. The scope under which the search should be operating. Should either be organizations/ or projects/. If left unspecified, it will default to the organization where the project provided in name is located.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:searchEntries", + "response": { + "$ref": "GoogleCloudDataplexV1SearchEntriesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { "aspectTypes": { "methods": { + "create": { + "description": "Creates an AspectType", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/aspectTypes", + "httpMethod": "POST", + "id": "dataplex.projects.locations.aspectTypes.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "aspectTypeId": { + "description": "Required. AspectType identifier.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "validateOnly": { + "description": "Optional. Only validate the request, but do not perform mutations. The default is false.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+parent}/aspectTypes", + "request": { + "$ref": "GoogleCloudDataplexV1AspectType" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a AspectType resource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}", + "httpMethod": "DELETE", + "id": "dataplex.projects.locations.aspectTypes.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. If the client provided etag value does not match the current etag value, the DeleteAspectTypeRequest method returns an ABORTED error response", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The resource name of the AspectType: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/aspectTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Retrieves a AspectType resource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}", + "httpMethod": "GET", + "id": "dataplex.projects.locations.aspectTypes.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the AspectType: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/aspectTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudDataplexV1AspectType" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "getIamPolicy": { "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}:getIamPolicy", @@ -210,6 +414,91 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "list": { + "description": "Lists AspectType resources in a project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/aspectTypes", + "httpMethod": "GET", + "id": "dataplex.projects.locations.aspectTypes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter request. Filters are case-sensitive. The following formats are supported:labels.key1 = \"value1\" labels:key1 name = \"value\" These restrictions can be coinjoined with AND, OR and NOT conjunctions.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Order by fields (name or create_time) for the result. If not specified, the ordering is undefined.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of AspectTypes to return. The service may return fewer than this value. If unspecified, at most 10 AspectTypes 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. Page token received from a previous ListAspectTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAspectTypes must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the AspectType location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/aspectTypes", + "response": { + "$ref": "GoogleCloudDataplexV1ListAspectTypesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a AspectType resource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}", + "httpMethod": "PATCH", + "id": "dataplex.projects.locations.aspectTypes.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The relative resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/aspectTypes/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Mask of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. Only validate the request, but do not perform mutations. The default is false.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudDataplexV1AspectType" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}:setIamPolicy", @@ -602,6 +891,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "generateDataQualityRules": { + "description": "Generates recommended DataQualityRule from a data profiling DataScan.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}:generateDataQualityRules", + "httpMethod": "POST", + "id": "dataplex.projects.locations.dataScans.generateDataQualityRules", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name should be either * the name of a datascan with at least one successful completed data profiling job, or * the name of a successful completed data profiling datascan job.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataScans/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:generateDataQualityRules", + "request": { + "$ref": "GoogleCloudDataplexV1GenerateDataQualityRulesRequest" + }, + "response": { + "$ref": "GoogleCloudDataplexV1GenerateDataQualityRulesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Gets a DataScan resource.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}", @@ -846,6 +1163,34 @@ "resources": { "jobs": { "methods": { + "generateDataQualityRules": { + "description": "Generates recommended DataQualityRule from a data profiling DataScan.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}/jobs/{jobsId}:generateDataQualityRules", + "httpMethod": "POST", + "id": "dataplex.projects.locations.dataScans.jobs.generateDataQualityRules", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name should be either * the name of a datascan with at least one successful completed data profiling job, or * the name of a successful completed data profiling datascan job.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataScans/[^/]+/jobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:generateDataQualityRules", + "request": { + "$ref": "GoogleCloudDataplexV1GenerateDataQualityRulesRequest" + }, + "response": { + "$ref": "GoogleCloudDataplexV1GenerateDataQualityRulesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Gets a DataScanJob resource.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}/jobs/{jobsId}", @@ -1473,9 +1818,102 @@ }, "entryGroups": { "methods": { - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:getIamPolicy", + "create": { + "description": "Creates an EntryGroup", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups", + "httpMethod": "POST", + "id": "dataplex.projects.locations.entryGroups.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "entryGroupId": { + "description": "Required. EntryGroup identifier.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the entryGroup, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "validateOnly": { + "description": "Optional. Only validate the request, but do not perform mutations. The default is false.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+parent}/entryGroups", + "request": { + "$ref": "GoogleCloudDataplexV1EntryGroup" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a EntryGroup resource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}", + "httpMethod": "DELETE", + "id": "dataplex.projects.locations.entryGroups.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. If the client provided etag value does not match the current etag value, the DeleteEntryGroupRequest method returns an ABORTED error response", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The resource name of the EntryGroup: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Retrieves a EntryGroup resource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}", + "httpMethod": "GET", + "id": "dataplex.projects.locations.entryGroups.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the EntryGroup: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudDataplexV1EntryGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:getIamPolicy", "httpMethod": "GET", "id": "dataplex.projects.locations.entryGroups.getIamPolicy", "parameterOrder": [ @@ -1504,6 +1942,91 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "list": { + "description": "Lists EntryGroup resources in a project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups", + "httpMethod": "GET", + "id": "dataplex.projects.locations.entryGroups.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter request.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Order by fields for the result.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of EntryGroups to return. The service may return fewer than this value. If unspecified, at most 10 EntryGroups 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. Page token received from a previous ListEntryGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEntryGroups must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the entryGroup location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/entryGroups", + "response": { + "$ref": "GoogleCloudDataplexV1ListEntryGroupsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a EntryGroup resource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}", + "httpMethod": "PATCH", + "id": "dataplex.projects.locations.entryGroups.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The relative resource name of the EntryGroup, of the form: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Mask of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. Only validate the request, but do not perform mutations. The default is false.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudDataplexV1EntryGroup" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:setIamPolicy", @@ -1526,44 +2049,347 @@ "$ref": "GoogleIamV1SetIamPolicyRequest" }, "response": { - "$ref": "GoogleIamV1Policy" + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:testIamPermissions", + "httpMethod": "POST", + "id": "dataplex.projects.locations.entryGroups.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "GoogleIamV1TestIamPermissionsRequest" + }, + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "entries": { + "methods": { + "create": { + "description": "Creates an Entry.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries", + "httpMethod": "POST", + "id": "dataplex.projects.locations.entryGroups.entries.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "entryId": { + "description": "Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use 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 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 other providers or systems than Google Cloud.The maximum size of the field is 4000 characters.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/entries", + "request": { + "$ref": "GoogleCloudDataplexV1Entry" + }, + "response": { + "$ref": "GoogleCloudDataplexV1Entry" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an Entry.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}", + "httpMethod": "DELETE", + "id": "dataplex.projects.locations.entryGroups.entries.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudDataplexV1Entry" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a single entry.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}", + "httpMethod": "GET", + "id": "dataplex.projects.locations.entryGroups.entries.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "aspectTypes": { + "description": "Optional. Limits the aspects returned to the provided aspect types. Only works if the CUSTOM view is selected.", + "location": "query", + "repeated": true, + "type": "string" + }, + "name": { + "description": "Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/.*$", + "required": true, + "type": "string" + }, + "paths": { + "description": "Optional. Limits the aspects returned to those associated with the provided paths within the Entry. Only works if the CUSTOM view is selected.", + "location": "query", + "repeated": true, + "type": "string" + }, + "view": { + "description": "Optional. View for controlling which parts of an entry are to be returned.", + "enum": [ + "ENTRY_VIEW_UNSPECIFIED", + "BASIC", + "FULL", + "CUSTOM", + "ALL" + ], + "enumDescriptions": [ + "Unspecified EntryView. Defaults to FULL.", + "Returns entry only, without aspects.", + "Returns all required aspects as well as the keys of all non-required aspects.", + "Returns aspects matching custom fields in GetEntryRequest. If the number of aspects would exceed 100, the first 100 will be returned.", + "Returns all aspects. If the number of aspects would exceed 100, the first 100 will be returned." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudDataplexV1Entry" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists entries within an entry group.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries", + "httpMethod": "GET", + "id": "dataplex.projects.locations.entryGroups.entries.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. A filter on the entries to return. Filters are case-sensitive. The request can be filtered by the following fields: entry_type, display_name. The comparison operators are =, !=, <, >, <=, >= (strings are compared according to lexical order) The logical operators AND, OR, NOT can be used in the filter. Example filter expressions: \"display_name=AnExampleDisplayName\" \"entry_type=projects/example-project/locations/global/entryTypes/example-entry_type\" \"entry_type=projects/a* OR \"entry_type=projects/k*\" \"NOT display_name=AnotherExampleDisplayName\"", + "location": "query", + "type": "string" + }, + "pageSize": { + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The pagination token returned by a previous request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/entries", + "response": { + "$ref": "GoogleCloudDataplexV1ListEntriesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an Entry.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}", + "httpMethod": "PATCH", + "id": "dataplex.projects.locations.entryGroups.entries.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "allowMissing": { + "description": "Optional. If set to true and the entry does not exist, it will be created.", + "location": "query", + "type": "boolean" + }, + "aspectKeys": { + "description": "Optional. The map keys of the Aspects which should be modified. Supports the following syntaxes: * - matches aspect on given type and empty path * @path - matches aspect on given type and specified path * * - matches aspects on given type for all paths * *@path - matches aspects of all types on the given pathExisting aspects matching the syntax will not be removed unless delete_missing_aspects is set to true.If this field is left empty, it will be treated as specifying exactly those Aspects present in the request.", + "location": "query", + "repeated": true, + "type": "string" + }, + "deleteMissingAspects": { + "description": "Optional. If set to true and the aspect_keys specify aspect ranges, any existing aspects from that range not provided in the request will be deleted.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/.*$", + "required": true, + "type": "string" + }, + "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, all modifiable fields present in the request will be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudDataplexV1Entry" + }, + "response": { + "$ref": "GoogleCloudDataplexV1Entry" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "entryTypes": { + "methods": { + "create": { + "description": "Creates an EntryType", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryTypes", + "httpMethod": "POST", + "id": "dataplex.projects.locations.entryTypes.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "entryTypeId": { + "description": "Required. EntryType identifier.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the EntryType, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "validateOnly": { + "description": "Optional. Only validate the request, but do not perform mutations. The default is false.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+parent}/entryTypes", + "request": { + "$ref": "GoogleCloudDataplexV1EntryType" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a EntryType resource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}", + "httpMethod": "DELETE", + "id": "dataplex.projects.locations.entryTypes.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. If the client provided etag value does not match the current etag value, the DeleteEntryTypeRequest method returns an ABORTED error response", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The resource name of the EntryType: projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/entryTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:testIamPermissions", - "httpMethod": "POST", - "id": "dataplex.projects.locations.entryGroups.testIamPermissions", + "get": { + "description": "Retrieves a EntryType resource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}", + "httpMethod": "GET", + "id": "dataplex.projects.locations.entryTypes.get", "parameterOrder": [ - "resource" + "name" ], "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "name": { + "description": "Required. The resource name of the EntryType: projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/entryTypes/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+resource}:testIamPermissions", - "request": { - "$ref": "GoogleIamV1TestIamPermissionsRequest" - }, + "path": "v1/{+name}", "response": { - "$ref": "GoogleIamV1TestIamPermissionsResponse" + "$ref": "GoogleCloudDataplexV1EntryType" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - } - } - }, - "entryTypes": { - "methods": { + }, "getIamPolicy": { "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}:getIamPolicy", @@ -1595,6 +2421,91 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "list": { + "description": "Lists EntryType resources in a project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryTypes", + "httpMethod": "GET", + "id": "dataplex.projects.locations.entryTypes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter request. Filters are case-sensitive. The following formats are supported:labels.key1 = \"value1\" labels:key1 name = \"value\" These restrictions can be coinjoined with AND, OR and NOT conjunctions.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Order by fields (name or create_time) for the result. If not specified, the ordering is undefined.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of EntryTypes to return. The service may return fewer than this value. If unspecified, at most 10 EntryTypes 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. Page token received from a previous ListEntryTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEntryTypes must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the EntryType location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/entryTypes", + "response": { + "$ref": "GoogleCloudDataplexV1ListEntryTypesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a EntryType resource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}", + "httpMethod": "PATCH", + "id": "dataplex.projects.locations.entryTypes.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The relative resource name of the EntryType, of the form: projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/entryTypes/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Mask of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. Only validate the request, but do not perform mutations. The default is false.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudDataplexV1EntryType" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}:setIamPolicy", @@ -4360,7 +5271,7 @@ } } }, - "revision": "20240304", + "revision": "20240317", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { "Empty": { @@ -4578,6 +5489,269 @@ "properties": {}, "type": "object" }, + "GoogleCloudDataplexV1Aspect": { + "description": "An aspect is a single piece of metadata describing an entry.", + "id": "GoogleCloudDataplexV1Aspect", + "properties": { + "aspectSource": { + "$ref": "GoogleCloudDataplexV1AspectSource" + }, + "aspectType": { + "description": "Output only. The resource name of the type used to create this Aspect.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time when the Aspect was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "data": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Required. The content of the aspect, according to its aspect type schema. This will replace content. The maximum size of the field is 120KB (encoded as UTF-8).", + "type": "object" + }, + "path": { + "description": "Output only. The path in the entry under which the aspect is attached.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time when the Aspect was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1AspectSource": { + "description": "AspectSource contains source system related information for the aspect.", + "id": "GoogleCloudDataplexV1AspectSource", + "properties": { + "createTime": { + "description": "The create time of the aspect in the source system.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "The update time of the aspect in the source system.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1AspectType": { + "description": "Aspect Type is a template for creating Aspects, and represents the JSON-schema for a given Entry, e.g., BigQuery Table Schema.", + "id": "GoogleCloudDataplexV1AspectType", + "properties": { + "authorization": { + "$ref": "GoogleCloudDataplexV1AspectTypeAuthorization", + "description": "Immutable. Authorization defined for this type." + }, + "createTime": { + "description": "Output only. The time when the AspectType was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. Description of the AspectType.", + "type": "string" + }, + "displayName": { + "description": "Optional. User friendly display name.", + "type": "string" + }, + "etag": { + "description": "This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. User-defined labels for the AspectType.", + "type": "object" + }, + "metadataTemplate": { + "$ref": "GoogleCloudDataplexV1AspectTypeMetadataTemplate", + "description": "Required. MetadataTemplate of the aspect." + }, + "name": { + "description": "Output only. The relative resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}.", + "readOnly": true, + "type": "string" + }, + "transferStatus": { + "description": "Output only. Denotes the transfer status of the Aspect Type. It is unspecified for Aspect Types created from Dataplex API.", + "enum": [ + "TRANSFER_STATUS_UNSPECIFIED", + "TRANSFER_STATUS_MIGRATED", + "TRANSFER_STATUS_TRANSFERRED" + ], + "enumDescriptions": [ + "The default value. It is set for resources that were not subject for migration from Data Catalog service.", + "Indicates that a resource was migrated from Data Catalog service but it hasn't been transferred yet. In particular the resource cannot be updated from Dataplex API.", + "Indicates that a resource was transferred from Data Catalog service. The resource can only be updated from Dataplex API." + ], + "readOnly": true, + "type": "string" + }, + "uid": { + "description": "Output only. System generated globally unique ID for the AspectType. This ID will be different if the AspectType is deleted and re-created with the same name.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time when the AspectType was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1AspectTypeAuthorization": { + "description": "Autorization for an Aspect Type.", + "id": "GoogleCloudDataplexV1AspectTypeAuthorization", + "properties": { + "alternateUsePermission": { + "description": "Immutable. The IAM permission grantable on the Entry Group to allow access to instantiate Aspects of Dataplex owned Aspect Types, only settable for Dataplex owned Types.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1AspectTypeMetadataTemplate": { + "description": "MetadataTemplate definition for AspectType", + "id": "GoogleCloudDataplexV1AspectTypeMetadataTemplate", + "properties": { + "annotations": { + "$ref": "GoogleCloudDataplexV1AspectTypeMetadataTemplateAnnotations", + "description": "Optional. Specifies annotations on this field." + }, + "arrayItems": { + "$ref": "GoogleCloudDataplexV1AspectTypeMetadataTemplate", + "description": "Optional. array_items needs to be set if the type is array. array_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, just name and type needs to be set in the nested MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload." + }, + "constraints": { + "$ref": "GoogleCloudDataplexV1AspectTypeMetadataTemplateConstraints", + "description": "Optional. Specifies the constraints on this field." + }, + "enumValues": { + "description": "Optional. The list of values for an enum type. Needs to be defined if the type is enum.", + "items": { + "$ref": "GoogleCloudDataplexV1AspectTypeMetadataTemplateEnumValue" + }, + "type": "array" + }, + "index": { + "description": "Optional. Index is used to encode Template messages. The value of index can range between 1 and 2,147,483,647. Index must be unique within all fields in a Template. (Nested Templates can reuse indexes). Once a Template is defined, the index cannot be changed, because it identifies the field in the actual storage format. Index is a mandatory field, but it is optional for top level fields, and map/array \"values\" definitions.", + "format": "int32", + "type": "integer" + }, + "mapItems": { + "$ref": "GoogleCloudDataplexV1AspectTypeMetadataTemplate", + "description": "Optional. map_items needs to be set if the type is map. map_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, just name and type needs to be set in the nested MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload." + }, + "name": { + "description": "Required. The name of the field.", + "type": "string" + }, + "recordFields": { + "description": "Optional. Field definition, needs to be specified if the type is record. Defines the nested fields.", + "items": { + "$ref": "GoogleCloudDataplexV1AspectTypeMetadataTemplate" + }, + "type": "array" + }, + "type": { + "description": "Required. The datatype of this field. The following values are supported: Primitive types (string, integer, boolean, double, datetime); datetime must be of the format RFC3339 UTC \"Zulu\" (Examples: \"2014-10-02T15:01:23Z\" and \"2014-10-02T15:01:23.045123456Z\"). Complex types (enum, array, map, record).", + "type": "string" + }, + "typeId": { + "description": "Optional. Id can be used if this definition of the field needs to be reused later. Id needs to be unique across the entire template. Id can only be specified if the field type is record.", + "type": "string" + }, + "typeRef": { + "description": "Optional. A reference to another field definition (instead of an inline definition). The value must be equal to the value of an id field defined elsewhere in the MetadataTemplate. Only fields with type as record can refer to other fields.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1AspectTypeMetadataTemplateAnnotations": { + "description": "Definition of the annotations of a field", + "id": "GoogleCloudDataplexV1AspectTypeMetadataTemplateAnnotations", + "properties": { + "deprecated": { + "description": "Optional. Marks a field as deprecated, a deprecation message can be included.", + "type": "string" + }, + "description": { + "description": "Optional. Specify a description for a field", + "type": "string" + }, + "displayName": { + "description": "Optional. Specify a displayname for a field.", + "type": "string" + }, + "displayOrder": { + "description": "Optional. Specify a display order for a field. Display order can be used to reorder where a field is rendered", + "format": "int32", + "type": "integer" + }, + "stringType": { + "description": "Optional. String Type annotations can be used to specify special meaning to string fields. The following values are supported: richText: The field must be interpreted as a rich text field. url: A fully qualified url link. resource: A service qualified resource reference.", + "type": "string" + }, + "stringValues": { + "description": "Optional. Suggested hints for string fields. These can be used to suggest values to users, through an UI for example.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1AspectTypeMetadataTemplateConstraints": { + "description": "Definition of the constraints of a field", + "id": "GoogleCloudDataplexV1AspectTypeMetadataTemplateConstraints", + "properties": { + "required": { + "description": "Optional. Marks this as an optional/required field.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1AspectTypeMetadataTemplateEnumValue": { + "description": "Definition of Enumvalue (to be used by enum fields)", + "id": "GoogleCloudDataplexV1AspectTypeMetadataTemplateEnumValue", + "properties": { + "deprecated": { + "description": "Optional. Optional deprecation message to be set if an enum value needs to be deprecated.", + "type": "string" + }, + "index": { + "description": "Required. Index for the enum. Cannot be modified.", + "format": "int32", + "type": "integer" + }, + "name": { + "description": "Required. Name of the enumvalue. This is the actual value that the aspect will contain.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDataplexV1Asset": { "description": "An asset represents a cloud resource that is being managed within a lake as a member of a zone.", "id": "GoogleCloudDataplexV1Asset", @@ -6818,107 +7992,390 @@ }, "type": "object" }, - "GoogleCloudDataplexV1Entity": { - "description": "Represents tables and fileset metadata contained within a zone.", - "id": "GoogleCloudDataplexV1Entity", + "GoogleCloudDataplexV1Entity": { + "description": "Represents tables and fileset metadata contained within a zone.", + "id": "GoogleCloudDataplexV1Entity", + "properties": { + "access": { + "$ref": "GoogleCloudDataplexV1StorageAccess", + "description": "Output only. Identifies the access mechanism to the entity. Not user settable.", + "readOnly": true + }, + "asset": { + "description": "Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.", + "type": "string" + }, + "catalogEntry": { + "description": "Output only. The name of the associated Data Catalog entry.", + "readOnly": true, + "type": "string" + }, + "compatibility": { + "$ref": "GoogleCloudDataplexV1EntityCompatibilityStatus", + "description": "Output only. Metadata stores that the entity is compatible with.", + "readOnly": true + }, + "createTime": { + "description": "Output only. The time when the entity was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "dataPath": { + "description": "Required. Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id.", + "type": "string" + }, + "dataPathPattern": { + "description": "Optional. The set of items within the data path constituting the data in the entity, represented as a glob path. Example: gs://bucket/path/to/data/**/*.csv.", + "type": "string" + }, + "description": { + "description": "Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.", + "type": "string" + }, + "displayName": { + "description": "Optional. Display name must be shorter than or equal to 256 characters.", + "type": "string" + }, + "etag": { + "description": "Optional. The etag associated with the entity, which can be retrieved with a GetEntity request. Required for update and delete requests.", + "type": "string" + }, + "format": { + "$ref": "GoogleCloudDataplexV1StorageFormat", + "description": "Required. Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery." + }, + "id": { + "description": "Required. A user-provided entity ID. It is mutable, and will be used as the published table name. Specifying a new ID in an update entity request will override the existing value. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores, and consist of 256 or fewer characters.", + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the entity, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}.", + "readOnly": true, + "type": "string" + }, + "schema": { + "$ref": "GoogleCloudDataplexV1Schema", + "description": "Required. The description of the data structure and layout. The schema is not included in list responses. It is only included in SCHEMA and FULL entity views of a GetEntity response." + }, + "system": { + "description": "Required. Immutable. Identifies the storage system of the entity data.", + "enum": [ + "STORAGE_SYSTEM_UNSPECIFIED", + "CLOUD_STORAGE", + "BIGQUERY" + ], + "enumDescriptions": [ + "Storage system unspecified.", + "The entity data is contained within a Cloud Storage bucket.", + "The entity data is contained within a BigQuery dataset." + ], + "type": "string" + }, + "type": { + "description": "Required. Immutable. The type of entity.", + "enum": [ + "TYPE_UNSPECIFIED", + "TABLE", + "FILESET" + ], + "enumDescriptions": [ + "Type unspecified.", + "Structured and semi-structured data.", + "Unstructured data." + ], + "type": "string" + }, + "uid": { + "description": "Output only. System generated unique ID for the Entity. This ID will be different if the Entity is deleted and re-created with the same name.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time when the entity was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1EntityCompatibilityStatus": { + "description": "Provides compatibility information for various metadata stores.", + "id": "GoogleCloudDataplexV1EntityCompatibilityStatus", + "properties": { + "bigquery": { + "$ref": "GoogleCloudDataplexV1EntityCompatibilityStatusCompatibility", + "description": "Output only. Whether this entity is compatible with BigQuery.", + "readOnly": true + }, + "hiveMetastore": { + "$ref": "GoogleCloudDataplexV1EntityCompatibilityStatusCompatibility", + "description": "Output only. Whether this entity is compatible with Hive Metastore.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1EntityCompatibilityStatusCompatibility": { + "description": "Provides compatibility information for a specific metadata store.", + "id": "GoogleCloudDataplexV1EntityCompatibilityStatusCompatibility", + "properties": { + "compatible": { + "description": "Output only. Whether the entity is compatible and can be represented in the metadata store.", + "readOnly": true, + "type": "boolean" + }, + "reason": { + "description": "Output only. Provides additional detail if the entity is incompatible with the metadata store.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1Entry": { + "description": "An entry is a representation of a data asset which can be described by various metadata.", + "id": "GoogleCloudDataplexV1Entry", + "properties": { + "aspects": { + "additionalProperties": { + "$ref": "GoogleCloudDataplexV1Aspect" + }, + "description": "Optional. The Aspects attached to the Entry. The key is either the resource name of the aspect type (if the aspect is attached directly to the entry) or \"aspectType@path\" if the aspect is attached to an entry's path.", + "type": "object" + }, + "createTime": { + "description": "Output only. The time when the Entry was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "entrySource": { + "$ref": "GoogleCloudDataplexV1EntrySource", + "description": "Optional. Source system related information for an entry." + }, + "entryType": { + "description": "Required. Immutable. The resource name of the EntryType used to create this Entry.", + "type": "string" + }, + "fullyQualifiedName": { + "description": "Optional. A name for the entry that can reference it in an external system. The maximum size of the field is 4000 characters.", + "type": "string" + }, + "name": { + "description": "Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.", + "type": "string" + }, + "parentEntry": { + "description": "Optional. Immutable. The resource name of the parent entry.", + "type": "string" + }, + "updateTime": { + "description": "Output only. The time when the Entry was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1EntryGroup": { + "description": "An Entry Group represents a logical grouping of one or more Entries.", + "id": "GoogleCloudDataplexV1EntryGroup", + "properties": { + "createTime": { + "description": "Output only. The time when the EntryGroup was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. Description of the EntryGroup.", + "type": "string" + }, + "displayName": { + "description": "Optional. User friendly display name.", + "type": "string" + }, + "etag": { + "description": "This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. User-defined labels for the EntryGroup.", + "type": "object" + }, + "name": { + "description": "Output only. The relative resource name of the EntryGroup, of the form: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}.", + "readOnly": true, + "type": "string" + }, + "transferStatus": { + "description": "Output only. Denotes the transfer status of the Entry Group. It is unspecified for Entry Group created from Dataplex API.", + "enum": [ + "TRANSFER_STATUS_UNSPECIFIED", + "TRANSFER_STATUS_MIGRATED", + "TRANSFER_STATUS_TRANSFERRED" + ], + "enumDescriptions": [ + "The default value. It is set for resources that were not subject for migration from Data Catalog service.", + "Indicates that a resource was migrated from Data Catalog service but it hasn't been transferred yet. In particular the resource cannot be updated from Dataplex API.", + "Indicates that a resource was transferred from Data Catalog service. The resource can only be updated from Dataplex API." + ], + "readOnly": true, + "type": "string" + }, + "uid": { + "description": "Output only. System generated globally unique ID for the EntryGroup. This ID will be different if the EntryGroup is deleted and re-created with the same name.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time when the EntryGroup was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1EntrySource": { + "description": "EntrySource contains source system related information for the entry.", + "id": "GoogleCloudDataplexV1EntrySource", + "properties": { + "ancestors": { + "description": "Immutable. The ancestors of the Entry in the source system.", + "items": { + "$ref": "GoogleCloudDataplexV1EntrySourceAncestor" + }, + "type": "array" + }, + "createTime": { + "description": "The create time of the resource in the source system.", + "format": "google-datetime", + "type": "string" + }, + "description": { + "description": "Description of the Entry. The maximum size of the field is 2000 characters.", + "type": "string" + }, + "displayName": { + "description": "User friendly display name. The maximum size of the field is 500 characters.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "User-defined labels. The maximum size of keys and values is 128 characters each.", + "type": "object" + }, + "platform": { + "description": "The platform containing the source system. The maximum size of the field is 64 characters.", + "type": "string" + }, + "resource": { + "description": "The name of the resource in the source system. The maximum size of the field is 4000 characters.", + "type": "string" + }, + "system": { + "description": "The name of the source system. The maximum size of the field is 64 characters.", + "type": "string" + }, + "updateTime": { + "description": "The update time of the resource in the source system.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1EntrySourceAncestor": { + "description": "Ancestor contains information about individual items in the hierarchy of an Entry.", + "id": "GoogleCloudDataplexV1EntrySourceAncestor", "properties": { - "access": { - "$ref": "GoogleCloudDataplexV1StorageAccess", - "description": "Output only. Identifies the access mechanism to the entity. Not user settable.", - "readOnly": true - }, - "asset": { - "description": "Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.", + "name": { + "description": "Optional. The name of the ancestor resource.", "type": "string" }, - "catalogEntry": { - "description": "Output only. The name of the associated Data Catalog entry.", - "readOnly": true, + "type": { + "description": "Optional. The type of the ancestor resource.", "type": "string" - }, - "compatibility": { - "$ref": "GoogleCloudDataplexV1EntityCompatibilityStatus", - "description": "Output only. Metadata stores that the entity is compatible with.", - "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1EntryType": { + "description": "Entry Type is a template for creating Entries.", + "id": "GoogleCloudDataplexV1EntryType", + "properties": { + "authorization": { + "$ref": "GoogleCloudDataplexV1EntryTypeAuthorization", + "description": "Immutable. Authorization defined for this type." }, "createTime": { - "description": "Output only. The time when the entity was created.", + "description": "Output only. The time when the EntryType was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, - "dataPath": { - "description": "Required. Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id.", - "type": "string" - }, - "dataPathPattern": { - "description": "Optional. The set of items within the data path constituting the data in the entity, represented as a glob path. Example: gs://bucket/path/to/data/**/*.csv.", - "type": "string" - }, "description": { - "description": "Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.", + "description": "Optional. Description of the EntryType.", "type": "string" }, "displayName": { - "description": "Optional. Display name must be shorter than or equal to 256 characters.", + "description": "Optional. User friendly display name.", "type": "string" }, "etag": { - "description": "Optional. The etag associated with the entity, which can be retrieved with a GetEntity request. Required for update and delete requests.", + "description": "Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", "type": "string" }, - "format": { - "$ref": "GoogleCloudDataplexV1StorageFormat", - "description": "Required. Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery." - }, - "id": { - "description": "Required. A user-provided entity ID. It is mutable, and will be used as the published table name. Specifying a new ID in an update entity request will override the existing value. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores, and consist of 256 or fewer characters.", - "type": "string" + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. User-defined labels for the EntryType.", + "type": "object" }, "name": { - "description": "Output only. The resource name of the entity, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}.", + "description": "Output only. The relative resource name of the EntryType, of the form: projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}.", "readOnly": true, "type": "string" }, - "schema": { - "$ref": "GoogleCloudDataplexV1Schema", - "description": "Required. The description of the data structure and layout. The schema is not included in list responses. It is only included in SCHEMA and FULL entity views of a GetEntity response." + "platform": { + "description": "Optional. The platform that Entries of this type belongs to.", + "type": "string" + }, + "requiredAspects": { + "description": "AspectInfo for the entry type.", + "items": { + "$ref": "GoogleCloudDataplexV1EntryTypeAspectInfo" + }, + "type": "array" }, "system": { - "description": "Required. Immutable. Identifies the storage system of the entity data.", - "enum": [ - "STORAGE_SYSTEM_UNSPECIFIED", - "CLOUD_STORAGE", - "BIGQUERY" - ], - "enumDescriptions": [ - "Storage system unspecified.", - "The entity data is contained within a Cloud Storage bucket.", - "The entity data is contained within a BigQuery dataset." - ], + "description": "Optional. The system that Entries of this type belongs to. Examples include CloudSQL, MariaDB etc", "type": "string" }, - "type": { - "description": "Required. Immutable. The type of entity.", - "enum": [ - "TYPE_UNSPECIFIED", - "TABLE", - "FILESET" - ], - "enumDescriptions": [ - "Type unspecified.", - "Structured and semi-structured data.", - "Unstructured data." - ], - "type": "string" + "typeAliases": { + "description": "Optional. Indicates the class this Entry Type belongs to, for example, TABLE, DATABASE, MODEL.", + "items": { + "type": "string" + }, + "type": "array" }, "uid": { - "description": "Output only. System generated unique ID for the Entity. This ID will be different if the Entity is deleted and re-created with the same name.", + "description": "Output only. System generated globally unique ID for the EntryType. This ID will be different if the EntryType is deleted and re-created with the same name.", "readOnly": true, "type": "string" }, "updateTime": { - "description": "Output only. The time when the entity was last updated.", + "description": "Output only. The time when the EntryType was last updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -6926,35 +8383,22 @@ }, "type": "object" }, - "GoogleCloudDataplexV1EntityCompatibilityStatus": { - "description": "Provides compatibility information for various metadata stores.", - "id": "GoogleCloudDataplexV1EntityCompatibilityStatus", + "GoogleCloudDataplexV1EntryTypeAspectInfo": { + "id": "GoogleCloudDataplexV1EntryTypeAspectInfo", "properties": { - "bigquery": { - "$ref": "GoogleCloudDataplexV1EntityCompatibilityStatusCompatibility", - "description": "Output only. Whether this entity is compatible with BigQuery.", - "readOnly": true - }, - "hiveMetastore": { - "$ref": "GoogleCloudDataplexV1EntityCompatibilityStatusCompatibility", - "description": "Output only. Whether this entity is compatible with Hive Metastore.", - "readOnly": true + "type": { + "description": "Required aspect type for the entry type.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDataplexV1EntityCompatibilityStatusCompatibility": { - "description": "Provides compatibility information for a specific metadata store.", - "id": "GoogleCloudDataplexV1EntityCompatibilityStatusCompatibility", + "GoogleCloudDataplexV1EntryTypeAuthorization": { + "description": "Authorization for an Entry Type.", + "id": "GoogleCloudDataplexV1EntryTypeAuthorization", "properties": { - "compatible": { - "description": "Output only. Whether the entity is compatible and can be represented in the metadata store.", - "readOnly": true, - "type": "boolean" - }, - "reason": { - "description": "Output only. Provides additional detail if the entity is incompatible with the metadata store.", - "readOnly": true, + "alternateUsePermission": { + "description": "Immutable. The IAM permission grantable on the Entry Group to allow access to instantiate Entries of Dataplex owned Entry Types, only settable for Dataplex owned Types.", "type": "string" } }, @@ -7155,6 +8599,26 @@ }, "type": "object" }, + "GoogleCloudDataplexV1GenerateDataQualityRulesRequest": { + "description": "Generate recommended DataQualityRules request.", + "id": "GoogleCloudDataplexV1GenerateDataQualityRulesRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDataplexV1GenerateDataQualityRulesResponse": { + "description": "Generate recommended DataQualityRules response.", + "id": "GoogleCloudDataplexV1GenerateDataQualityRulesResponse", + "properties": { + "rule": { + "description": "Generated recommended {@link DataQualityRule}s.", + "items": { + "$ref": "GoogleCloudDataplexV1DataQualityRule" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDataplexV1GovernanceEvent": { "description": "Payload associated with Governance related log events.", "id": "GoogleCloudDataplexV1GovernanceEvent", @@ -7587,6 +9051,31 @@ }, "type": "object" }, + "GoogleCloudDataplexV1ListAspectTypesResponse": { + "description": "List AspectTypes response", + "id": "GoogleCloudDataplexV1ListAspectTypesResponse", + "properties": { + "aspectTypes": { + "description": "ListAspectTypes under the given parent location.", + "items": { + "$ref": "GoogleCloudDataplexV1AspectType" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + }, + "unreachableLocations": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDataplexV1ListAssetsResponse": { "description": "List assets response.", "id": "GoogleCloudDataplexV1ListAssetsResponse", @@ -7759,6 +9248,73 @@ }, "type": "object" }, + "GoogleCloudDataplexV1ListEntriesResponse": { + "id": "GoogleCloudDataplexV1ListEntriesResponse", + "properties": { + "entries": { + "description": "The list of entries.", + "items": { + "$ref": "GoogleCloudDataplexV1Entry" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Pagination token.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1ListEntryGroupsResponse": { + "description": "List ListEntryGroups response.", + "id": "GoogleCloudDataplexV1ListEntryGroupsResponse", + "properties": { + "entryGroups": { + "description": "ListEntryGroups under the given parent location.", + "items": { + "$ref": "GoogleCloudDataplexV1EntryGroup" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + }, + "unreachableLocations": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1ListEntryTypesResponse": { + "description": "List EntryTypes response", + "id": "GoogleCloudDataplexV1ListEntryTypesResponse", + "properties": { + "entryTypes": { + "description": "ListEntryTypes under the given parent location.", + "items": { + "$ref": "GoogleCloudDataplexV1EntryType" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + }, + "unreachableLocations": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDataplexV1ListEnvironmentsResponse": { "description": "List environments response.", "id": "GoogleCloudDataplexV1ListEnvironmentsResponse", @@ -8242,6 +9798,101 @@ }, "type": "object" }, + "GoogleCloudDataplexV1SearchEntriesResponse": { + "id": "GoogleCloudDataplexV1SearchEntriesResponse", + "properties": { + "nextPageToken": { + "description": "Pagination token.", + "type": "string" + }, + "results": { + "description": "The results matching the search query.", + "items": { + "$ref": "GoogleCloudDataplexV1SearchEntriesResult" + }, + "type": "array" + }, + "totalSize": { + "description": "The estimated total number of matching entries. Not guaranteed to be accurate.", + "format": "int32", + "type": "integer" + }, + "unreachable": { + "description": "Unreachable locations. Search results don't include data from those locations.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1SearchEntriesResult": { + "description": "A single result of a SearchEntries request.", + "id": "GoogleCloudDataplexV1SearchEntriesResult", + "properties": { + "dataplexEntry": { + "$ref": "GoogleCloudDataplexV1Entry", + "description": "Entry format of the result." + }, + "description": { + "deprecated": true, + "description": "Entry description.", + "type": "string" + }, + "displayName": { + "deprecated": true, + "description": "Display name.", + "type": "string" + }, + "entry": { + "deprecated": true, + "description": "Resource name of the entry.", + "type": "string" + }, + "entryType": { + "deprecated": true, + "description": "The entry type.", + "type": "string" + }, + "fullyQualifiedName": { + "deprecated": true, + "description": "Fully qualified name.", + "type": "string" + }, + "linkedResource": { + "description": "Linked resource name.", + "type": "string" + }, + "modifyTime": { + "deprecated": true, + "description": "The last modification timestamp.", + "format": "google-datetime", + "type": "string" + }, + "relativeResource": { + "deprecated": true, + "description": "Relative resource name.", + "type": "string" + }, + "snippets": { + "$ref": "GoogleCloudDataplexV1SearchEntriesResultSnippets", + "description": "Snippets." + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1SearchEntriesResultSnippets": { + "description": "Snippets for the entry, contains HTML-style highlighting for matched tokens, will be used in UI.", + "id": "GoogleCloudDataplexV1SearchEntriesResultSnippets", + "properties": { + "dataplexEntry": { + "$ref": "GoogleCloudDataplexV1Entry", + "description": "Entry" + } + }, + "type": "object" + }, "GoogleCloudDataplexV1Session": { "description": "Represents an active analyze session running for a user.", "id": "GoogleCloudDataplexV1Session", diff --git a/discovery/dataportability-v1.json b/discovery/dataportability-v1.json index a8f4490ff9..748749e021 100644 --- a/discovery/dataportability-v1.json +++ b/discovery/dataportability-v1.json @@ -2,6 +2,9 @@ "auth": { "oauth2": { "scopes": { + "https://www.googleapis.com/auth/dataportability.alerts.subscriptions": { + "description": "Move a copy of the Google Alerts subscriptions you created." + }, "https://www.googleapis.com/auth/dataportability.businessmessaging.conversations": { "description": "Move a copy of messages between you and the businesses you have conversations with across Google services." }, @@ -26,6 +29,18 @@ "https://www.googleapis.com/auth/dataportability.chrome.settings": { "description": "Move a copy of your settings in Chrome." }, + "https://www.googleapis.com/auth/dataportability.discover.follows": { + "description": "Move a copy of searches and sites you follow, saved by Discover." + }, + "https://www.googleapis.com/auth/dataportability.discover.likes": { + "description": "Move a copy of links to your liked documents, saved by Discover." + }, + "https://www.googleapis.com/auth/dataportability.discover.not_interested": { + "description": "Move a copy of content you marked as not interested, saved by Discover." + }, + "https://www.googleapis.com/auth/dataportability.maps.aliased_places": { + "description": "Move a copy of the places you labeled on Maps." + }, "https://www.googleapis.com/auth/dataportability.maps.commute_routes": { "description": "Move a copy of your pinned trips on Maps." }, @@ -35,12 +50,21 @@ "https://www.googleapis.com/auth/dataportability.maps.ev_profile": { "description": "Move a copy of your electric vehicle profile on Maps." }, + "https://www.googleapis.com/auth/dataportability.maps.factual_contributions": { + "description": "Move a copy of the corrections you made to places or map information on Maps." + }, "https://www.googleapis.com/auth/dataportability.maps.offering_contributions": { "description": "Move a copy of your updates to places on Maps." }, "https://www.googleapis.com/auth/dataportability.maps.photos_videos": { "description": "Move a copy of the photos and videos you posted on Maps." }, + "https://www.googleapis.com/auth/dataportability.maps.post_trip_feedback": { + "description": "Move a copy of feedback you gave after completing trips using Maps directions." + }, + "https://www.googleapis.com/auth/dataportability.maps.questions_answers": { + "description": "Move a copy of the questions and answers you posted on Maps." + }, "https://www.googleapis.com/auth/dataportability.maps.reviews": { "description": "Move a copy of your reviews and posts on Maps." }, @@ -50,6 +74,12 @@ "https://www.googleapis.com/auth/dataportability.myactivity.maps": { "description": "Move a copy of your Maps activity." }, + "https://www.googleapis.com/auth/dataportability.myactivity.myadcenter": { + "description": "Move a copy of your My Ad Center activity." + }, + "https://www.googleapis.com/auth/dataportability.myactivity.play": { + "description": "Move a copy of your Google Play activity." + }, "https://www.googleapis.com/auth/dataportability.myactivity.search": { "description": "Move a copy of your Google Search activity." }, @@ -59,15 +89,72 @@ "https://www.googleapis.com/auth/dataportability.myactivity.youtube": { "description": "Move a copy of your YouTube activity." }, + "https://www.googleapis.com/auth/dataportability.mymaps.maps": { + "description": "Move a copy of the maps you created in My Maps." + }, + "https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations": { + "description": "Move a copy of your food purchase and reservation activity." + }, + "https://www.googleapis.com/auth/dataportability.play.devices": { + "description": "Move a copy of information about your devices with Google Play Store installed." + }, + "https://www.googleapis.com/auth/dataportability.play.grouping": { + "description": "Move a copy of your Google Play Store Grouping tags created by app developers." + }, + "https://www.googleapis.com/auth/dataportability.play.installs": { + "description": "Move a copy of your Google Play Store app installations." + }, + "https://www.googleapis.com/auth/dataportability.play.library": { + "description": "Move a copy of your Google Play Store downloads, including books, games, and apps." + }, + "https://www.googleapis.com/auth/dataportability.play.playpoints": { + "description": "Move a copy of information about your Google Play Store Points." + }, + "https://www.googleapis.com/auth/dataportability.play.promotions": { + "description": "Move a copy of information about your Google Play Store promotions." + }, + "https://www.googleapis.com/auth/dataportability.play.purchases": { + "description": "Move a copy of your Google Play Store purchases." + }, + "https://www.googleapis.com/auth/dataportability.play.redemptions": { + "description": "Move a copy of your Google Play Store redemption activities." + }, + "https://www.googleapis.com/auth/dataportability.play.subscriptions": { + "description": "Move a copy of your Google Play Store subscriptions." + }, + "https://www.googleapis.com/auth/dataportability.play.usersettings": { + "description": "Move a copy of your Google Play Store user settings and preferences." + }, "https://www.googleapis.com/auth/dataportability.saved.collections": { "description": "Move a copy of your saved links, images, places, and collections from your use of Google services." }, + "https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars": { + "description": "Move a copy of your media reviews on Google Search." + }, + "https://www.googleapis.com/auth/dataportability.search_ugc.media.streaming_video_providers": { + "description": "Move a copy of your self-reported video streaming provider preferences from Google Search and Google TV." + }, + "https://www.googleapis.com/auth/dataportability.search_ugc.media.thumbs": { + "description": "Move a copy of your indicated thumbs up and thumbs down on media in Google Search and Google TV." + }, + "https://www.googleapis.com/auth/dataportability.search_ugc.media.watched": { + "description": "Move a copy of information about the movies and TV shows you marked as watched on Google Search and Google TV." + }, + "https://www.googleapis.com/auth/dataportability.searchnotifications.settings": { + "description": "Move a copy of your notification settings on the Google Search app." + }, + "https://www.googleapis.com/auth/dataportability.searchnotifications.subscriptions": { + "description": "Move a copy of your notification subscriptions on Google Search app." + }, "https://www.googleapis.com/auth/dataportability.shopping.addresses": { "description": "Move a copy of your shipping information on Shopping." }, "https://www.googleapis.com/auth/dataportability.shopping.reviews": { "description": "Move a copy of reviews you wrote about products or online stores on Google Search." }, + "https://www.googleapis.com/auth/dataportability.streetview.imagery": { + "description": "Move a copy of the images and videos you uploaded to Street View." + }, "https://www.googleapis.com/auth/dataportability.youtube.channel": { "description": "Move a copy of information about your YouTube channel." }, @@ -234,6 +321,7 @@ "$ref": "PortabilityArchiveState" }, "scopes": [ + "https://www.googleapis.com/auth/dataportability.alerts.subscriptions", "https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", "https://www.googleapis.com/auth/dataportability.chrome.autofill", "https://www.googleapis.com/auth/dataportability.chrome.bookmarks", @@ -242,20 +330,48 @@ "https://www.googleapis.com/auth/dataportability.chrome.history", "https://www.googleapis.com/auth/dataportability.chrome.reading_list", "https://www.googleapis.com/auth/dataportability.chrome.settings", + "https://www.googleapis.com/auth/dataportability.discover.follows", + "https://www.googleapis.com/auth/dataportability.discover.likes", + "https://www.googleapis.com/auth/dataportability.discover.not_interested", + "https://www.googleapis.com/auth/dataportability.maps.aliased_places", "https://www.googleapis.com/auth/dataportability.maps.commute_routes", "https://www.googleapis.com/auth/dataportability.maps.commute_settings", "https://www.googleapis.com/auth/dataportability.maps.ev_profile", + "https://www.googleapis.com/auth/dataportability.maps.factual_contributions", "https://www.googleapis.com/auth/dataportability.maps.offering_contributions", "https://www.googleapis.com/auth/dataportability.maps.photos_videos", + "https://www.googleapis.com/auth/dataportability.maps.post_trip_feedback", + "https://www.googleapis.com/auth/dataportability.maps.questions_answers", "https://www.googleapis.com/auth/dataportability.maps.reviews", "https://www.googleapis.com/auth/dataportability.maps.starred_places", "https://www.googleapis.com/auth/dataportability.myactivity.maps", + "https://www.googleapis.com/auth/dataportability.myactivity.myadcenter", + "https://www.googleapis.com/auth/dataportability.myactivity.play", "https://www.googleapis.com/auth/dataportability.myactivity.search", "https://www.googleapis.com/auth/dataportability.myactivity.shopping", "https://www.googleapis.com/auth/dataportability.myactivity.youtube", + "https://www.googleapis.com/auth/dataportability.mymaps.maps", + "https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations", + "https://www.googleapis.com/auth/dataportability.play.devices", + "https://www.googleapis.com/auth/dataportability.play.grouping", + "https://www.googleapis.com/auth/dataportability.play.installs", + "https://www.googleapis.com/auth/dataportability.play.library", + "https://www.googleapis.com/auth/dataportability.play.playpoints", + "https://www.googleapis.com/auth/dataportability.play.promotions", + "https://www.googleapis.com/auth/dataportability.play.purchases", + "https://www.googleapis.com/auth/dataportability.play.redemptions", + "https://www.googleapis.com/auth/dataportability.play.subscriptions", + "https://www.googleapis.com/auth/dataportability.play.usersettings", "https://www.googleapis.com/auth/dataportability.saved.collections", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.streaming_video_providers", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.thumbs", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.watched", + "https://www.googleapis.com/auth/dataportability.searchnotifications.settings", + "https://www.googleapis.com/auth/dataportability.searchnotifications.subscriptions", "https://www.googleapis.com/auth/dataportability.shopping.addresses", "https://www.googleapis.com/auth/dataportability.shopping.reviews", + "https://www.googleapis.com/auth/dataportability.streetview.imagery", "https://www.googleapis.com/auth/dataportability.youtube.channel", "https://www.googleapis.com/auth/dataportability.youtube.comments", "https://www.googleapis.com/auth/dataportability.youtube.live_chat", @@ -297,6 +413,7 @@ "$ref": "RetryPortabilityArchiveResponse" }, "scopes": [ + "https://www.googleapis.com/auth/dataportability.alerts.subscriptions", "https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", "https://www.googleapis.com/auth/dataportability.chrome.autofill", "https://www.googleapis.com/auth/dataportability.chrome.bookmarks", @@ -305,20 +422,48 @@ "https://www.googleapis.com/auth/dataportability.chrome.history", "https://www.googleapis.com/auth/dataportability.chrome.reading_list", "https://www.googleapis.com/auth/dataportability.chrome.settings", + "https://www.googleapis.com/auth/dataportability.discover.follows", + "https://www.googleapis.com/auth/dataportability.discover.likes", + "https://www.googleapis.com/auth/dataportability.discover.not_interested", + "https://www.googleapis.com/auth/dataportability.maps.aliased_places", "https://www.googleapis.com/auth/dataportability.maps.commute_routes", "https://www.googleapis.com/auth/dataportability.maps.commute_settings", "https://www.googleapis.com/auth/dataportability.maps.ev_profile", + "https://www.googleapis.com/auth/dataportability.maps.factual_contributions", "https://www.googleapis.com/auth/dataportability.maps.offering_contributions", "https://www.googleapis.com/auth/dataportability.maps.photos_videos", + "https://www.googleapis.com/auth/dataportability.maps.post_trip_feedback", + "https://www.googleapis.com/auth/dataportability.maps.questions_answers", "https://www.googleapis.com/auth/dataportability.maps.reviews", "https://www.googleapis.com/auth/dataportability.maps.starred_places", "https://www.googleapis.com/auth/dataportability.myactivity.maps", + "https://www.googleapis.com/auth/dataportability.myactivity.myadcenter", + "https://www.googleapis.com/auth/dataportability.myactivity.play", "https://www.googleapis.com/auth/dataportability.myactivity.search", "https://www.googleapis.com/auth/dataportability.myactivity.shopping", "https://www.googleapis.com/auth/dataportability.myactivity.youtube", + "https://www.googleapis.com/auth/dataportability.mymaps.maps", + "https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations", + "https://www.googleapis.com/auth/dataportability.play.devices", + "https://www.googleapis.com/auth/dataportability.play.grouping", + "https://www.googleapis.com/auth/dataportability.play.installs", + "https://www.googleapis.com/auth/dataportability.play.library", + "https://www.googleapis.com/auth/dataportability.play.playpoints", + "https://www.googleapis.com/auth/dataportability.play.promotions", + "https://www.googleapis.com/auth/dataportability.play.purchases", + "https://www.googleapis.com/auth/dataportability.play.redemptions", + "https://www.googleapis.com/auth/dataportability.play.subscriptions", + "https://www.googleapis.com/auth/dataportability.play.usersettings", "https://www.googleapis.com/auth/dataportability.saved.collections", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.streaming_video_providers", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.thumbs", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.watched", + "https://www.googleapis.com/auth/dataportability.searchnotifications.settings", + "https://www.googleapis.com/auth/dataportability.searchnotifications.subscriptions", "https://www.googleapis.com/auth/dataportability.shopping.addresses", "https://www.googleapis.com/auth/dataportability.shopping.reviews", + "https://www.googleapis.com/auth/dataportability.streetview.imagery", "https://www.googleapis.com/auth/dataportability.youtube.channel", "https://www.googleapis.com/auth/dataportability.youtube.comments", "https://www.googleapis.com/auth/dataportability.youtube.live_chat", @@ -354,6 +499,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/dataportability.alerts.subscriptions", "https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", "https://www.googleapis.com/auth/dataportability.chrome.autofill", "https://www.googleapis.com/auth/dataportability.chrome.bookmarks", @@ -362,20 +508,48 @@ "https://www.googleapis.com/auth/dataportability.chrome.history", "https://www.googleapis.com/auth/dataportability.chrome.reading_list", "https://www.googleapis.com/auth/dataportability.chrome.settings", + "https://www.googleapis.com/auth/dataportability.discover.follows", + "https://www.googleapis.com/auth/dataportability.discover.likes", + "https://www.googleapis.com/auth/dataportability.discover.not_interested", + "https://www.googleapis.com/auth/dataportability.maps.aliased_places", "https://www.googleapis.com/auth/dataportability.maps.commute_routes", "https://www.googleapis.com/auth/dataportability.maps.commute_settings", "https://www.googleapis.com/auth/dataportability.maps.ev_profile", + "https://www.googleapis.com/auth/dataportability.maps.factual_contributions", "https://www.googleapis.com/auth/dataportability.maps.offering_contributions", "https://www.googleapis.com/auth/dataportability.maps.photos_videos", + "https://www.googleapis.com/auth/dataportability.maps.post_trip_feedback", + "https://www.googleapis.com/auth/dataportability.maps.questions_answers", "https://www.googleapis.com/auth/dataportability.maps.reviews", "https://www.googleapis.com/auth/dataportability.maps.starred_places", "https://www.googleapis.com/auth/dataportability.myactivity.maps", + "https://www.googleapis.com/auth/dataportability.myactivity.myadcenter", + "https://www.googleapis.com/auth/dataportability.myactivity.play", "https://www.googleapis.com/auth/dataportability.myactivity.search", "https://www.googleapis.com/auth/dataportability.myactivity.shopping", "https://www.googleapis.com/auth/dataportability.myactivity.youtube", + "https://www.googleapis.com/auth/dataportability.mymaps.maps", + "https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations", + "https://www.googleapis.com/auth/dataportability.play.devices", + "https://www.googleapis.com/auth/dataportability.play.grouping", + "https://www.googleapis.com/auth/dataportability.play.installs", + "https://www.googleapis.com/auth/dataportability.play.library", + "https://www.googleapis.com/auth/dataportability.play.playpoints", + "https://www.googleapis.com/auth/dataportability.play.promotions", + "https://www.googleapis.com/auth/dataportability.play.purchases", + "https://www.googleapis.com/auth/dataportability.play.redemptions", + "https://www.googleapis.com/auth/dataportability.play.subscriptions", + "https://www.googleapis.com/auth/dataportability.play.usersettings", "https://www.googleapis.com/auth/dataportability.saved.collections", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.streaming_video_providers", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.thumbs", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.watched", + "https://www.googleapis.com/auth/dataportability.searchnotifications.settings", + "https://www.googleapis.com/auth/dataportability.searchnotifications.subscriptions", "https://www.googleapis.com/auth/dataportability.shopping.addresses", "https://www.googleapis.com/auth/dataportability.shopping.reviews", + "https://www.googleapis.com/auth/dataportability.streetview.imagery", "https://www.googleapis.com/auth/dataportability.youtube.channel", "https://www.googleapis.com/auth/dataportability.youtube.comments", "https://www.googleapis.com/auth/dataportability.youtube.live_chat", @@ -411,6 +585,7 @@ "$ref": "InitiatePortabilityArchiveResponse" }, "scopes": [ + "https://www.googleapis.com/auth/dataportability.alerts.subscriptions", "https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", "https://www.googleapis.com/auth/dataportability.chrome.autofill", "https://www.googleapis.com/auth/dataportability.chrome.bookmarks", @@ -419,20 +594,48 @@ "https://www.googleapis.com/auth/dataportability.chrome.history", "https://www.googleapis.com/auth/dataportability.chrome.reading_list", "https://www.googleapis.com/auth/dataportability.chrome.settings", + "https://www.googleapis.com/auth/dataportability.discover.follows", + "https://www.googleapis.com/auth/dataportability.discover.likes", + "https://www.googleapis.com/auth/dataportability.discover.not_interested", + "https://www.googleapis.com/auth/dataportability.maps.aliased_places", "https://www.googleapis.com/auth/dataportability.maps.commute_routes", "https://www.googleapis.com/auth/dataportability.maps.commute_settings", "https://www.googleapis.com/auth/dataportability.maps.ev_profile", + "https://www.googleapis.com/auth/dataportability.maps.factual_contributions", "https://www.googleapis.com/auth/dataportability.maps.offering_contributions", "https://www.googleapis.com/auth/dataportability.maps.photos_videos", + "https://www.googleapis.com/auth/dataportability.maps.post_trip_feedback", + "https://www.googleapis.com/auth/dataportability.maps.questions_answers", "https://www.googleapis.com/auth/dataportability.maps.reviews", "https://www.googleapis.com/auth/dataportability.maps.starred_places", "https://www.googleapis.com/auth/dataportability.myactivity.maps", + "https://www.googleapis.com/auth/dataportability.myactivity.myadcenter", + "https://www.googleapis.com/auth/dataportability.myactivity.play", "https://www.googleapis.com/auth/dataportability.myactivity.search", "https://www.googleapis.com/auth/dataportability.myactivity.shopping", "https://www.googleapis.com/auth/dataportability.myactivity.youtube", + "https://www.googleapis.com/auth/dataportability.mymaps.maps", + "https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations", + "https://www.googleapis.com/auth/dataportability.play.devices", + "https://www.googleapis.com/auth/dataportability.play.grouping", + "https://www.googleapis.com/auth/dataportability.play.installs", + "https://www.googleapis.com/auth/dataportability.play.library", + "https://www.googleapis.com/auth/dataportability.play.playpoints", + "https://www.googleapis.com/auth/dataportability.play.promotions", + "https://www.googleapis.com/auth/dataportability.play.purchases", + "https://www.googleapis.com/auth/dataportability.play.redemptions", + "https://www.googleapis.com/auth/dataportability.play.subscriptions", + "https://www.googleapis.com/auth/dataportability.play.usersettings", "https://www.googleapis.com/auth/dataportability.saved.collections", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.streaming_video_providers", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.thumbs", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.watched", + "https://www.googleapis.com/auth/dataportability.searchnotifications.settings", + "https://www.googleapis.com/auth/dataportability.searchnotifications.subscriptions", "https://www.googleapis.com/auth/dataportability.shopping.addresses", "https://www.googleapis.com/auth/dataportability.shopping.reviews", + "https://www.googleapis.com/auth/dataportability.streetview.imagery", "https://www.googleapis.com/auth/dataportability.youtube.channel", "https://www.googleapis.com/auth/dataportability.youtube.comments", "https://www.googleapis.com/auth/dataportability.youtube.live_chat", @@ -452,7 +655,7 @@ } } }, - "revision": "20240312", + "revision": "20240321", "rootUrl": "https://dataportability.googleapis.com/", "schemas": { "Empty": { diff --git a/discovery/dataportability-v1beta.json b/discovery/dataportability-v1beta.json index 8f0b2648f6..21a9430e90 100644 --- a/discovery/dataportability-v1beta.json +++ b/discovery/dataportability-v1beta.json @@ -2,6 +2,9 @@ "auth": { "oauth2": { "scopes": { + "https://www.googleapis.com/auth/dataportability.alerts.subscriptions": { + "description": "Move a copy of the Google Alerts subscriptions you created." + }, "https://www.googleapis.com/auth/dataportability.businessmessaging.conversations": { "description": "Move a copy of messages between you and the businesses you have conversations with across Google services." }, @@ -26,6 +29,18 @@ "https://www.googleapis.com/auth/dataportability.chrome.settings": { "description": "Move a copy of your settings in Chrome." }, + "https://www.googleapis.com/auth/dataportability.discover.follows": { + "description": "Move a copy of searches and sites you follow, saved by Discover." + }, + "https://www.googleapis.com/auth/dataportability.discover.likes": { + "description": "Move a copy of links to your liked documents, saved by Discover." + }, + "https://www.googleapis.com/auth/dataportability.discover.not_interested": { + "description": "Move a copy of content you marked as not interested, saved by Discover." + }, + "https://www.googleapis.com/auth/dataportability.maps.aliased_places": { + "description": "Move a copy of the places you labeled on Maps." + }, "https://www.googleapis.com/auth/dataportability.maps.commute_routes": { "description": "Move a copy of your pinned trips on Maps." }, @@ -35,12 +50,21 @@ "https://www.googleapis.com/auth/dataportability.maps.ev_profile": { "description": "Move a copy of your electric vehicle profile on Maps." }, + "https://www.googleapis.com/auth/dataportability.maps.factual_contributions": { + "description": "Move a copy of the corrections you made to places or map information on Maps." + }, "https://www.googleapis.com/auth/dataportability.maps.offering_contributions": { "description": "Move a copy of your updates to places on Maps." }, "https://www.googleapis.com/auth/dataportability.maps.photos_videos": { "description": "Move a copy of the photos and videos you posted on Maps." }, + "https://www.googleapis.com/auth/dataportability.maps.post_trip_feedback": { + "description": "Move a copy of feedback you gave after completing trips using Maps directions." + }, + "https://www.googleapis.com/auth/dataportability.maps.questions_answers": { + "description": "Move a copy of the questions and answers you posted on Maps." + }, "https://www.googleapis.com/auth/dataportability.maps.reviews": { "description": "Move a copy of your reviews and posts on Maps." }, @@ -50,6 +74,12 @@ "https://www.googleapis.com/auth/dataportability.myactivity.maps": { "description": "Move a copy of your Maps activity." }, + "https://www.googleapis.com/auth/dataportability.myactivity.myadcenter": { + "description": "Move a copy of your My Ad Center activity." + }, + "https://www.googleapis.com/auth/dataportability.myactivity.play": { + "description": "Move a copy of your Google Play activity." + }, "https://www.googleapis.com/auth/dataportability.myactivity.search": { "description": "Move a copy of your Google Search activity." }, @@ -59,15 +89,72 @@ "https://www.googleapis.com/auth/dataportability.myactivity.youtube": { "description": "Move a copy of your YouTube activity." }, + "https://www.googleapis.com/auth/dataportability.mymaps.maps": { + "description": "Move a copy of the maps you created in My Maps." + }, + "https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations": { + "description": "Move a copy of your food purchase and reservation activity." + }, + "https://www.googleapis.com/auth/dataportability.play.devices": { + "description": "Move a copy of information about your devices with Google Play Store installed." + }, + "https://www.googleapis.com/auth/dataportability.play.grouping": { + "description": "Move a copy of your Google Play Store Grouping tags created by app developers." + }, + "https://www.googleapis.com/auth/dataportability.play.installs": { + "description": "Move a copy of your Google Play Store app installations." + }, + "https://www.googleapis.com/auth/dataportability.play.library": { + "description": "Move a copy of your Google Play Store downloads, including books, games, and apps." + }, + "https://www.googleapis.com/auth/dataportability.play.playpoints": { + "description": "Move a copy of information about your Google Play Store Points." + }, + "https://www.googleapis.com/auth/dataportability.play.promotions": { + "description": "Move a copy of information about your Google Play Store promotions." + }, + "https://www.googleapis.com/auth/dataportability.play.purchases": { + "description": "Move a copy of your Google Play Store purchases." + }, + "https://www.googleapis.com/auth/dataportability.play.redemptions": { + "description": "Move a copy of your Google Play Store redemption activities." + }, + "https://www.googleapis.com/auth/dataportability.play.subscriptions": { + "description": "Move a copy of your Google Play Store subscriptions." + }, + "https://www.googleapis.com/auth/dataportability.play.usersettings": { + "description": "Move a copy of your Google Play Store user settings and preferences." + }, "https://www.googleapis.com/auth/dataportability.saved.collections": { "description": "Move a copy of your saved links, images, places, and collections from your use of Google services." }, + "https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars": { + "description": "Move a copy of your media reviews on Google Search." + }, + "https://www.googleapis.com/auth/dataportability.search_ugc.media.streaming_video_providers": { + "description": "Move a copy of your self-reported video streaming provider preferences from Google Search and Google TV." + }, + "https://www.googleapis.com/auth/dataportability.search_ugc.media.thumbs": { + "description": "Move a copy of your indicated thumbs up and thumbs down on media in Google Search and Google TV." + }, + "https://www.googleapis.com/auth/dataportability.search_ugc.media.watched": { + "description": "Move a copy of information about the movies and TV shows you marked as watched on Google Search and Google TV." + }, + "https://www.googleapis.com/auth/dataportability.searchnotifications.settings": { + "description": "Move a copy of your notification settings on the Google Search app." + }, + "https://www.googleapis.com/auth/dataportability.searchnotifications.subscriptions": { + "description": "Move a copy of your notification subscriptions on Google Search app." + }, "https://www.googleapis.com/auth/dataportability.shopping.addresses": { "description": "Move a copy of your shipping information on Shopping." }, "https://www.googleapis.com/auth/dataportability.shopping.reviews": { "description": "Move a copy of reviews you wrote about products or online stores on Google Search." }, + "https://www.googleapis.com/auth/dataportability.streetview.imagery": { + "description": "Move a copy of the images and videos you uploaded to Street View." + }, "https://www.googleapis.com/auth/dataportability.youtube.channel": { "description": "Move a copy of information about your YouTube channel." }, @@ -234,6 +321,7 @@ "$ref": "PortabilityArchiveState" }, "scopes": [ + "https://www.googleapis.com/auth/dataportability.alerts.subscriptions", "https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", "https://www.googleapis.com/auth/dataportability.chrome.autofill", "https://www.googleapis.com/auth/dataportability.chrome.bookmarks", @@ -242,20 +330,48 @@ "https://www.googleapis.com/auth/dataportability.chrome.history", "https://www.googleapis.com/auth/dataportability.chrome.reading_list", "https://www.googleapis.com/auth/dataportability.chrome.settings", + "https://www.googleapis.com/auth/dataportability.discover.follows", + "https://www.googleapis.com/auth/dataportability.discover.likes", + "https://www.googleapis.com/auth/dataportability.discover.not_interested", + "https://www.googleapis.com/auth/dataportability.maps.aliased_places", "https://www.googleapis.com/auth/dataportability.maps.commute_routes", "https://www.googleapis.com/auth/dataportability.maps.commute_settings", "https://www.googleapis.com/auth/dataportability.maps.ev_profile", + "https://www.googleapis.com/auth/dataportability.maps.factual_contributions", "https://www.googleapis.com/auth/dataportability.maps.offering_contributions", "https://www.googleapis.com/auth/dataportability.maps.photos_videos", + "https://www.googleapis.com/auth/dataportability.maps.post_trip_feedback", + "https://www.googleapis.com/auth/dataportability.maps.questions_answers", "https://www.googleapis.com/auth/dataportability.maps.reviews", "https://www.googleapis.com/auth/dataportability.maps.starred_places", "https://www.googleapis.com/auth/dataportability.myactivity.maps", + "https://www.googleapis.com/auth/dataportability.myactivity.myadcenter", + "https://www.googleapis.com/auth/dataportability.myactivity.play", "https://www.googleapis.com/auth/dataportability.myactivity.search", "https://www.googleapis.com/auth/dataportability.myactivity.shopping", "https://www.googleapis.com/auth/dataportability.myactivity.youtube", + "https://www.googleapis.com/auth/dataportability.mymaps.maps", + "https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations", + "https://www.googleapis.com/auth/dataportability.play.devices", + "https://www.googleapis.com/auth/dataportability.play.grouping", + "https://www.googleapis.com/auth/dataportability.play.installs", + "https://www.googleapis.com/auth/dataportability.play.library", + "https://www.googleapis.com/auth/dataportability.play.playpoints", + "https://www.googleapis.com/auth/dataportability.play.promotions", + "https://www.googleapis.com/auth/dataportability.play.purchases", + "https://www.googleapis.com/auth/dataportability.play.redemptions", + "https://www.googleapis.com/auth/dataportability.play.subscriptions", + "https://www.googleapis.com/auth/dataportability.play.usersettings", "https://www.googleapis.com/auth/dataportability.saved.collections", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.streaming_video_providers", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.thumbs", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.watched", + "https://www.googleapis.com/auth/dataportability.searchnotifications.settings", + "https://www.googleapis.com/auth/dataportability.searchnotifications.subscriptions", "https://www.googleapis.com/auth/dataportability.shopping.addresses", "https://www.googleapis.com/auth/dataportability.shopping.reviews", + "https://www.googleapis.com/auth/dataportability.streetview.imagery", "https://www.googleapis.com/auth/dataportability.youtube.channel", "https://www.googleapis.com/auth/dataportability.youtube.comments", "https://www.googleapis.com/auth/dataportability.youtube.live_chat", @@ -297,6 +413,7 @@ "$ref": "RetryPortabilityArchiveResponse" }, "scopes": [ + "https://www.googleapis.com/auth/dataportability.alerts.subscriptions", "https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", "https://www.googleapis.com/auth/dataportability.chrome.autofill", "https://www.googleapis.com/auth/dataportability.chrome.bookmarks", @@ -305,20 +422,48 @@ "https://www.googleapis.com/auth/dataportability.chrome.history", "https://www.googleapis.com/auth/dataportability.chrome.reading_list", "https://www.googleapis.com/auth/dataportability.chrome.settings", + "https://www.googleapis.com/auth/dataportability.discover.follows", + "https://www.googleapis.com/auth/dataportability.discover.likes", + "https://www.googleapis.com/auth/dataportability.discover.not_interested", + "https://www.googleapis.com/auth/dataportability.maps.aliased_places", "https://www.googleapis.com/auth/dataportability.maps.commute_routes", "https://www.googleapis.com/auth/dataportability.maps.commute_settings", "https://www.googleapis.com/auth/dataportability.maps.ev_profile", + "https://www.googleapis.com/auth/dataportability.maps.factual_contributions", "https://www.googleapis.com/auth/dataportability.maps.offering_contributions", "https://www.googleapis.com/auth/dataportability.maps.photos_videos", + "https://www.googleapis.com/auth/dataportability.maps.post_trip_feedback", + "https://www.googleapis.com/auth/dataportability.maps.questions_answers", "https://www.googleapis.com/auth/dataportability.maps.reviews", "https://www.googleapis.com/auth/dataportability.maps.starred_places", "https://www.googleapis.com/auth/dataportability.myactivity.maps", + "https://www.googleapis.com/auth/dataportability.myactivity.myadcenter", + "https://www.googleapis.com/auth/dataportability.myactivity.play", "https://www.googleapis.com/auth/dataportability.myactivity.search", "https://www.googleapis.com/auth/dataportability.myactivity.shopping", "https://www.googleapis.com/auth/dataportability.myactivity.youtube", + "https://www.googleapis.com/auth/dataportability.mymaps.maps", + "https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations", + "https://www.googleapis.com/auth/dataportability.play.devices", + "https://www.googleapis.com/auth/dataportability.play.grouping", + "https://www.googleapis.com/auth/dataportability.play.installs", + "https://www.googleapis.com/auth/dataportability.play.library", + "https://www.googleapis.com/auth/dataportability.play.playpoints", + "https://www.googleapis.com/auth/dataportability.play.promotions", + "https://www.googleapis.com/auth/dataportability.play.purchases", + "https://www.googleapis.com/auth/dataportability.play.redemptions", + "https://www.googleapis.com/auth/dataportability.play.subscriptions", + "https://www.googleapis.com/auth/dataportability.play.usersettings", "https://www.googleapis.com/auth/dataportability.saved.collections", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.streaming_video_providers", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.thumbs", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.watched", + "https://www.googleapis.com/auth/dataportability.searchnotifications.settings", + "https://www.googleapis.com/auth/dataportability.searchnotifications.subscriptions", "https://www.googleapis.com/auth/dataportability.shopping.addresses", "https://www.googleapis.com/auth/dataportability.shopping.reviews", + "https://www.googleapis.com/auth/dataportability.streetview.imagery", "https://www.googleapis.com/auth/dataportability.youtube.channel", "https://www.googleapis.com/auth/dataportability.youtube.comments", "https://www.googleapis.com/auth/dataportability.youtube.live_chat", @@ -354,6 +499,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/dataportability.alerts.subscriptions", "https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", "https://www.googleapis.com/auth/dataportability.chrome.autofill", "https://www.googleapis.com/auth/dataportability.chrome.bookmarks", @@ -362,20 +508,48 @@ "https://www.googleapis.com/auth/dataportability.chrome.history", "https://www.googleapis.com/auth/dataportability.chrome.reading_list", "https://www.googleapis.com/auth/dataportability.chrome.settings", + "https://www.googleapis.com/auth/dataportability.discover.follows", + "https://www.googleapis.com/auth/dataportability.discover.likes", + "https://www.googleapis.com/auth/dataportability.discover.not_interested", + "https://www.googleapis.com/auth/dataportability.maps.aliased_places", "https://www.googleapis.com/auth/dataportability.maps.commute_routes", "https://www.googleapis.com/auth/dataportability.maps.commute_settings", "https://www.googleapis.com/auth/dataportability.maps.ev_profile", + "https://www.googleapis.com/auth/dataportability.maps.factual_contributions", "https://www.googleapis.com/auth/dataportability.maps.offering_contributions", "https://www.googleapis.com/auth/dataportability.maps.photos_videos", + "https://www.googleapis.com/auth/dataportability.maps.post_trip_feedback", + "https://www.googleapis.com/auth/dataportability.maps.questions_answers", "https://www.googleapis.com/auth/dataportability.maps.reviews", "https://www.googleapis.com/auth/dataportability.maps.starred_places", "https://www.googleapis.com/auth/dataportability.myactivity.maps", + "https://www.googleapis.com/auth/dataportability.myactivity.myadcenter", + "https://www.googleapis.com/auth/dataportability.myactivity.play", "https://www.googleapis.com/auth/dataportability.myactivity.search", "https://www.googleapis.com/auth/dataportability.myactivity.shopping", "https://www.googleapis.com/auth/dataportability.myactivity.youtube", + "https://www.googleapis.com/auth/dataportability.mymaps.maps", + "https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations", + "https://www.googleapis.com/auth/dataportability.play.devices", + "https://www.googleapis.com/auth/dataportability.play.grouping", + "https://www.googleapis.com/auth/dataportability.play.installs", + "https://www.googleapis.com/auth/dataportability.play.library", + "https://www.googleapis.com/auth/dataportability.play.playpoints", + "https://www.googleapis.com/auth/dataportability.play.promotions", + "https://www.googleapis.com/auth/dataportability.play.purchases", + "https://www.googleapis.com/auth/dataportability.play.redemptions", + "https://www.googleapis.com/auth/dataportability.play.subscriptions", + "https://www.googleapis.com/auth/dataportability.play.usersettings", "https://www.googleapis.com/auth/dataportability.saved.collections", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.streaming_video_providers", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.thumbs", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.watched", + "https://www.googleapis.com/auth/dataportability.searchnotifications.settings", + "https://www.googleapis.com/auth/dataportability.searchnotifications.subscriptions", "https://www.googleapis.com/auth/dataportability.shopping.addresses", "https://www.googleapis.com/auth/dataportability.shopping.reviews", + "https://www.googleapis.com/auth/dataportability.streetview.imagery", "https://www.googleapis.com/auth/dataportability.youtube.channel", "https://www.googleapis.com/auth/dataportability.youtube.comments", "https://www.googleapis.com/auth/dataportability.youtube.live_chat", @@ -411,6 +585,7 @@ "$ref": "InitiatePortabilityArchiveResponse" }, "scopes": [ + "https://www.googleapis.com/auth/dataportability.alerts.subscriptions", "https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", "https://www.googleapis.com/auth/dataportability.chrome.autofill", "https://www.googleapis.com/auth/dataportability.chrome.bookmarks", @@ -419,20 +594,48 @@ "https://www.googleapis.com/auth/dataportability.chrome.history", "https://www.googleapis.com/auth/dataportability.chrome.reading_list", "https://www.googleapis.com/auth/dataportability.chrome.settings", + "https://www.googleapis.com/auth/dataportability.discover.follows", + "https://www.googleapis.com/auth/dataportability.discover.likes", + "https://www.googleapis.com/auth/dataportability.discover.not_interested", + "https://www.googleapis.com/auth/dataportability.maps.aliased_places", "https://www.googleapis.com/auth/dataportability.maps.commute_routes", "https://www.googleapis.com/auth/dataportability.maps.commute_settings", "https://www.googleapis.com/auth/dataportability.maps.ev_profile", + "https://www.googleapis.com/auth/dataportability.maps.factual_contributions", "https://www.googleapis.com/auth/dataportability.maps.offering_contributions", "https://www.googleapis.com/auth/dataportability.maps.photos_videos", + "https://www.googleapis.com/auth/dataportability.maps.post_trip_feedback", + "https://www.googleapis.com/auth/dataportability.maps.questions_answers", "https://www.googleapis.com/auth/dataportability.maps.reviews", "https://www.googleapis.com/auth/dataportability.maps.starred_places", "https://www.googleapis.com/auth/dataportability.myactivity.maps", + "https://www.googleapis.com/auth/dataportability.myactivity.myadcenter", + "https://www.googleapis.com/auth/dataportability.myactivity.play", "https://www.googleapis.com/auth/dataportability.myactivity.search", "https://www.googleapis.com/auth/dataportability.myactivity.shopping", "https://www.googleapis.com/auth/dataportability.myactivity.youtube", + "https://www.googleapis.com/auth/dataportability.mymaps.maps", + "https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations", + "https://www.googleapis.com/auth/dataportability.play.devices", + "https://www.googleapis.com/auth/dataportability.play.grouping", + "https://www.googleapis.com/auth/dataportability.play.installs", + "https://www.googleapis.com/auth/dataportability.play.library", + "https://www.googleapis.com/auth/dataportability.play.playpoints", + "https://www.googleapis.com/auth/dataportability.play.promotions", + "https://www.googleapis.com/auth/dataportability.play.purchases", + "https://www.googleapis.com/auth/dataportability.play.redemptions", + "https://www.googleapis.com/auth/dataportability.play.subscriptions", + "https://www.googleapis.com/auth/dataportability.play.usersettings", "https://www.googleapis.com/auth/dataportability.saved.collections", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.streaming_video_providers", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.thumbs", + "https://www.googleapis.com/auth/dataportability.search_ugc.media.watched", + "https://www.googleapis.com/auth/dataportability.searchnotifications.settings", + "https://www.googleapis.com/auth/dataportability.searchnotifications.subscriptions", "https://www.googleapis.com/auth/dataportability.shopping.addresses", "https://www.googleapis.com/auth/dataportability.shopping.reviews", + "https://www.googleapis.com/auth/dataportability.streetview.imagery", "https://www.googleapis.com/auth/dataportability.youtube.channel", "https://www.googleapis.com/auth/dataportability.youtube.comments", "https://www.googleapis.com/auth/dataportability.youtube.live_chat", @@ -452,7 +655,7 @@ } } }, - "revision": "20240312", + "revision": "20240321", "rootUrl": "https://dataportability.googleapis.com/", "schemas": { "Empty": { diff --git a/discovery/dataproc-v1.json b/discovery/dataproc-v1.json index de304c9d22..92778a440b 100644 --- a/discovery/dataproc-v1.json +++ b/discovery/dataproc-v1.json @@ -16,11 +16,6 @@ "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/dataproc/", "endpoints": [ - { - "endpointUrl": "https://dataproc.me-central2.rep.googleapis.com/", - "location": "me-central2", - "description": "Regional Endpoint" - }, { "endpointUrl": "https://dataproc.europe-west3.rep.googleapis.com/", "location": "europe-west3", @@ -30,6 +25,11 @@ "endpointUrl": "https://dataproc.europe-west9.rep.googleapis.com/", "location": "europe-west9", "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://dataproc.me-central2.rep.googleapis.com/", + "location": "me-central2", + "description": "Regional Endpoint" } ], "fullyEncodeReservedExpansion": true, @@ -358,6 +358,34 @@ }, "batches": { "methods": { + "analyze": { + "description": "Analyze a Batch for possible recommendations and insights.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}:analyze", + "httpMethod": "POST", + "id": "dataproc.projects.locations.batches.analyze", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The fully qualified name of the batch to analyze in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/batches/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:analyze", + "request": { + "$ref": "AnalyzeBatchRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "create": { "description": "Creates a batch workload that executes asynchronously.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batches", @@ -3044,7 +3072,7 @@ } } }, - "revision": "20240309", + "revision": "20240320", "rootUrl": "https://dataproc.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -3063,6 +3091,17 @@ }, "type": "object" }, + "AnalyzeBatchRequest": { + "description": "A request to analyze a batch workload.", + "id": "AnalyzeBatchRequest", + "properties": { + "requestId": { + "description": "Optional. A unique ID used to identify the request. If the service receives two AnalyzeBatchRequest (http://cloud/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.AnalyzeBatchRequest)s with the same request_id, the second request is ignored and the Operation that corresponds to the first request created and stored in the backend is returned.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", + "type": "string" + } + }, + "type": "object" + }, "AnalyzeOperationMetadata": { "description": "Metadata describing the Analyze operation.", "id": "AnalyzeOperationMetadata", diff --git a/discovery/datastore-v1.json b/discovery/datastore-v1.json index 1e133c16d2..43fc0f800d 100644 --- a/discovery/datastore-v1.json +++ b/discovery/datastore-v1.json @@ -654,7 +654,7 @@ } } }, - "revision": "20240131", + "revision": "20240317", "rootUrl": "https://datastore.googleapis.com/", "schemas": { "Aggregation": { @@ -993,6 +993,62 @@ }, "type": "object" }, + "ExecutionStats": { + "description": "Execution statistics for the query.", + "id": "ExecutionStats", + "properties": { + "debugStats": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Debugging statistics from the execution of the query. Note that the debugging stats are subject to change as Firestore evolves. It could include: { \"indexes_entries_scanned\": \"1000\", \"documents_scanned\": \"20\", \"billing_details\" : { \"documents_billable\": \"20\", \"index_entries_billable\": \"1000\", \"min_query_cost\": \"0\" } }", + "type": "object" + }, + "executionDuration": { + "description": "Total time to execute the query in the backend.", + "format": "google-duration", + "type": "string" + }, + "readOperations": { + "description": "Total billable read operations.", + "format": "int64", + "type": "string" + }, + "resultsReturned": { + "description": "Total number of results returned, including documents, projections, aggregation results, keys.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "ExplainMetrics": { + "description": "Explain metrics for the query.", + "id": "ExplainMetrics", + "properties": { + "executionStats": { + "$ref": "ExecutionStats", + "description": "Aggregated stats from the execution of the query. Only present when ExplainOptions.analyze is set to true." + }, + "planSummary": { + "$ref": "PlanSummary", + "description": "Planning phase information for the query." + } + }, + "type": "object" + }, + "ExplainOptions": { + "description": "Explain options for the query.", + "id": "ExplainOptions", + "properties": { + "analyze": { + "description": "Optional. Whether to execute this query. When false (the default), the query will be planned, returning only metrics from the planning stages. When true, the query will be planned and executed, returning the full query results along with both planning and execution stage metrics.", + "type": "boolean" + } + }, + "type": "object" + }, "Filter": { "description": "A holder for any type of filter.", "id": "Filter", @@ -1823,6 +1879,10 @@ }, "type": "array" }, + "propertyMask": { + "$ref": "PropertyMask", + "description": "The properties to return. Defaults to returning all properties. If this field is set and an entity has a property not referenced in the mask, it will be absent from LookupResponse.found.entity.properties. The entity's key is always returned." + }, "readOptions": { "$ref": "ReadOptions", "description": "The options for this lookup request." @@ -1885,6 +1945,10 @@ "$ref": "Entity", "description": "The entity to insert. The entity must not already exist. The entity key's final path element may be incomplete." }, + "propertyMask": { + "$ref": "PropertyMask", + "description": "The properties to write in this mutation. None of the properties in the mask may have a reserved name, except for `__key__`. This field is ignored for `delete`. If the entity already exists, only properties referenced in the mask are updated, others are left untouched. Properties referenced in the mask but not in the entity are deleted." + }, "update": { "$ref": "Entity", "description": "The entity to update. The entity must already exist. Must have a complete key path." @@ -1970,6 +2034,24 @@ }, "type": "object" }, + "PlanSummary": { + "description": "Planning phase information for the query.", + "id": "PlanSummary", + "properties": { + "indexesUsed": { + "description": "The indexes selected for the query. For example: [ {\"query_scope\": \"Collection\", \"properties\": \"(foo ASC, __name__ ASC)\"}, {\"query_scope\": \"Collection\", \"properties\": \"(bar ASC, __name__ ASC)\"} ]", + "items": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, "Projection": { "description": "A representation of a property in a projection.", "id": "Projection", @@ -2024,6 +2106,20 @@ }, "type": "object" }, + "PropertyMask": { + "description": "The set of arbitrarily nested property paths used to restrict an operation to only a subset of properties in an entity.", + "id": "PropertyMask", + "properties": { + "paths": { + "description": "The paths to the properties covered by this mask. A path is a list of property names separated by dots (`.`), for example `foo.bar` means the property `bar` inside the entity property `foo` inside the entity associated with this path. If a property name contains a dot `.` or a backslash `\\`, then that name must be escaped. A path must not be empty, and may not reference a value inside an array value.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "PropertyOrder": { "description": "The desired order for a specific property.", "id": "PropertyOrder", @@ -2309,6 +2405,10 @@ "description": "The ID of the database against which to make the request. '(default)' is not allowed; please use empty string '' to refer the default database.", "type": "string" }, + "explainOptions": { + "$ref": "ExplainOptions", + "description": "Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned." + }, "gqlQuery": { "$ref": "GqlQuery", "description": "The GQL query to run. This query must be an aggregation query." @@ -2332,6 +2432,10 @@ "$ref": "AggregationResultBatch", "description": "A batch of aggregation results. Always present." }, + "explainMetrics": { + "$ref": "ExplainMetrics", + "description": "Query explain metrics. This is only present when the RunAggregationQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream." + }, "query": { "$ref": "AggregationQuery", "description": "The parsed form of the `GqlQuery` from the request, if it was set." @@ -2352,6 +2456,10 @@ "description": "The ID of the database against which to make the request. '(default)' is not allowed; please use empty string '' to refer the default database.", "type": "string" }, + "explainOptions": { + "$ref": "ExplainOptions", + "description": "Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned." + }, "gqlQuery": { "$ref": "GqlQuery", "description": "The GQL query to run. This query must be a non-aggregation query." @@ -2360,6 +2468,10 @@ "$ref": "PartitionId", "description": "Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID." }, + "propertyMask": { + "$ref": "PropertyMask", + "description": "The properties to return. This field must not be set for a projection query. See LookupRequest.property_mask." + }, "query": { "$ref": "Query", "description": "The query to run." @@ -2379,6 +2491,10 @@ "$ref": "QueryResultBatch", "description": "A batch of query results (always present)." }, + "explainMetrics": { + "$ref": "ExplainMetrics", + "description": "Query explain metrics. This is only present when the RunQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream." + }, "query": { "$ref": "Query", "description": "The parsed form of the `GqlQuery` from the request, if it was set." diff --git a/discovery/datastore-v1beta3.json b/discovery/datastore-v1beta3.json index bfb6da8dae..5f4ade2adb 100644 --- a/discovery/datastore-v1beta3.json +++ b/discovery/datastore-v1beta3.json @@ -336,7 +336,7 @@ } } }, - "revision": "20240131", + "revision": "20240317", "rootUrl": "https://datastore.googleapis.com/", "schemas": { "Aggregation": { @@ -653,6 +653,62 @@ }, "type": "object" }, + "ExecutionStats": { + "description": "Execution statistics for the query.", + "id": "ExecutionStats", + "properties": { + "debugStats": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Debugging statistics from the execution of the query. Note that the debugging stats are subject to change as Firestore evolves. It could include: { \"indexes_entries_scanned\": \"1000\", \"documents_scanned\": \"20\", \"billing_details\" : { \"documents_billable\": \"20\", \"index_entries_billable\": \"1000\", \"min_query_cost\": \"0\" } }", + "type": "object" + }, + "executionDuration": { + "description": "Total time to execute the query in the backend.", + "format": "google-duration", + "type": "string" + }, + "readOperations": { + "description": "Total billable read operations.", + "format": "int64", + "type": "string" + }, + "resultsReturned": { + "description": "Total number of results returned, including documents, projections, aggregation results, keys.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "ExplainMetrics": { + "description": "Explain metrics for the query.", + "id": "ExplainMetrics", + "properties": { + "executionStats": { + "$ref": "ExecutionStats", + "description": "Aggregated stats from the execution of the query. Only present when ExplainOptions.analyze is set to true." + }, + "planSummary": { + "$ref": "PlanSummary", + "description": "Planning phase information for the query." + } + }, + "type": "object" + }, + "ExplainOptions": { + "description": "Explain options for the query.", + "id": "ExplainOptions", + "properties": { + "analyze": { + "description": "Optional. Whether to execute this query. When false (the default), the query will be planned, returning only metrics from the planning stages. When true, the query will be planned and executed, returning the full query results along with both planning and execution stage metrics.", + "type": "boolean" + } + }, + "type": "object" + }, "Filter": { "description": "A holder for any type of filter.", "id": "Filter", @@ -1278,6 +1334,10 @@ }, "type": "array" }, + "propertyMask": { + "$ref": "PropertyMask", + "description": "The properties to return. Defaults to returning all properties. If this field is set and an entity has a property not referenced in the mask, it will be absent from LookupResponse.found.entity.properties. The entity's key is always returned." + }, "readOptions": { "$ref": "ReadOptions", "description": "The options for this lookup request." @@ -1335,6 +1395,10 @@ "$ref": "Entity", "description": "The entity to insert. The entity must not already exist. The entity key's final path element may be incomplete." }, + "propertyMask": { + "$ref": "PropertyMask", + "description": "The properties to write in this mutation. None of the properties in the mask may have a reserved name, except for `__key__`. This field is ignored for `delete`. If the entity already exists, only properties referenced in the mask are updated, others are left untouched. Properties referenced in the mask but not in the entity are deleted." + }, "update": { "$ref": "Entity", "description": "The entity to update. The entity must already exist. Must have a complete key path." @@ -1416,6 +1480,24 @@ }, "type": "object" }, + "PlanSummary": { + "description": "Planning phase information for the query.", + "id": "PlanSummary", + "properties": { + "indexesUsed": { + "description": "The indexes selected for the query. For example: [ {\"query_scope\": \"Collection\", \"properties\": \"(foo ASC, __name__ ASC)\"}, {\"query_scope\": \"Collection\", \"properties\": \"(bar ASC, __name__ ASC)\"} ]", + "items": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, "Projection": { "description": "A representation of a property in a projection.", "id": "Projection", @@ -1470,6 +1552,20 @@ }, "type": "object" }, + "PropertyMask": { + "description": "The set of arbitrarily nested property paths used to restrict an operation to only a subset of properties in an entity.", + "id": "PropertyMask", + "properties": { + "paths": { + "description": "The paths to the properties covered by this mask. A path is a list of property names separated by dots (`.`), for example `foo.bar` means the property `bar` inside the entity property `foo` inside the entity associated with this path. If a property name contains a dot `.` or a backslash `\\`, then that name must be escaped. A path must not be empty, and may not reference a value inside an array value.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "PropertyOrder": { "description": "The desired order for a specific property.", "id": "PropertyOrder", @@ -1743,6 +1839,10 @@ "$ref": "AggregationQuery", "description": "The query to run." }, + "explainOptions": { + "$ref": "ExplainOptions", + "description": "Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned." + }, "gqlQuery": { "$ref": "GqlQuery", "description": "The GQL query to run. This query must be an aggregation query." @@ -1766,6 +1866,10 @@ "$ref": "AggregationResultBatch", "description": "A batch of aggregation results. Always present." }, + "explainMetrics": { + "$ref": "ExplainMetrics", + "description": "Query explain metrics. This is only present when the RunAggregationQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream." + }, "query": { "$ref": "AggregationQuery", "description": "The parsed form of the `GqlQuery` from the request, if it was set." @@ -1777,6 +1881,10 @@ "description": "The request for Datastore.RunQuery.", "id": "RunQueryRequest", "properties": { + "explainOptions": { + "$ref": "ExplainOptions", + "description": "Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned." + }, "gqlQuery": { "$ref": "GqlQuery", "description": "The GQL query to run. This query must be a non-aggregation query." @@ -1785,6 +1893,10 @@ "$ref": "PartitionId", "description": "Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID." }, + "propertyMask": { + "$ref": "PropertyMask", + "description": "The properties to return. This field must not be set for a projection query. See LookupRequest.property_mask." + }, "query": { "$ref": "Query", "description": "The query to run." @@ -1804,6 +1916,10 @@ "$ref": "QueryResultBatch", "description": "A batch of query results (always present)." }, + "explainMetrics": { + "$ref": "ExplainMetrics", + "description": "Query explain metrics. This is only present when the RunQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream." + }, "query": { "$ref": "Query", "description": "The parsed form of the `GqlQuery` from the request, if it was set." diff --git a/discovery/discoveryengine-v1alpha.json b/discovery/discoveryengine-v1alpha.json index 4465cbf739..e13cc4e781 100644 --- a/discovery/discoveryengine-v1alpha.json +++ b/discovery/discoveryengine-v1alpha.json @@ -795,6 +795,59 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getProcessedDocument": { + "description": "Gets the parsed layout information for a Document.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}:getProcessedDocument", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.dataStores.branches.documents.getProcessedDocument", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", + "required": true, + "type": "string" + }, + "processedDocumentFormat": { + "description": "What format output should be. If unspecified, defaults to JSON.", + "enum": [ + "PROCESSED_DOCUMENT_FORMAT_UNSPECIFIED", + "JSON" + ], + "enumDescriptions": [ + "Default value.", + "output format will be a JSON string representation of processed document." + ], + "location": "query", + "type": "string" + }, + "processedDocumentType": { + "description": "Required. What type of processing to return.", + "enum": [ + "PROCESSED_DOCUMENT_TYPE_UNSPECIFIED", + "PARSED_DOCUMENT", + "CHUNKED_DOCUMENT" + ], + "enumDescriptions": [ + "Default value.", + "Available for all data store parsing configs.", + "Only available if ChunkingConfig is enabeld on the data store." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}:getProcessedDocument", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaProcessedDocument" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "import": { "description": "Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:import", @@ -3563,6 +3616,59 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getProcessedDocument": { + "description": "Gets the parsed layout information for a Document.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}:getProcessedDocument", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.dataStores.branches.documents.getProcessedDocument", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", + "required": true, + "type": "string" + }, + "processedDocumentFormat": { + "description": "What format output should be. If unspecified, defaults to JSON.", + "enum": [ + "PROCESSED_DOCUMENT_FORMAT_UNSPECIFIED", + "JSON" + ], + "enumDescriptions": [ + "Default value.", + "output format will be a JSON string representation of processed document." + ], + "location": "query", + "type": "string" + }, + "processedDocumentType": { + "description": "Required. What type of processing to return.", + "enum": [ + "PROCESSED_DOCUMENT_TYPE_UNSPECIFIED", + "PARSED_DOCUMENT", + "CHUNKED_DOCUMENT" + ], + "enumDescriptions": [ + "Default value.", + "Available for all data store parsing configs.", + "Only available if ChunkingConfig is enabeld on the data store." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}:getProcessedDocument", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaProcessedDocument" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "import": { "description": "Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:import", @@ -5080,7 +5186,7 @@ } } }, - "revision": "20240312", + "revision": "20240318", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -8349,6 +8455,21 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaProcessedDocument": { + "description": "Document captures all raw metadata information of items to be recommended or searched.", + "id": "GoogleCloudDiscoveryengineV1alphaProcessedDocument", + "properties": { + "document": { + "description": "Required. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.", + "type": "string" + }, + "jsonData": { + "description": "The JSON string representation of the processed document.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata": { "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata", @@ -8984,7 +9105,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec", "properties": { "boost": { - "description": "Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.", + "description": "Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.", "format": "float", "type": "number" }, @@ -9113,6 +9234,10 @@ "description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results can be used to generate a summary.", "format": "int32", "type": "integer" + }, + "useSemanticChunks": { + "description": "If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Please note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.", + "type": "boolean" } }, "type": "object" diff --git a/discovery/discoveryengine-v1beta.json b/discovery/discoveryengine-v1beta.json index 0312dd2048..8da2bd5c1c 100644 --- a/discovery/discoveryengine-v1beta.json +++ b/discovery/discoveryengine-v1beta.json @@ -4477,7 +4477,7 @@ } } }, - "revision": "20240312", + "revision": "20240318", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -9068,7 +9068,7 @@ "id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec", "properties": { "boost": { - "description": "Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.", + "description": "Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.", "format": "float", "type": "number" }, @@ -9183,6 +9183,10 @@ "description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results can be used to generate a summary.", "format": "int32", "type": "integer" + }, + "useSemanticChunks": { + "description": "If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Please note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.", + "type": "boolean" } }, "type": "object" diff --git a/discovery/displayvideo-v2.json b/discovery/displayvideo-v2.json index 02ec3fd8ba..d70284ae6e 100644 --- a/discovery/displayvideo-v2.json +++ b/discovery/displayvideo-v2.json @@ -9200,7 +9200,7 @@ "parameterOrder": [], "parameters": { "filter": { - "description": "Allows filtering by user fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `budget.budget_segments.date_range.end_date` field must use the `LESS THAN (<)` operator. * The `displayName and `email` field must use the `HAS (:)` operator. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `assignedUserRole.advertiserId` * `assignedUserRole.entityType` * This is synthetic field of `AssignedUserRole` used for filtering. Identifies the type of entity to which the user role is assigned. Valid values are `Partner` and `Advertiser`. * `assignedUserRole.parentPartnerId` * This is a synthetic field of `AssignedUserRole` used for filtering. Identifies the parent partner of the entity to which the user role is assigned. * `assignedUserRole.partnerId` * `assignedUserRole.userRole` * `displayName` * `email` Examples: * The user with `displayName` containing \"foo\": `displayName:\"foo\"` * The user with `email` containing \"bar\": `email:\"bar\"` * All users with standard user roles: `assignedUserRole.userRole=\"STANDARD\"` * All users with user roles for partner 123: `assignedUserRole.partnerId=\"123\"` * All users with user roles for advertiser 123: `assignedUserRole.advertiserId=\"123\"` * All users with partner level user roles: `entityType=\"PARTNER\"` * All users with user roles for partner 123 and advertisers under partner 123: `parentPartnerId=\"123\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "description": "Allows filtering by user fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `displayName` and `email` fields must use the `HAS (:)` operator. * The `lastLoginTime` field must use either the `LESS THAN OR EQUAL TO (<=)` or `GREATER THAN OR EQUAL TO (>=)` operator. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `assignedUserRole.advertiserId` * `assignedUserRole.entityType`: This is synthetic field of `AssignedUserRole` used for filtering. Identifies the type of entity to which the user role is assigned. Valid values are `Partner` and `Advertiser`. * `assignedUserRole.parentPartnerId`: This is a synthetic field of `AssignedUserRole` used for filtering. Identifies the parent partner of the entity to which the user role is assigned. * `assignedUserRole.partnerId` * `assignedUserRole.userRole` * `displayName` * `email` * `lastLoginTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * The user with `displayName` containing \"foo\": `displayName:\"foo\"` * The user with `email` containing \"bar\": `email:\"bar\"` * All users with standard user roles: `assignedUserRole.userRole=\"STANDARD\"` * All users with user roles for partner 123: `assignedUserRole.partnerId=\"123\"` * All users with user roles for advertiser 123: `assignedUserRole.advertiserId=\"123\"` * All users with partner level user roles: `entityType=\"PARTNER\"` * All users with user roles for partner 123 and advertisers under partner 123: `parentPartnerId=\"123\"` * All users that last logged in on or after 2023-01-01T00:00:00Z (format of ISO 8601): `lastLoginTime>=\"2023-01-01T00:00:00Z\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", "location": "query", "type": "string" }, @@ -9267,7 +9267,7 @@ } } }, - "revision": "20240307", + "revision": "20240314", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { @@ -9773,7 +9773,9 @@ "APP_PLATFORM_XBOX", "APP_PLATFORM_SAMSUNG_TV", "APP_PLATFORM_ANDROID_TV", - "APP_PLATFORM_GENERIC_CTV" + "APP_PLATFORM_GENERIC_CTV", + "APP_PLATFORM_LG_TV", + "APP_PLATFORM_VIZIO_TV" ], "enumDescriptions": [ "Default value when app platform is not specified in this version. This enum is a placeholder for default value and does not represent a real platform option.", @@ -9786,7 +9788,9 @@ "The app platform is Xbox.", "The app platform is Samsung TV.", "The app platform is Android TV.", - "The app platform is a CTV platform that is not explicitly listed elsewhere." + "The app platform is a CTV platform that is not explicitly listed elsewhere.", + "The app platform is LG TV.", + "The app platform is VIZIO TV." ], "type": "string" }, @@ -21407,6 +21411,7 @@ "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM", "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA", "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM", + "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM", "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MAXIMIZE_LIFT", "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSIONS", "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPV", @@ -21419,6 +21424,7 @@ "A bidding strategy that pays a configurable amount per impression.", "A bidding strategy that automatically optimizes conversions per dollar.", "A bidding strategy that pays a configurable amount per impression.", + "A bidding strategy for YouTube Instant Reserve line items that pays a fixed amount per impression.", "An automated bidding strategy that sets bids to achieve maximum lift.", "A bidding strategy that automatically maximizes number of conversions given a daily budget.", "A bidding strategy that automatically optimizes cost per video view.", diff --git a/discovery/displayvideo-v3.json b/discovery/displayvideo-v3.json index a75c8fca88..a24609e89c 100644 --- a/discovery/displayvideo-v3.json +++ b/discovery/displayvideo-v3.json @@ -9155,7 +9155,7 @@ "parameterOrder": [], "parameters": { "filter": { - "description": "Allows filtering by user fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `budget.budget_segments.date_range.end_date` field must use the `LESS THAN (<)` operator. * The `displayName and `email` field must use the `HAS (:)` operator. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `assignedUserRole.advertiserId` * `assignedUserRole.entityType` * This is synthetic field of `AssignedUserRole` used for filtering. Identifies the type of entity to which the user role is assigned. Valid values are `Partner` and `Advertiser`. * `assignedUserRole.parentPartnerId` * This is a synthetic field of `AssignedUserRole` used for filtering. Identifies the parent partner of the entity to which the user role is assigned. * `assignedUserRole.partnerId` * `assignedUserRole.userRole` * `displayName` * `email` Examples: * The user with `displayName` containing \"foo\": `displayName:\"foo\"` * The user with `email` containing \"bar\": `email:\"bar\"` * All users with standard user roles: `assignedUserRole.userRole=\"STANDARD\"` * All users with user roles for partner 123: `assignedUserRole.partnerId=\"123\"` * All users with user roles for advertiser 123: `assignedUserRole.advertiserId=\"123\"` * All users with partner level user roles: `entityType=\"PARTNER\"` * All users with user roles for partner 123 and advertisers under partner 123: `parentPartnerId=\"123\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "description": "Allows filtering by user fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `displayName` and `email` fields must use the `HAS (:)` operator. * The `lastLoginTime` field must use either the `LESS THAN OR EQUAL TO (<=)` or `GREATER THAN OR EQUAL TO (>=)` operator. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `assignedUserRole.advertiserId` * `assignedUserRole.entityType`: This is synthetic field of `AssignedUserRole` used for filtering. Identifies the type of entity to which the user role is assigned. Valid values are `Partner` and `Advertiser`. * `assignedUserRole.parentPartnerId`: This is a synthetic field of `AssignedUserRole` used for filtering. Identifies the parent partner of the entity to which the user role is assigned. * `assignedUserRole.partnerId` * `assignedUserRole.userRole` * `displayName` * `email` * `lastLoginTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * The user with `displayName` containing \"foo\": `displayName:\"foo\"` * The user with `email` containing \"bar\": `email:\"bar\"` * All users with standard user roles: `assignedUserRole.userRole=\"STANDARD\"` * All users with user roles for partner 123: `assignedUserRole.partnerId=\"123\"` * All users with user roles for advertiser 123: `assignedUserRole.advertiserId=\"123\"` * All users with partner level user roles: `entityType=\"PARTNER\"` * All users with user roles for partner 123 and advertisers under partner 123: `parentPartnerId=\"123\"` * All users that last logged in on or after 2023-01-01T00:00:00Z (format of ISO 8601): `lastLoginTime>=\"2023-01-01T00:00:00Z\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", "location": "query", "type": "string" }, @@ -9222,7 +9222,7 @@ } } }, - "revision": "20240307", + "revision": "20240314", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -10340,7 +10340,9 @@ "APP_PLATFORM_XBOX", "APP_PLATFORM_SAMSUNG_TV", "APP_PLATFORM_ANDROID_TV", - "APP_PLATFORM_GENERIC_CTV" + "APP_PLATFORM_GENERIC_CTV", + "APP_PLATFORM_LG_TV", + "APP_PLATFORM_VIZIO_TV" ], "enumDescriptions": [ "Default value when app platform is not specified in this version. This enum is a placeholder for default value and does not represent a real platform option.", @@ -10353,7 +10355,9 @@ "The app platform is Xbox.", "The app platform is Samsung TV.", "The app platform is Android TV.", - "The app platform is a CTV platform that is not explicitly listed elsewhere." + "The app platform is a CTV platform that is not explicitly listed elsewhere.", + "The app platform is LG TV.", + "The app platform is VIZIO TV." ], "type": "string" }, @@ -21943,6 +21947,7 @@ "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM", "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA", "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM", + "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM", "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MAXIMIZE_LIFT", "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSIONS", "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPV", @@ -21955,6 +21960,7 @@ "A bidding strategy that pays a configurable amount per impression.", "A bidding strategy that automatically optimizes conversions per dollar.", "A bidding strategy that pays a configurable amount per impression.", + "A bidding strategy for YouTube Instant Reserve line items that pays a fixed amount per impression.", "An automated bidding strategy that sets bids to achieve maximum lift.", "A bidding strategy that automatically maximizes number of conversions given a daily budget.", "A bidding strategy that automatically optimizes cost per video view.", diff --git a/discovery/dlp-v2.json b/discovery/dlp-v2.json index 81c495ebb9..e711c5eb3b 100644 --- a/discovery/dlp-v2.json +++ b/discovery/dlp-v2.json @@ -537,7 +537,7 @@ ] }, "list": { - "description": "Lists data profiles for an organization.", + "description": "Lists column data profiles for an organization.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/columnDataProfiles", "httpMethod": "GET", "id": "dlp.organizations.locations.columnDataProfiles.list", @@ -567,7 +567,7 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or projects/project-id/locations/asia.", + "description": "Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -1321,7 +1321,7 @@ ] }, "list": { - "description": "Lists data profiles for an organization.", + "description": "Lists project data profiles for an organization.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/projectDataProfiles", "httpMethod": "GET", "id": "dlp.organizations.locations.projectDataProfiles.list", @@ -1330,12 +1330,12 @@ ], "parameters": { "filter": { - "description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values: - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * project_id = 12345 AND status_code = 1 * project_id = 12345 AND sensitivity_level = HIGH The length of this field should be no more than 500 characters.", + "description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values: - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id` * `sensitivity_level desc` Supported fields are: - `project_id`: GCP project ID - `sensitivity_level`: How sensitive the data in a project is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds.", + "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id` * `sensitivity_level desc` Supported fields are: - `project_id`: Google Cloud project ID - `sensitivity_level`: How sensitive the data in a project is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds.", "location": "query", "type": "string" }, @@ -1552,7 +1552,7 @@ ] }, "list": { - "description": "Lists data profiles for an organization.", + "description": "Lists table data profiles for an organization.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/tableDataProfiles", "httpMethod": "GET", "id": "dlp.organizations.locations.tableDataProfiles.list", @@ -1561,12 +1561,12 @@ ], "parameters": { "filter": { - "description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values: - `project_id` - The GCP project ID. - `dataset_id` - The BigQuery dataset ID. - `table_id` - The ID of the BigQuery table. - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * project_id = 12345 AND status_code = 1 * project_id = 12345 AND sensitivity_level = HIGH * project_id = 12345 AND resource_visibility = PUBLIC The length of this field should be no more than 500 characters.", + "description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `dataset_id` - The BigQuery dataset ID. - `table_id` - The ID of the BigQuery table. - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The GCP project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `row_count`: Number of rows in this resource.", + "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `row_count`: Number of rows in this resource.", "location": "query", "type": "string" }, @@ -2603,7 +2603,7 @@ ] }, "list": { - "description": "Lists data profiles for an organization.", + "description": "Lists column data profiles for an organization.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/columnDataProfiles", "httpMethod": "GET", "id": "dlp.projects.locations.columnDataProfiles.list", @@ -2633,7 +2633,7 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or projects/project-id/locations/asia.", + "description": "Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3725,7 +3725,7 @@ ] }, "list": { - "description": "Lists data profiles for an organization.", + "description": "Lists project data profiles for an organization.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/projectDataProfiles", "httpMethod": "GET", "id": "dlp.projects.locations.projectDataProfiles.list", @@ -3734,12 +3734,12 @@ ], "parameters": { "filter": { - "description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values: - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * project_id = 12345 AND status_code = 1 * project_id = 12345 AND sensitivity_level = HIGH The length of this field should be no more than 500 characters.", + "description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values: - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id` * `sensitivity_level desc` Supported fields are: - `project_id`: GCP project ID - `sensitivity_level`: How sensitive the data in a project is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds.", + "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id` * `sensitivity_level desc` Supported fields are: - `project_id`: Google Cloud project ID - `sensitivity_level`: How sensitive the data in a project is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds.", "location": "query", "type": "string" }, @@ -3956,7 +3956,7 @@ ] }, "list": { - "description": "Lists data profiles for an organization.", + "description": "Lists table data profiles for an organization.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/tableDataProfiles", "httpMethod": "GET", "id": "dlp.projects.locations.tableDataProfiles.list", @@ -3965,12 +3965,12 @@ ], "parameters": { "filter": { - "description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values: - `project_id` - The GCP project ID. - `dataset_id` - The BigQuery dataset ID. - `table_id` - The ID of the BigQuery table. - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * project_id = 12345 AND status_code = 1 * project_id = 12345 AND sensitivity_level = HIGH * project_id = 12345 AND resource_visibility = PUBLIC The length of this field should be no more than 500 characters.", + "description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `dataset_id` - The BigQuery dataset ID. - `table_id` - The ID of the BigQuery table. - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The GCP project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `row_count`: Number of rows in this resource.", + "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `row_count`: Number of rows in this resource.", "location": "query", "type": "string" }, @@ -4164,7 +4164,7 @@ } } }, - "revision": "20240303", + "revision": "20240317", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -4901,7 +4901,11 @@ "TYPE_NUMERIC", "TYPE_RECORD", "TYPE_BIGNUMERIC", - "TYPE_JSON" + "TYPE_JSON", + "TYPE_INTERVAL", + "TYPE_RANGE_DATE", + "TYPE_RANGE_DATETIME", + "TYPE_RANGE_TIMESTAMP" ], "enumDescriptions": [ "Invalid type.", @@ -4918,7 +4922,11 @@ "Encoded as a decimal string.", "Container of ordered fields, each with a type and field name.", "Decimal type.", - "Json type." + "Json type.", + "Interval type.", + "Range type.", + "Range type.", + "Range type." ], "type": "string" }, diff --git a/discovery/documentai-v1.json b/discovery/documentai-v1.json index b88b1d35b1..22bd5f66d4 100644 --- a/discovery/documentai-v1.json +++ b/discovery/documentai-v1.json @@ -1042,7 +1042,7 @@ } } }, - "revision": "20240223", + "revision": "20240314", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { @@ -4646,6 +4646,10 @@ "$ref": "GoogleCloudDocumentaiV1DocumentSchema", "description": "Optional. The schema the processor version will be trained with." }, + "foundationModelTuningOptions": { + "$ref": "GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions", + "description": "Options to control foundation model tuning of a processor." + }, "inputData": { "$ref": "GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData", "description": "Optional. The input data used to train the ProcessorVersion." @@ -4678,6 +4682,23 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions": { + "description": "Options to control foundation model tuning of the processor.", + "id": "GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions", + "properties": { + "learningRateMultiplier": { + "description": "Optional. The multiplier to apply to the recommended learning rate. Valid values are between 0.1 and 10. If not provided, recommended learning rate will be used.", + "format": "float", + "type": "number" + }, + "trainSteps": { + "description": "Optional. The number of steps to run for model tuning. Valid values are between 1 and 400. If not provided, recommended steps will be used.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData": { "description": "The input data used to train a new ProcessorVersion.", "id": "GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData", diff --git a/discovery/documentai-v1beta3.json b/discovery/documentai-v1beta3.json index 786928ef83..3b844ec7f5 100644 --- a/discovery/documentai-v1beta3.json +++ b/discovery/documentai-v1beta3.json @@ -1284,7 +1284,7 @@ } } }, - "revision": "20240223", + "revision": "20240314", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { @@ -7862,7 +7862,7 @@ "description": "The source processor version to import from. It can be from a different environment and region than the destination processor." }, "processorVersionSource": { - "description": "The source processor version to import from. The source processor version and destination processor need to be in the same environment and region.", + "description": "The source processor version to import from. The source processor version and destination processor need to be in the same environment and region. Note that ProcessorVersions with `model_type` `MODEL_TYPE_LLM` are not supported.", "type": "string" } }, diff --git a/discovery/file-v1.json b/discovery/file-v1.json index d119f9e308..ca58cba199 100644 --- a/discovery/file-v1.json +++ b/discovery/file-v1.json @@ -874,7 +874,7 @@ } } }, - "revision": "20240304", + "revision": "20240307", "rootUrl": "https://file.googleapis.com/", "schemas": { "Backup": { @@ -1643,7 +1643,7 @@ "type": "object" }, "MaintenancePolicy": { - "description": "LINT.IfChange Defines policies to service maintenance events.", + "description": "Defines policies to service maintenance events.", "id": "MaintenancePolicy", "properties": { "createTime": { diff --git a/discovery/firebasehosting-v1.json b/discovery/firebasehosting-v1.json index 69dbeee9ae..793d66d82a 100644 --- a/discovery/firebasehosting-v1.json +++ b/discovery/firebasehosting-v1.json @@ -269,7 +269,7 @@ } } }, - "revision": "20230920", + "revision": "20240320", "rootUrl": "https://firebasehosting.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -379,7 +379,7 @@ }, "quickSetupUpdates": { "$ref": "DnsUpdates", - "description": "A set of DNS record updates that allow Hosting to serve secure content on your domain name. The record type determines the update's purpose: - `A` and `AAAA`: Updates your domain name's IP addresses so that they direct traffic to Hosting servers. - `TXT`: Updates ownership permissions on your domain name, letting Hosting know that your custom domain's project has permission to perfrom actions for that domain name. - `CAA`: Updates your domain name's list of authorized Certificate Authorities (CAs). Only present if you have existing `CAA` records that prohibit Hosting's CA from minting certs for your domain name. These updates include all DNS changes you'll need to get started with Hosting, but, if made all at once, can result in a brief period of downtime for your domain name--while Hosting creates and uploads an SSL cert, for example. If you'd like to add your domain name to Hosting without downtime, complete the `liveMigrationSteps` first, before making the remaining updates in this field." + "description": "A set of DNS record updates that allow Hosting to serve secure content on your domain name. The record type determines the update's purpose: - `A` and `AAAA`: Updates your domain name's IP addresses so that they direct traffic to Hosting servers. - `TXT`: Updates ownership permissions on your domain name, letting Hosting know that your custom domain's project has permission to perform actions for that domain name. - `CAA`: Updates your domain name's list of authorized Certificate Authorities (CAs). Only present if you have existing `CAA` records that prohibit Hosting's CA from minting certs for your domain name. These updates include all DNS changes you'll need to get started with Hosting, but, if made all at once, can result in a brief period of downtime for your domain name--while Hosting creates and uploads an SSL cert, for example. If you'd like to add your domain name to Hosting without downtime, complete the `liveMigrationSteps` first, before making the remaining updates in this field." } }, "type": "object" diff --git a/discovery/firebasehosting-v1beta1.json b/discovery/firebasehosting-v1beta1.json index 7b57749432..841bd99db6 100644 --- a/discovery/firebasehosting-v1beta1.json +++ b/discovery/firebasehosting-v1beta1.json @@ -2422,7 +2422,7 @@ } } }, - "revision": "20230920", + "revision": "20240320", "rootUrl": "https://firebasehosting.googleapis.com/", "schemas": { "ActingUser": { @@ -2885,7 +2885,7 @@ }, "quickSetupUpdates": { "$ref": "DnsUpdates", - "description": "A set of DNS record updates that allow Hosting to serve secure content on your domain name. The record type determines the update's purpose: - `A` and `AAAA`: Updates your domain name's IP addresses so that they direct traffic to Hosting servers. - `TXT`: Updates ownership permissions on your domain name, letting Hosting know that your custom domain's project has permission to perfrom actions for that domain name. - `CAA`: Updates your domain name's list of authorized Certificate Authorities (CAs). Only present if you have existing `CAA` records that prohibit Hosting's CA from minting certs for your domain name. These updates include all DNS changes you'll need to get started with Hosting, but, if made all at once, can result in a brief period of downtime for your domain name--while Hosting creates and uploads an SSL cert, for example. If you'd like to add your domain name to Hosting without downtime, complete the `liveMigrationSteps` first, before making the remaining updates in this field." + "description": "A set of DNS record updates that allow Hosting to serve secure content on your domain name. The record type determines the update's purpose: - `A` and `AAAA`: Updates your domain name's IP addresses so that they direct traffic to Hosting servers. - `TXT`: Updates ownership permissions on your domain name, letting Hosting know that your custom domain's project has permission to perform actions for that domain name. - `CAA`: Updates your domain name's list of authorized Certificate Authorities (CAs). Only present if you have existing `CAA` records that prohibit Hosting's CA from minting certs for your domain name. These updates include all DNS changes you'll need to get started with Hosting, but, if made all at once, can result in a brief period of downtime for your domain name--while Hosting creates and uploads an SSL cert, for example. If you'd like to add your domain name to Hosting without downtime, complete the `liveMigrationSteps` first, before making the remaining updates in this field." } }, "type": "object" diff --git a/discovery/firestore-v1.json b/discovery/firestore-v1.json index bf56fb39f7..996f78f214 100644 --- a/discovery/firestore-v1.json +++ b/discovery/firestore-v1.json @@ -394,7 +394,7 @@ ], "parameters": { "name": { - "description": "Required. The name of backup schedule. Format `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}`", + "description": "Required. The name of the backup schedule. Format `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}`", "location": "path", "pattern": "^projects/[^/]+/databases/[^/]+/backupSchedules/[^/]+$", "required": true, @@ -1672,7 +1672,7 @@ } } }, - "revision": "20240307", + "revision": "20240317", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -2158,6 +2158,36 @@ "properties": {}, "type": "object" }, + "ExecutionStats": { + "description": "Execution statistics for the query.", + "id": "ExecutionStats", + "properties": { + "debugStats": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Debugging statistics from the execution of the query. Note that the debugging stats are subject to change as Firestore evolves. It could include: { \"indexes_entries_scanned\": \"1000\", \"documents_scanned\": \"20\", \"billing_details\" : { \"documents_billable\": \"20\", \"index_entries_billable\": \"1000\", \"min_query_cost\": \"0\" } }", + "type": "object" + }, + "executionDuration": { + "description": "Total time to execute the query in the backend.", + "format": "google-duration", + "type": "string" + }, + "readOperations": { + "description": "Total billable read operations.", + "format": "int64", + "type": "string" + }, + "resultsReturned": { + "description": "Total number of results returned, including documents, projections, aggregation results, keys.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "ExistenceFilter": { "description": "A digest of all the documents that match a given target.", "id": "ExistenceFilter", @@ -2179,6 +2209,32 @@ }, "type": "object" }, + "ExplainMetrics": { + "description": "Explain metrics for the query.", + "id": "ExplainMetrics", + "properties": { + "executionStats": { + "$ref": "ExecutionStats", + "description": "Aggregated stats from the execution of the query. Only present when ExplainOptions.analyze is set to true." + }, + "planSummary": { + "$ref": "PlanSummary", + "description": "Planning phase information for the query." + } + }, + "type": "object" + }, + "ExplainOptions": { + "description": "Explain options for the query.", + "id": "ExplainOptions", + "properties": { + "analyze": { + "description": "Optional. Whether to execute this query. When false (the default), the query will be planned, returning only metrics from the planning stages. When true, the query will be planned and executed, returning the full query results along with both planning and execution stage metrics.", + "type": "boolean" + } + }, + "type": "object" + }, "FieldFilter": { "description": "A filter on a specific field.", "id": "FieldFilter", @@ -2416,7 +2472,7 @@ "type": "object" }, "GoogleFirestoreAdminV1DailyRecurrence": { - "description": "Represent a recurring schedule that runs at a specific time every day. The time zone is UTC.", + "description": "Represents a recurring schedule that runs at a specific time every day. The time zone is UTC.", "id": "GoogleFirestoreAdminV1DailyRecurrence", "properties": {}, "type": "object" @@ -3705,6 +3761,24 @@ }, "type": "object" }, + "PlanSummary": { + "description": "Planning phase information for the query.", + "id": "PlanSummary", + "properties": { + "indexesUsed": { + "description": "The indexes selected for the query. For example: [ {\"query_scope\": \"Collection\", \"properties\": \"(foo ASC, __name__ ASC)\"}, {\"query_scope\": \"Collection\", \"properties\": \"(bar ASC, __name__ ASC)\"} ]", + "items": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, "Precondition": { "description": "A precondition on a document, used for conditional operations.", "id": "Precondition", @@ -3790,6 +3864,10 @@ "description": "The request for Firestore.RunAggregationQuery.", "id": "RunAggregationQueryRequest", "properties": { + "explainOptions": { + "$ref": "ExplainOptions", + "description": "Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned." + }, "newTransaction": { "$ref": "TransactionOptions", "description": "Starts a new transaction as part of the query, defaulting to read-only. The new transaction ID will be returned as the first response in the stream." @@ -3815,6 +3893,10 @@ "description": "The response for Firestore.RunAggregationQuery.", "id": "RunAggregationQueryResponse", "properties": { + "explainMetrics": { + "$ref": "ExplainMetrics", + "description": "Query explain metrics. This is only present when the RunAggregationQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream." + }, "readTime": { "description": "The time at which the aggregate result was computed. This is always monotonically increasing; in this case, the previous AggregationResult in the result stream are guaranteed not to have changed between their `read_time` and this one. If the query returns no results, a response with `read_time` and no `result` will be sent, and this represents the time at which the query was run.", "format": "google-datetime", @@ -3836,6 +3918,10 @@ "description": "The request for Firestore.RunQuery.", "id": "RunQueryRequest", "properties": { + "explainOptions": { + "$ref": "ExplainOptions", + "description": "Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned." + }, "newTransaction": { "$ref": "TransactionOptions", "description": "Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream." @@ -3869,6 +3955,10 @@ "description": "If present, Firestore has completely finished the request and no more documents will be returned.", "type": "boolean" }, + "explainMetrics": { + "$ref": "ExplainMetrics", + "description": "Query explain metrics. This is only present when the RunQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream." + }, "readTime": { "description": "The time at which the document was read. This may be monotonically increasing; in this case, the previous documents in the result stream are guaranteed not to have changed between their `read_time` and this one. If the query returns no results, a response with `read_time` and no `document` will be sent, and this represents the time at which the query was run.", "format": "google-datetime", diff --git a/discovery/firestore-v1beta1.json b/discovery/firestore-v1beta1.json index 32b90143fe..07c156348a 100644 --- a/discovery/firestore-v1beta1.json +++ b/discovery/firestore-v1beta1.json @@ -950,7 +950,7 @@ } } }, - "revision": "20240131", + "revision": "20240317", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -1436,6 +1436,36 @@ "properties": {}, "type": "object" }, + "ExecutionStats": { + "description": "Execution statistics for the query.", + "id": "ExecutionStats", + "properties": { + "debugStats": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Debugging statistics from the execution of the query. Note that the debugging stats are subject to change as Firestore evolves. It could include: { \"indexes_entries_scanned\": \"1000\", \"documents_scanned\": \"20\", \"billing_details\" : { \"documents_billable\": \"20\", \"index_entries_billable\": \"1000\", \"min_query_cost\": \"0\" } }", + "type": "object" + }, + "executionDuration": { + "description": "Total time to execute the query in the backend.", + "format": "google-duration", + "type": "string" + }, + "readOperations": { + "description": "Total billable read operations.", + "format": "int64", + "type": "string" + }, + "resultsReturned": { + "description": "Total number of results returned, including documents, projections, aggregation results, keys.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "ExistenceFilter": { "description": "A digest of all the documents that match a given target.", "id": "ExistenceFilter", @@ -1457,6 +1487,32 @@ }, "type": "object" }, + "ExplainMetrics": { + "description": "Explain metrics for the query.", + "id": "ExplainMetrics", + "properties": { + "executionStats": { + "$ref": "ExecutionStats", + "description": "Aggregated stats from the execution of the query. Only present when ExplainOptions.analyze is set to true." + }, + "planSummary": { + "$ref": "PlanSummary", + "description": "Planning phase information for the query." + } + }, + "type": "object" + }, + "ExplainOptions": { + "description": "Explain options for the query.", + "id": "ExplainOptions", + "properties": { + "analyze": { + "description": "Optional. Whether to execute this query. When false (the default), the query will be planned, returning only metrics from the planning stages. When true, the query will be planned and executed, returning the full query results along with both planning and execution stage metrics.", + "type": "boolean" + } + }, + "type": "object" + }, "FieldFilter": { "description": "A filter on a specific field.", "id": "FieldFilter", @@ -2223,6 +2279,24 @@ }, "type": "object" }, + "PlanSummary": { + "description": "Planning phase information for the query.", + "id": "PlanSummary", + "properties": { + "indexesUsed": { + "description": "The indexes selected for the query. For example: [ {\"query_scope\": \"Collection\", \"properties\": \"(foo ASC, __name__ ASC)\"}, {\"query_scope\": \"Collection\", \"properties\": \"(bar ASC, __name__ ASC)\"} ]", + "items": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, "Precondition": { "description": "A precondition on a document, used for conditional operations.", "id": "Precondition", @@ -2308,6 +2382,10 @@ "description": "The request for Firestore.RunAggregationQuery.", "id": "RunAggregationQueryRequest", "properties": { + "explainOptions": { + "$ref": "ExplainOptions", + "description": "Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned." + }, "newTransaction": { "$ref": "TransactionOptions", "description": "Starts a new transaction as part of the query, defaulting to read-only. The new transaction ID will be returned as the first response in the stream." @@ -2333,6 +2411,10 @@ "description": "The response for Firestore.RunAggregationQuery.", "id": "RunAggregationQueryResponse", "properties": { + "explainMetrics": { + "$ref": "ExplainMetrics", + "description": "Query explain metrics. This is only present when the RunAggregationQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream." + }, "readTime": { "description": "The time at which the aggregate result was computed. This is always monotonically increasing; in this case, the previous AggregationResult in the result stream are guaranteed not to have changed between their `read_time` and this one. If the query returns no results, a response with `read_time` and no `result` will be sent, and this represents the time at which the query was run.", "format": "google-datetime", @@ -2354,6 +2436,10 @@ "description": "The request for Firestore.RunQuery.", "id": "RunQueryRequest", "properties": { + "explainOptions": { + "$ref": "ExplainOptions", + "description": "Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned." + }, "newTransaction": { "$ref": "TransactionOptions", "description": "Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream." @@ -2387,6 +2473,10 @@ "description": "If present, Firestore has completely finished the request and no more documents will be returned.", "type": "boolean" }, + "explainMetrics": { + "$ref": "ExplainMetrics", + "description": "Query explain metrics. This is only present when the RunQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream." + }, "readTime": { "description": "The time at which the document was read. This may be monotonically increasing; in this case, the previous documents in the result stream are guaranteed not to have changed between their `read_time` and this one. If the query returns no results, a response with `read_time` and no `document` will be sent, and this represents the time at which the query was run.", "format": "google-datetime", diff --git a/discovery/gkebackup-v1.json b/discovery/gkebackup-v1.json index a8b3f66435..831dbadc1c 100644 --- a/discovery/gkebackup-v1.json +++ b/discovery/gkebackup-v1.json @@ -1688,7 +1688,7 @@ } } }, - "revision": "20240207", + "revision": "20240313", "rootUrl": "https://gkebackup.googleapis.com/", "schemas": { "AuditConfig": { @@ -1740,7 +1740,7 @@ "type": "object" }, "Backup": { - "description": "Represents a request to perform a single point-in-time capture of some portion of the state of a GKE cluster, the record of the backup operation itself, and an anchor for the underlying artifacts that comprise the Backup (the config backup and VolumeBackups). Next id: 29", + "description": "Represents a request to perform a single point-in-time capture of some portion of the state of a GKE cluster, the record of the backup operation itself, and an anchor for the underlying artifacts that comprise the Backup (the config backup and VolumeBackups).", "id": "Backup", "properties": { "allNamespaces": { @@ -2590,7 +2590,7 @@ "type": "object" }, "Restore": { - "description": "Represents both a request to Restore some portion of a Backup into a target GKE cluster and a record of the restore operation itself. Next id: 20", + "description": "Represents both a request to Restore some portion of a Backup into a target GKE cluster and a record of the restore operation itself.", "id": "Restore", "properties": { "backup": { @@ -2705,7 +2705,7 @@ "type": "object" }, "RestoreConfig": { - "description": "Configuration of a restore. Next id: 14", + "description": "Configuration of a restore.", "id": "RestoreConfig", "properties": { "allNamespaces": { @@ -2794,7 +2794,7 @@ "type": "object" }, "RestorePlan": { - "description": "The configuration of a potential series of Restore operations to be performed against Backups belong to a particular BackupPlan. Next id: 13", + "description": "The configuration of a potential series of Restore operations to be performed against Backups belong to a particular BackupPlan.", "id": "RestorePlan", "properties": { "backupPlan": { @@ -3051,7 +3051,7 @@ "type": "object" }, "VolumeBackup": { - "description": "Represents the backup of a specific persistent volume as a component of a Backup - both the record of the operation and a pointer to the underlying storage-specific artifacts. Next id: 14", + "description": "Represents the backup of a specific persistent volume as a component of a Backup - both the record of the operation and a pointer to the underlying storage-specific artifacts.", "id": "VolumeBackup", "properties": { "completeTime": { @@ -3154,7 +3154,7 @@ "type": "object" }, "VolumeRestore": { - "description": "Represents the operation of restoring a volume from a VolumeBackup. Next id: 13", + "description": "Represents the operation of restoring a volume from a VolumeBackup.", "id": "VolumeRestore", "properties": { "completeTime": { diff --git a/discovery/gkehub-v1.json b/discovery/gkehub-v1.json index e45638368c..b899574f71 100644 --- a/discovery/gkehub-v1.json +++ b/discovery/gkehub-v1.json @@ -1421,6 +1421,83 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "listMemberships": { + "description": "Lists Memberships bound to a Scope. The response includes relevant Memberships from all regions.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}:listMemberships", + "httpMethod": "GET", + "id": "gkehub.projects.locations.scopes.listMemberships", + "parameterOrder": [ + "scopeName" + ], + "parameters": { + "filter": { + "description": "Optional. Lists Memberships that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Currently, filtering can be done only based on Memberships's `name`, `labels`, `create_time`, `update_time`, and `unique_id`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. When requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned. Pagination is currently not supported; therefore, setting this field does not have any impact for now.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Token returned by previous call to `ListBoundMemberships` which specifies the position in the list from where to continue listing the resources.", + "location": "query", + "type": "string" + }, + "scopeName": { + "description": "Required. Name of the Scope, in the format `projects/*/locations/global/scopes/*`, to which the Memberships are bound.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/scopes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+scopeName}:listMemberships", + "response": { + "$ref": "ListBoundMembershipsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "listPermitted": { + "description": "Lists permitted Scopes.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/scopes:listPermitted", + "httpMethod": "GET", + "id": "gkehub.projects.locations.scopes.listPermitted", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. When requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Token returned by previous call to `ListPermittedScopes` which specifies the position in the list from where to continue listing the resources.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent (project and location) where the Scope will be listed. Specified in the format `projects/*/locations/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/scopes:listPermitted", + "response": { + "$ref": "ListPermittedScopesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "patch": { "description": "Updates a scopes.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}", @@ -1834,7 +1911,7 @@ } } }, - "revision": "20240229", + "revision": "20240318", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -3722,6 +3799,10 @@ "$ref": "IdentityServiceGoogleConfig", "description": "GoogleConfig specific configuration." }, + "ldapConfig": { + "$ref": "IdentityServiceLdapConfig", + "description": "LDAP specific configuration." + }, "name": { "description": "Identifier for auth config.", "type": "string" @@ -3789,6 +3870,48 @@ }, "type": "object" }, + "IdentityServiceGroupConfig": { + "description": "Contains the properties for locating and authenticating groups in the directory.", + "id": "IdentityServiceGroupConfig", + "properties": { + "baseDn": { + "description": "Required. The location of the subtree in the LDAP directory to search for group entries.", + "type": "string" + }, + "filter": { + "description": "Optional. Optional filter to be used when searching for groups a user belongs to. This can be used to explicitly match only certain groups in order to reduce the amount of groups returned for each user. This defaults to \"(objectClass=Group)\".", + "type": "string" + }, + "idAttribute": { + "description": "Optional. The identifying name of each group a user belongs to. For example, if this is set to \"distinguishedName\" then RBACs and other group expectations should be written as full DNs. This defaults to \"distinguishedName\".", + "type": "string" + } + }, + "type": "object" + }, + "IdentityServiceLdapConfig": { + "description": "Configuration for the LDAP Auth flow.", + "id": "IdentityServiceLdapConfig", + "properties": { + "group": { + "$ref": "IdentityServiceGroupConfig", + "description": "Optional. Contains the properties for locating and authenticating groups in the directory." + }, + "server": { + "$ref": "IdentityServiceServerConfig", + "description": "Required. Server settings for the external LDAP server." + }, + "serviceAccount": { + "$ref": "IdentityServiceServiceAccountConfig", + "description": "Required. Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate." + }, + "user": { + "$ref": "IdentityServiceUserConfig", + "description": "Required. Defines where users exist in the LDAP directory." + } + }, + "type": "object" + }, "IdentityServiceMembershipSpec": { "description": "**Anthos Identity Service**: Configuration for a single Membership.", "id": "IdentityServiceMembershipSpec", @@ -3946,6 +4069,81 @@ }, "type": "object" }, + "IdentityServiceServerConfig": { + "description": "Server settings for the external LDAP server.", + "id": "IdentityServiceServerConfig", + "properties": { + "certificateAuthorityData": { + "description": "Optional. Contains a Base64 encoded, PEM formatted certificate authority certificate for the LDAP server. This must be provided for the \"ldaps\" and \"startTLS\" connections.", + "format": "byte", + "type": "string" + }, + "connectionType": { + "description": "Optional. Defines the connection type to communicate with the LDAP server. If `starttls` or `ldaps` is specified, the certificate_authority_data should not be empty.", + "type": "string" + }, + "host": { + "description": "Required. Defines the hostname or IP of the LDAP server. Port is optional and will default to 389, if unspecified. For example, \"ldap.server.example\" or \"10.10.10.10:389\".", + "type": "string" + } + }, + "type": "object" + }, + "IdentityServiceServiceAccountConfig": { + "description": "Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate.", + "id": "IdentityServiceServiceAccountConfig", + "properties": { + "simpleBindCredentials": { + "$ref": "IdentityServiceSimpleBindCredentials", + "description": "Credentials for basic auth." + } + }, + "type": "object" + }, + "IdentityServiceSimpleBindCredentials": { + "description": "The structure holds the LDAP simple binding credential.", + "id": "IdentityServiceSimpleBindCredentials", + "properties": { + "dn": { + "description": "Required. The distinguished name(DN) of the service account object/user.", + "type": "string" + }, + "encryptedPassword": { + "description": "Output only. The encrypted password of the service account object/user.", + "format": "byte", + "readOnly": true, + "type": "string" + }, + "password": { + "description": "Required. Input only. The password of the service account object/user.", + "type": "string" + } + }, + "type": "object" + }, + "IdentityServiceUserConfig": { + "description": "Defines where users exist in the LDAP directory.", + "id": "IdentityServiceUserConfig", + "properties": { + "baseDn": { + "description": "Required. The location of the subtree in the LDAP directory to search for user entries.", + "type": "string" + }, + "filter": { + "description": "Optional. Filter to apply when searching for the user. This can be used to further restrict the user accounts which are allowed to login. This defaults to \"(objectClass=User)\".", + "type": "string" + }, + "idAttribute": { + "description": "Optional. Determines which attribute to use as the user's identity after they are authenticated. This is distinct from the loginAttribute field to allow users to login with a username, but then have their actual identifier be an email address or full Distinguished Name (DN). For example, setting loginAttribute to \"sAMAccountName\" and identifierAttribute to \"userPrincipalName\" would allow a user to login as \"bsmith\", but actual RBAC policies for the user would be written as \"bsmith@example.com\". Using \"userPrincipalName\" is recommended since this will be unique for each user. This defaults to \"userPrincipalName\".", + "type": "string" + }, + "loginAttribute": { + "description": "Optional. The name of the attribute which matches against the input username. This is used to find the user in the LDAP database e.g. \"(=)\" and is combined with the optional filter field. This defaults to \"userPrincipalName\".", + "type": "string" + } + }, + "type": "object" + }, "KubernetesMetadata": { "description": "KubernetesMetadata provides informational metadata for Memberships representing Kubernetes clusters.", "id": "KubernetesMetadata", @@ -4018,6 +4216,31 @@ }, "type": "object" }, + "ListBoundMembershipsResponse": { + "description": "List of Memberships bound to a Scope.", + "id": "ListBoundMembershipsResponse", + "properties": { + "memberships": { + "description": "The list of Memberships bound to the given Scope.", + "items": { + "$ref": "Membership" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to request the next page of resources from the `ListBoundMemberships` method. The value of an empty string means that there are no more resources to return.", + "type": "string" + }, + "unreachable": { + "description": "List of locations that could not be reached while fetching this list.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ListFeaturesResponse": { "description": "Response message for the `GkeHub.ListFeatures` method.", "id": "ListFeaturesResponse", @@ -4133,6 +4356,24 @@ }, "type": "object" }, + "ListPermittedScopesResponse": { + "description": "List of permitted Scopes.", + "id": "ListPermittedScopesResponse", + "properties": { + "nextPageToken": { + "description": "A token to request the next page of resources from the `ListPermittedScopes` method. The value of an empty string means that there are no more resources to return.", + "type": "string" + }, + "scopes": { + "description": "The list of permitted Scopes", + "items": { + "$ref": "Scope" + }, + "type": "array" + } + }, + "type": "object" + }, "ListScopeNamespacesResponse": { "description": "List of fleet namespaces.", "id": "ListScopeNamespacesResponse", diff --git a/discovery/gkehub-v1alpha.json b/discovery/gkehub-v1alpha.json index 9fa12eb471..bab2d7b5f7 100644 --- a/discovery/gkehub-v1alpha.json +++ b/discovery/gkehub-v1alpha.json @@ -2175,7 +2175,7 @@ } } }, - "revision": "20240229", + "revision": "20240318", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosObservabilityFeatureSpec": { @@ -4313,6 +4313,10 @@ "$ref": "IdentityServiceGoogleConfig", "description": "GoogleConfig specific configuration." }, + "ldapConfig": { + "$ref": "IdentityServiceLdapConfig", + "description": "LDAP specific configuration." + }, "name": { "description": "Identifier for auth config.", "type": "string" @@ -4380,6 +4384,48 @@ }, "type": "object" }, + "IdentityServiceGroupConfig": { + "description": "Contains the properties for locating and authenticating groups in the directory.", + "id": "IdentityServiceGroupConfig", + "properties": { + "baseDn": { + "description": "Required. The location of the subtree in the LDAP directory to search for group entries.", + "type": "string" + }, + "filter": { + "description": "Optional. Optional filter to be used when searching for groups a user belongs to. This can be used to explicitly match only certain groups in order to reduce the amount of groups returned for each user. This defaults to \"(objectClass=Group)\".", + "type": "string" + }, + "idAttribute": { + "description": "Optional. The identifying name of each group a user belongs to. For example, if this is set to \"distinguishedName\" then RBACs and other group expectations should be written as full DNs. This defaults to \"distinguishedName\".", + "type": "string" + } + }, + "type": "object" + }, + "IdentityServiceLdapConfig": { + "description": "Configuration for the LDAP Auth flow.", + "id": "IdentityServiceLdapConfig", + "properties": { + "group": { + "$ref": "IdentityServiceGroupConfig", + "description": "Optional. Contains the properties for locating and authenticating groups in the directory." + }, + "server": { + "$ref": "IdentityServiceServerConfig", + "description": "Required. Server settings for the external LDAP server." + }, + "serviceAccount": { + "$ref": "IdentityServiceServiceAccountConfig", + "description": "Required. Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate." + }, + "user": { + "$ref": "IdentityServiceUserConfig", + "description": "Required. Defines where users exist in the LDAP directory." + } + }, + "type": "object" + }, "IdentityServiceMembershipSpec": { "description": "**Anthos Identity Service**: Configuration for a single Membership.", "id": "IdentityServiceMembershipSpec", @@ -4537,6 +4583,81 @@ }, "type": "object" }, + "IdentityServiceServerConfig": { + "description": "Server settings for the external LDAP server.", + "id": "IdentityServiceServerConfig", + "properties": { + "certificateAuthorityData": { + "description": "Optional. Contains a Base64 encoded, PEM formatted certificate authority certificate for the LDAP server. This must be provided for the \"ldaps\" and \"startTLS\" connections.", + "format": "byte", + "type": "string" + }, + "connectionType": { + "description": "Optional. Defines the connection type to communicate with the LDAP server. If `starttls` or `ldaps` is specified, the certificate_authority_data should not be empty.", + "type": "string" + }, + "host": { + "description": "Required. Defines the hostname or IP of the LDAP server. Port is optional and will default to 389, if unspecified. For example, \"ldap.server.example\" or \"10.10.10.10:389\".", + "type": "string" + } + }, + "type": "object" + }, + "IdentityServiceServiceAccountConfig": { + "description": "Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate.", + "id": "IdentityServiceServiceAccountConfig", + "properties": { + "simpleBindCredentials": { + "$ref": "IdentityServiceSimpleBindCredentials", + "description": "Credentials for basic auth." + } + }, + "type": "object" + }, + "IdentityServiceSimpleBindCredentials": { + "description": "The structure holds the LDAP simple binding credential.", + "id": "IdentityServiceSimpleBindCredentials", + "properties": { + "dn": { + "description": "Required. The distinguished name(DN) of the service account object/user.", + "type": "string" + }, + "encryptedPassword": { + "description": "Output only. The encrypted password of the service account object/user.", + "format": "byte", + "readOnly": true, + "type": "string" + }, + "password": { + "description": "Required. Input only. The password of the service account object/user.", + "type": "string" + } + }, + "type": "object" + }, + "IdentityServiceUserConfig": { + "description": "Defines where users exist in the LDAP directory.", + "id": "IdentityServiceUserConfig", + "properties": { + "baseDn": { + "description": "Required. The location of the subtree in the LDAP directory to search for user entries.", + "type": "string" + }, + "filter": { + "description": "Optional. Filter to apply when searching for the user. This can be used to further restrict the user accounts which are allowed to login. This defaults to \"(objectClass=User)\".", + "type": "string" + }, + "idAttribute": { + "description": "Optional. Determines which attribute to use as the user's identity after they are authenticated. This is distinct from the loginAttribute field to allow users to login with a username, but then have their actual identifier be an email address or full Distinguished Name (DN). For example, setting loginAttribute to \"sAMAccountName\" and identifierAttribute to \"userPrincipalName\" would allow a user to login as \"bsmith\", but actual RBAC policies for the user would be written as \"bsmith@example.com\". Using \"userPrincipalName\" is recommended since this will be unique for each user. This defaults to \"userPrincipalName\".", + "type": "string" + }, + "loginAttribute": { + "description": "Optional. The name of the attribute which matches against the input username. This is used to find the user in the LDAP database e.g. \"(=)\" and is combined with the optional filter field. This defaults to \"userPrincipalName\".", + "type": "string" + } + }, + "type": "object" + }, "KubernetesMetadata": { "description": "KubernetesMetadata provides informational metadata for Memberships representing Kubernetes clusters.", "id": "KubernetesMetadata", diff --git a/discovery/gkehub-v1beta.json b/discovery/gkehub-v1beta.json index f70ab68800..7eec7f60f4 100644 --- a/discovery/gkehub-v1beta.json +++ b/discovery/gkehub-v1beta.json @@ -1611,6 +1611,83 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "listMemberships": { + "description": "Lists Memberships bound to a Scope. The response includes relevant Memberships from all regions.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}:listMemberships", + "httpMethod": "GET", + "id": "gkehub.projects.locations.scopes.listMemberships", + "parameterOrder": [ + "scopeName" + ], + "parameters": { + "filter": { + "description": "Optional. Lists Memberships that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Currently, filtering can be done only based on Memberships's `name`, `labels`, `create_time`, `update_time`, and `unique_id`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. When requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned. Pagination is currently not supported; therefore, setting this field does not have any impact for now.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Token returned by previous call to `ListBoundMemberships` which specifies the position in the list from where to continue listing the resources.", + "location": "query", + "type": "string" + }, + "scopeName": { + "description": "Required. Name of the Scope, in the format `projects/*/locations/global/scopes/*`, to which the Memberships are bound.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/scopes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+scopeName}:listMemberships", + "response": { + "$ref": "ListBoundMembershipsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "listPermitted": { + "description": "Lists permitted Scopes.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/scopes:listPermitted", + "httpMethod": "GET", + "id": "gkehub.projects.locations.scopes.listPermitted", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. When requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Token returned by previous call to `ListPermittedScopes` which specifies the position in the list from where to continue listing the resources.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent (project and location) where the Scope will be listed. Specified in the format `projects/*/locations/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/scopes:listPermitted", + "response": { + "$ref": "ListPermittedScopesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "patch": { "description": "Updates a scopes.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}", @@ -2024,7 +2101,7 @@ } } }, - "revision": "20240307", + "revision": "20240318", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosObservabilityFeatureSpec": { @@ -4017,6 +4094,10 @@ "$ref": "IdentityServiceGoogleConfig", "description": "GoogleConfig specific configuration." }, + "ldapConfig": { + "$ref": "IdentityServiceLdapConfig", + "description": "LDAP specific configuration." + }, "name": { "description": "Identifier for auth config.", "type": "string" @@ -4084,6 +4165,48 @@ }, "type": "object" }, + "IdentityServiceGroupConfig": { + "description": "Contains the properties for locating and authenticating groups in the directory.", + "id": "IdentityServiceGroupConfig", + "properties": { + "baseDn": { + "description": "Required. The location of the subtree in the LDAP directory to search for group entries.", + "type": "string" + }, + "filter": { + "description": "Optional. Optional filter to be used when searching for groups a user belongs to. This can be used to explicitly match only certain groups in order to reduce the amount of groups returned for each user. This defaults to \"(objectClass=Group)\".", + "type": "string" + }, + "idAttribute": { + "description": "Optional. The identifying name of each group a user belongs to. For example, if this is set to \"distinguishedName\" then RBACs and other group expectations should be written as full DNs. This defaults to \"distinguishedName\".", + "type": "string" + } + }, + "type": "object" + }, + "IdentityServiceLdapConfig": { + "description": "Configuration for the LDAP Auth flow.", + "id": "IdentityServiceLdapConfig", + "properties": { + "group": { + "$ref": "IdentityServiceGroupConfig", + "description": "Optional. Contains the properties for locating and authenticating groups in the directory." + }, + "server": { + "$ref": "IdentityServiceServerConfig", + "description": "Required. Server settings for the external LDAP server." + }, + "serviceAccount": { + "$ref": "IdentityServiceServiceAccountConfig", + "description": "Required. Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate." + }, + "user": { + "$ref": "IdentityServiceUserConfig", + "description": "Required. Defines where users exist in the LDAP directory." + } + }, + "type": "object" + }, "IdentityServiceMembershipSpec": { "description": "**Anthos Identity Service**: Configuration for a single Membership.", "id": "IdentityServiceMembershipSpec", @@ -4241,6 +4364,81 @@ }, "type": "object" }, + "IdentityServiceServerConfig": { + "description": "Server settings for the external LDAP server.", + "id": "IdentityServiceServerConfig", + "properties": { + "certificateAuthorityData": { + "description": "Optional. Contains a Base64 encoded, PEM formatted certificate authority certificate for the LDAP server. This must be provided for the \"ldaps\" and \"startTLS\" connections.", + "format": "byte", + "type": "string" + }, + "connectionType": { + "description": "Optional. Defines the connection type to communicate with the LDAP server. If `starttls` or `ldaps` is specified, the certificate_authority_data should not be empty.", + "type": "string" + }, + "host": { + "description": "Required. Defines the hostname or IP of the LDAP server. Port is optional and will default to 389, if unspecified. For example, \"ldap.server.example\" or \"10.10.10.10:389\".", + "type": "string" + } + }, + "type": "object" + }, + "IdentityServiceServiceAccountConfig": { + "description": "Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate.", + "id": "IdentityServiceServiceAccountConfig", + "properties": { + "simpleBindCredentials": { + "$ref": "IdentityServiceSimpleBindCredentials", + "description": "Credentials for basic auth." + } + }, + "type": "object" + }, + "IdentityServiceSimpleBindCredentials": { + "description": "The structure holds the LDAP simple binding credential.", + "id": "IdentityServiceSimpleBindCredentials", + "properties": { + "dn": { + "description": "Required. The distinguished name(DN) of the service account object/user.", + "type": "string" + }, + "encryptedPassword": { + "description": "Output only. The encrypted password of the service account object/user.", + "format": "byte", + "readOnly": true, + "type": "string" + }, + "password": { + "description": "Required. Input only. The password of the service account object/user.", + "type": "string" + } + }, + "type": "object" + }, + "IdentityServiceUserConfig": { + "description": "Defines where users exist in the LDAP directory.", + "id": "IdentityServiceUserConfig", + "properties": { + "baseDn": { + "description": "Required. The location of the subtree in the LDAP directory to search for user entries.", + "type": "string" + }, + "filter": { + "description": "Optional. Filter to apply when searching for the user. This can be used to further restrict the user accounts which are allowed to login. This defaults to \"(objectClass=User)\".", + "type": "string" + }, + "idAttribute": { + "description": "Optional. Determines which attribute to use as the user's identity after they are authenticated. This is distinct from the loginAttribute field to allow users to login with a username, but then have their actual identifier be an email address or full Distinguished Name (DN). For example, setting loginAttribute to \"sAMAccountName\" and identifierAttribute to \"userPrincipalName\" would allow a user to login as \"bsmith\", but actual RBAC policies for the user would be written as \"bsmith@example.com\". Using \"userPrincipalName\" is recommended since this will be unique for each user. This defaults to \"userPrincipalName\".", + "type": "string" + }, + "loginAttribute": { + "description": "Optional. The name of the attribute which matches against the input username. This is used to find the user in the LDAP database e.g. \"(=)\" and is combined with the optional filter field. This defaults to \"userPrincipalName\".", + "type": "string" + } + }, + "type": "object" + }, "KubernetesMetadata": { "description": "KubernetesMetadata provides informational metadata for Memberships representing Kubernetes clusters.", "id": "KubernetesMetadata", @@ -4313,6 +4511,31 @@ }, "type": "object" }, + "ListBoundMembershipsResponse": { + "description": "List of Memberships bound to a Scope.", + "id": "ListBoundMembershipsResponse", + "properties": { + "memberships": { + "description": "The list of Memberships bound to the given Scope.", + "items": { + "$ref": "Membership" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to request the next page of resources from the `ListBoundMemberships` method. The value of an empty string means that there are no more resources to return.", + "type": "string" + }, + "unreachable": { + "description": "List of locations that could not be reached while fetching this list.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ListFeaturesResponse": { "description": "Response message for the `GkeHub.ListFeatures` method.", "id": "ListFeaturesResponse", @@ -4446,6 +4669,24 @@ }, "type": "object" }, + "ListPermittedScopesResponse": { + "description": "List of permitted Scopes.", + "id": "ListPermittedScopesResponse", + "properties": { + "nextPageToken": { + "description": "A token to request the next page of resources from the `ListPermittedScopes` method. The value of an empty string means that there are no more resources to return.", + "type": "string" + }, + "scopes": { + "description": "The list of permitted Scopes", + "items": { + "$ref": "Scope" + }, + "type": "array" + } + }, + "type": "object" + }, "ListScopeNamespacesResponse": { "description": "List of fleet namespaces.", "id": "ListScopeNamespacesResponse", diff --git a/discovery/healthcare-v1.json b/discovery/healthcare-v1.json index 524330110f..4ca6113eef 100644 --- a/discovery/healthcare-v1.json +++ b/discovery/healthcare-v1.json @@ -4554,7 +4554,7 @@ } } }, - "revision": "20240220", + "revision": "20240312", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "ActivateConsentRequest": { @@ -7135,7 +7135,7 @@ "type": "boolean" }, "inputGcsObject": { - "description": "Optional. GCS object containing list of {resourceType}/{resourceId} lines, identifying resources to be reverted", + "description": "Optional. Cloud Storage object containing list of {resourceType}/{resourceId} lines, identifying resources to be reverted", "type": "string" }, "resultGcsBucket": { diff --git a/discovery/healthcare-v1beta1.json b/discovery/healthcare-v1beta1.json index 7e884dca4a..cf3178dcad 100644 --- a/discovery/healthcare-v1beta1.json +++ b/discovery/healthcare-v1beta1.json @@ -2650,7 +2650,7 @@ ], "parameters": { "resource": { - "description": "Required. The path of the resource to update the blob storage settings in the format of `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}`, `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/`, or `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/instances/{instanceUID}`. If `filter_config` is specified, set the value of `resource` to the resource name of a DICOM store in the format `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}`.", + "description": "Required. The path of the resource to update the blob storage settings in the format of `projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}`, `projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/`, or `projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/instances/{instanceUID}`. If `filter_config` is specified, set the value of `resource` to the resource name of a DICOM store in the format `projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicomStoreID}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+$", "required": true, @@ -2806,7 +2806,7 @@ ], "parameters": { "resource": { - "description": "Required. The path of the resource to update the blob storage settings in the format of `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}`, `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/`, or `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/instances/{instanceUID}`. If `filter_config` is specified, set the value of `resource` to the resource name of a DICOM store in the format `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}`.", + "description": "Required. The path of the resource to update the blob storage settings in the format of `projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}`, `projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/`, or `projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/instances/{instanceUID}`. If `filter_config` is specified, set the value of `resource` to the resource name of a DICOM store in the format `projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicomStoreID}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+/dicomWeb/studies/.*$", "required": true, @@ -2869,7 +2869,7 @@ ], "parameters": { "resource": { - "description": "Required. The path of the resource for which the storage info is requested (for exaxmple for a DICOM Instance: `projects/{projectid}/datasets/{datasetid}/dicomStores/{dicomStoreId}/dicomWeb/studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`)", + "description": "Required. The path of the resource for which the storage info is requested (for exaxmple for a DICOM Instance: `projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicomStoreId}/dicomWeb/studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`)", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+/dicomWeb/studies/[^/]+/series/[^/]+/instances/[^/]+$", "required": true, @@ -5614,7 +5614,7 @@ } } }, - "revision": "20240220", + "revision": "20240312", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -5632,7 +5632,7 @@ "enumDescriptions": [ "No log level specified. This value is unused.", "No additional consent-related logging is added to audit logs.", - "The following information is included: * One of the following [`consentMode`](https://cloud.google.com/healthcare-api/docs/fhir-consent#audit_logs) fields: (`off`|`emptyScope`|`enforced`|`btg`|`bypass`). * The accessor's request headers * The `log_level` of the [AccessDeterminationLogConfig](https://cloud.google.com/healthcare-api/docs/reference/rest/v1beta1/projects.locations.datasets.fhirStores#AccessDeterminationLogConfig) * The final consent evaluation (`PERMIT`, `DENY`, or `NO_CONSENT`) * A human-readable summary of the evaluation", + "The following information is included: * One of the following [`consentMode`](https://cloud.google.com/healthcare-api/docs/fhir-consent#audit_logs) fields: (`off`|`emptyScope`|`enforced`|`btg`|`bypass`). * The accessor's request headers * The `log_level` of the AccessDeterminationLogConfig * The final consent evaluation (`PERMIT`, `DENY`, or `NO_CONSENT`) * A human-readable summary of the evaluation", "Includes `MINIMUM` and, for each resource owner, returns: * The resource owner's name * Most specific part of the `X-Consent-Scope` resulting in consensual determination * Timestamp of the applied enforcement leading to the decision * Enforcement version at the time the applicable consents were applied * The Consent resource name * The timestamp of the Consent resource used for enforcement * Policy type (`PATIENT` or `ADMIN`) Note that this mode adds some overhead to CRUD operations." ], "type": "string" @@ -6400,11 +6400,11 @@ "type": "string" }, "environment": { - "description": "An abstract identifier that describes the environment or conditions under which the accessor is acting. Can be “*” if it applies to all environments.", + "description": "An abstract identifier that describes the environment or conditions under which the accessor is acting. Can be \"*\" if it applies to all environments.", "type": "string" }, "purpose": { - "description": "The intent of data use. Can be “*” if it applies to all purposes.", + "description": "The intent of data use. Can be \"*\" if it applies to all purposes.", "type": "string" } }, @@ -7188,7 +7188,7 @@ "type": "array" }, "consentResource": { - "description": "The resource name of this consent resource. Format: `projects/{projectId}/datasets/{datasetId}/fhirStores/{fhirStoreId}/fhir/{resourceType}/{id}`.", + "description": "The resource name of this consent resource. Format: `projects/{projectId}/locations/{locationId}/datasets/{datasetId}/fhirStores/{fhirStoreId}/fhir/{resourceType}/{id}`.", "type": "string" }, "enforcementTime": { @@ -7225,9 +7225,9 @@ "description": "The consent's variant combinations. A single consent may have multiple variants.", "items": { "enum": [ - "VARIANT_UNSPECIFIED", - "VARIANT_STANDARD", - "VARIANT_CASCADE" + "CONSENT_VARIANT_UNSPECIFIED", + "CONSENT_VARIANT_STANDARD", + "CONSENT_VARIANT_CASCADE" ], "enumDescriptions": [ "Consent variant unspecified.", @@ -9709,7 +9709,7 @@ }, "filterConfig": { "$ref": "DicomFilterConfig", - "description": "Optional. A filter configuration. If `filter_config` is specified, set the value of `resource` to the resource name of a DICOM store in the format `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}`." + "description": "Optional. A filter configuration. If `filter_config` is specified, set the value of `resource` to the resource name of a DICOM store in the format `projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicomStoreID}`." } }, "type": "object" @@ -9799,7 +9799,7 @@ "description": "Info about the data stored in blob storage for the resource." }, "referencedResource": { - "description": "The resource whose storage info is returned. For example, to specify the resource path of a DICOM Instance: `projects/{projectid}/datasets/{datasetid}/dicomStores/{dicom_store_id}/dicomWeb/studi/{study_uid}/series/{series_uid}/instances/{instance_uid}`", + "description": "The resource whose storage info is returned. For example, to specify the resource path of a DICOM Instance: `projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicom_store_id}/dicomWeb/studi/{study_uid}/series/{series_uid}/instances/{instance_uid}`", "type": "string" }, "structuredStorageInfo": { diff --git a/discovery/iam-v1.json b/discovery/iam-v1.json index b41c3fb738..7181107375 100644 --- a/discovery/iam-v1.json +++ b/discovery/iam-v1.json @@ -12,7 +12,7 @@ "baseUrl": "https://iam.googleapis.com/", "batchPath": "batch", "canonicalName": "Iam", - "description": "Manages identity and access control for Google Cloud Platform resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls. ", + "description": "Manages identity and access control for Google Cloud resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls. Enabling this API also enables the IAM Service Account Credentials API (iamcredentials.googleapis.com). However, disabling this API doesn't disable the IAM Service Account Credentials API. ", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/iam/", "fullyEncodeReservedExpansion": true, @@ -2850,7 +2850,7 @@ } } }, - "revision": "20240118", + "revision": "20240314", "rootUrl": "https://iam.googleapis.com/", "schemas": { "AccessRestrictions": { @@ -3916,6 +3916,37 @@ }, "type": "object" }, + "ReconciliationOperationMetadata": { + "description": "Operation metadata returned by the CLH during resource state reconciliation.", + "id": "ReconciliationOperationMetadata", + "properties": { + "deleteResource": { + "deprecated": true, + "description": "DEPRECATED. Use exclusive_action instead.", + "type": "boolean" + }, + "exclusiveAction": { + "description": "Excluisive action returned by the CLH.", + "enum": [ + "UNKNOWN_REPAIR_ACTION", + "DELETE", + "RETRY" + ], + "enumDeprecated": [ + false, + true, + false + ], + "enumDescriptions": [ + "Unknown repair action.", + "The resource has to be deleted. When using this bit, the CLH should fail the operation. DEPRECATED. Instead use DELETE_RESOURCE OperationSignal in SideChannel.", + "This resource could not be repaired but the repair should be tried again at a later time. This can happen if there is a dependency that needs to be resolved first- e.g. if a parent resource must be repaired before a child resource." + ], + "type": "string" + } + }, + "type": "object" + }, "Role": { "description": "A role in the Identity and Access Management API.", "id": "Role", @@ -3941,7 +3972,7 @@ "type": "array" }, "name": { - "description": "The name of the role. When `Role` is used in `CreateRole`, the role name must not be set. When `Role` is used in output and other input such as `UpdateRole`, the role name is the complete path. For example, `roles/logging.viewer` for predefined roles, `organizations/{ORGANIZATION_ID}/roles/my-role` for organization-level custom roles, and `projects/{PROJECT_ID}/roles/my-role` for project-level custom roles.", + "description": "The name of the role. When `Role` is used in `CreateRole`, the role name must not be set. When `Role` is used in output and other input such as `UpdateRole`, the role name is the complete path. For example, `roles/logging.viewer` for predefined roles, `organizations/{ORGANIZATION_ID}/roles/myRole` for organization-level custom roles, and `projects/{PROJECT_ID}/roles/myRole` for project-level custom roles.", "type": "string" }, "stage": { @@ -3976,7 +4007,7 @@ "id": "Saml", "properties": { "idpMetadataXml": { - "description": "Required. SAML Identity provider configuration metadata xml doc. The xml document should comply with [SAML 2.0 specification](https://www.oasis-open.org/committees/download.php/56785/sstc-saml-metadata-errata-2.0-wd-05.pdf). The max size of the acceptable xml document will be bounded to 128k characters. The metadata xml document should satisfy the following constraints: 1) Must contain an Identity Provider Entity ID. 2) Must contain at least one non-expired signing key certificate. 3) For each signing key: a) Valid from should be no more than 7 days from now. b) Valid to should be no more than 15 years in the future. 4) Upto 3 IdP signing keys are allowed in the metadata xml. When updating the provider's metadata xml, at lease one non-expired signing key must overlap with the existing metadata. This requirement is skipped if there are no non-expired signing keys present in the existing metadata", + "description": "Required. SAML identity provider (IdP) configuration metadata XML doc. The XML document must comply with the [SAML 2.0 specification](https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf). The maximum size of an acceptable XML document is 128K characters. The SAML metadata XML document must satisfy the following constraints: * Must contain an IdP Entity ID. * Must contain at least one non-expired signing certificate. * For each signing certificate, the expiration must be: * From no more than 7 days in the future. * To no more than 15 years in the future. * Up to three IdP signing keys are allowed. When updating the provider's metadata XML, at least one non-expired signing key must overlap with the existing metadata. This requirement is skipped if there are no non-expired signing keys present in the existing metadata.", "type": "string" } }, @@ -4417,7 +4448,7 @@ "additionalProperties": { "type": "string" }, - "description": "Required. Maps attributes from the authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.groups`: Groups the authenticating user belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. * `google.display_name`: The name of the authenticated user. This is an optional field and the mapped display name cannot exceed 100 bytes. If not set, `google.subject` will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.profile_photo`: The URL that specifies the authenticated user's thumbnail photo. This is an optional field. When set, the image will be visible as the user's profile picture. If not set, a generic user icon will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.posix_username`: The linux username used by OS login. This is an optional field and the mapped posix username cannot exceed 32 characters, The key must match the regex \"^a-zA-Z0-9._{0,31}$\". This attribute cannot be referenced in IAM bindings. You can also provide custom attributes by specifying `attribute.{custom_attribute}`, where {custom_attribute} is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workforce pool to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 4KB. For OIDC providers, you must supply a custom mapping that includes the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {\"google.subject\": \"assertion.sub\"} ```", + "description": "Required. Maps attributes from the authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.groups`: Groups the authenticating user belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. * `google.display_name`: The name of the authenticated user. This is an optional field and the mapped display name cannot exceed 100 bytes. If not set, `google.subject` will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.profile_photo`: The URL that specifies the authenticated user's thumbnail photo. This is an optional field. When set, the image will be visible as the user's profile picture. If not set, a generic user icon will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.posix_username`: The Linux username used by OS Login. This is an optional field and the mapped POSIX username cannot exceed 32 characters, The key must match the regex \"^a-zA-Z0-9._{0,31}$\". This attribute cannot be referenced in IAM bindings. You can also provide custom attributes by specifying `attribute.{custom_attribute}`, where {custom_attribute} is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workforce pool to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 4KB. For OIDC providers, you must supply a custom mapping that includes the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {\"google.subject\": \"assertion.sub\"} ```", "type": "object" }, "description": { @@ -4633,6 +4664,10 @@ ], "readOnly": true, "type": "string" + }, + "x509": { + "$ref": "X509", + "description": "An X.509-type identity provider." } }, "type": "object" @@ -4685,6 +4720,12 @@ } }, "type": "object" + }, + "X509": { + "description": "An X.509-type identity provider represents a CA. It is trusted to assert a client identity if the client has a certificate that chains up to this CA.", + "id": "X509", + "properties": {}, + "type": "object" } }, "servicePath": "", diff --git a/discovery/iam-v2.json b/discovery/iam-v2.json index 827c40b3db..db0cc7325e 100644 --- a/discovery/iam-v2.json +++ b/discovery/iam-v2.json @@ -12,7 +12,7 @@ "baseUrl": "https://iam.googleapis.com/", "batchPath": "batch", "canonicalName": "Iam", - "description": "Manages identity and access control for Google Cloud Platform resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls. ", + "description": "Manages identity and access control for Google Cloud resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls. Enabling this API also enables the IAM Service Account Credentials API (iamcredentials.googleapis.com). However, disabling this API doesn't disable the IAM Service Account Credentials API. ", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/iam/", "fullyEncodeReservedExpansion": true, @@ -293,9 +293,40 @@ } } }, - "revision": "20240118", + "revision": "20240314", "rootUrl": "https://iam.googleapis.com/", "schemas": { + "CloudControl2SharedOperationsReconciliationOperationMetadata": { + "description": "Operation metadata returned by the CLH during resource state reconciliation.", + "id": "CloudControl2SharedOperationsReconciliationOperationMetadata", + "properties": { + "deleteResource": { + "deprecated": true, + "description": "DEPRECATED. Use exclusive_action instead.", + "type": "boolean" + }, + "exclusiveAction": { + "description": "Excluisive action returned by the CLH.", + "enum": [ + "UNKNOWN_REPAIR_ACTION", + "DELETE", + "RETRY" + ], + "enumDeprecated": [ + false, + true, + false + ], + "enumDescriptions": [ + "Unknown repair action.", + "The resource has to be deleted. When using this bit, the CLH should fail the operation. DEPRECATED. Instead use DELETE_RESOURCE OperationSignal in SideChannel.", + "This resource could not be repaired but the repair should be tried again at a later time. This can happen if there is a dependency that needs to be resolved first- e.g. if a parent resource must be repaired before a child resource." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudCommonOperationMetadata": { "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudCommonOperationMetadata", diff --git a/discovery/iam-v2beta.json b/discovery/iam-v2beta.json index ed0b25a048..11a11f94af 100644 --- a/discovery/iam-v2beta.json +++ b/discovery/iam-v2beta.json @@ -12,7 +12,7 @@ "baseUrl": "https://iam.googleapis.com/", "batchPath": "batch", "canonicalName": "Iam", - "description": "Manages identity and access control for Google Cloud Platform resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls. ", + "description": "Manages identity and access control for Google Cloud resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls. Enabling this API also enables the IAM Service Account Credentials API (iamcredentials.googleapis.com). However, disabling this API doesn't disable the IAM Service Account Credentials API. ", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/iam/", "fullyEncodeReservedExpansion": true, @@ -293,9 +293,40 @@ } } }, - "revision": "20240118", + "revision": "20240314", "rootUrl": "https://iam.googleapis.com/", "schemas": { + "CloudControl2SharedOperationsReconciliationOperationMetadata": { + "description": "Operation metadata returned by the CLH during resource state reconciliation.", + "id": "CloudControl2SharedOperationsReconciliationOperationMetadata", + "properties": { + "deleteResource": { + "deprecated": true, + "description": "DEPRECATED. Use exclusive_action instead.", + "type": "boolean" + }, + "exclusiveAction": { + "description": "Excluisive action returned by the CLH.", + "enum": [ + "UNKNOWN_REPAIR_ACTION", + "DELETE", + "RETRY" + ], + "enumDeprecated": [ + false, + true, + false + ], + "enumDescriptions": [ + "Unknown repair action.", + "The resource has to be deleted. When using this bit, the CLH should fail the operation. DEPRECATED. Instead use DELETE_RESOURCE OperationSignal in SideChannel.", + "This resource could not be repaired but the repair should be tried again at a later time. This can happen if there is a dependency that needs to be resolved first- e.g. if a parent resource must be repaired before a child resource." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudCommonOperationMetadata": { "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudCommonOperationMetadata", diff --git a/discovery/iap-v1.json b/discovery/iap-v1.json index e780e6e023..f596bde0eb 100644 --- a/discovery/iap-v1.json +++ b/discovery/iap-v1.json @@ -650,7 +650,7 @@ ] }, "validateAttributeExpression": { - "description": "Validates a given CEL expression conforms to IAP restrictions.", + "description": "Validates that a given CEL expression conforms to IAP restrictions.", "flatPath": "v1/{v1Id}:validateAttributeExpression", "httpMethod": "POST", "id": "iap.validateAttributeExpression", @@ -659,7 +659,7 @@ ], "parameters": { "expression": { - "description": "Required. User input string expression. Should be of the form 'attributes.saml_attributes.filter(attribute, attribute.name in ['{attribute_name}', '{attribute_name}'])'", + "description": "Required. User input string expression. Should be of the form `attributes.saml_attributes.filter(attribute, attribute.name in ['{attribute_name}', '{attribute_name}'])`", "location": "query", "type": "string" }, @@ -682,7 +682,7 @@ } } }, - "revision": "20240126", + "revision": "20240315", "rootUrl": "https://iap.googleapis.com/", "schemas": { "AccessDeniedPageSettings": { diff --git a/discovery/identitytoolkit-v2.json b/discovery/identitytoolkit-v2.json index 016290c024..49deba438e 100644 --- a/discovery/identitytoolkit-v2.json +++ b/discovery/identitytoolkit-v2.json @@ -1655,7 +1655,7 @@ } } }, - "revision": "20240118", + "revision": "20240313", "rootUrl": "https://identitytoolkit.googleapis.com/", "schemas": { "GoogleCloudIdentitytoolkitAdminV2AllowByDefault": { @@ -2638,11 +2638,10 @@ "type": "array" }, "recaptchaKeys": { - "description": "Output only. The reCAPTCHA keys.", + "description": "The reCAPTCHA keys.", "items": { "$ref": "GoogleCloudIdentitytoolkitAdminV2RecaptchaKey" }, - "readOnly": true, "type": "array" }, "useAccountDefender": { diff --git a/discovery/index.json b/discovery/index.json index 32a2c11bac..c48405cfd0 100644 --- a/discovery/index.json +++ b/discovery/index.json @@ -772,7 +772,7 @@ "name": "batch", "version": "v1", "title": "Batch API", - "description": "An API to manage the running of batch resources on Google Cloud Platform.", + "description": "An API to manage the running of Batch resources on Google Cloud Platform.", "discoveryRestUrl": "https://batch.googleapis.com/$discovery/rest?version=v1", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", @@ -3276,21 +3276,6 @@ "documentationLink": "https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster", "preferred": false }, - { - "kind": "discovery#directoryItem", - "id": "gkehub:v1alpha2", - "name": "gkehub", - "version": "v1alpha2", - "title": "GKE Hub API", - "description": "", - "discoveryRestUrl": "https://gkehub.googleapis.com/$discovery/rest?version=v1alpha2", - "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" - }, - "documentationLink": "https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster", - "preferred": false - }, { "kind": "discovery#directoryItem", "id": "gkehub:v2alpha", @@ -3957,7 +3942,7 @@ "name": "marketingplatformadmin", "version": "v1alpha", "title": "Google Marketing Platform Admin API", - "description": "marketingplatformadmin.googleapis.com API.", + "description": "The Google Marketing Platform Admin API allows for programmatic access to the Google Marketing Platform configuration data. You can use the Google Marketing Platform Admin API to manage links between your Google Marketing Platform organization and Google Analytics accounts, set the service level of your GA4 properties.", "discoveryRestUrl": "https://marketingplatformadmin.googleapis.com/$discovery/rest?version=v1alpha", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", @@ -5839,7 +5824,7 @@ "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, - "documentationLink": "https://developers.google.com/cloud-test-lab/", + "documentationLink": "https://firebase.google.com/docs/test-lab/", "preferred": true }, { diff --git a/discovery/logging-v2.json b/discovery/logging-v2.json index 7fe5e8b152..eb8c924a9c 100644 --- a/discovery/logging-v2.json +++ b/discovery/logging-v2.json @@ -28,6 +28,11 @@ "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/logging/docs/", "endpoints": [ + { + "endpointUrl": "https://logging.me-central2.rep.googleapis.com/", + "location": "me-central2", + "description": "Regional Endpoint" + }, { "endpointUrl": "https://logging.europe-west3.rep.googleapis.com/", "location": "europe-west3", @@ -43,11 +48,6 @@ "location": "europe-west9", "description": "Regional Endpoint" }, - { - "endpointUrl": "https://logging.me-central2.rep.googleapis.com/", - "location": "me-central2", - "description": "Regional Endpoint" - }, { "endpointUrl": "https://logging.us-central1.rep.googleapis.com/", "location": "us-central1", @@ -1542,6 +1542,11 @@ "parent" ], "parameters": { + "filter": { + "description": "Optional. A filter expression to constrain the sinks returned. Today, this only supports the following strings: '' 'in_scope(\"ALL\")', 'in_scope(\"ANCESTOR\")', 'in_scope(\"DEFAULT\")'.Description of scopes below. ALL: Includes all of the sinks which can be returned in any other scope. ANCESTOR: Includes intercepting sinks owned by ancestor resources. DEFAULT: Includes sinks owned by parent.When the empty string is provided, then the filter 'in_scope(\"DEFAULT\")' is applied.", + "location": "query", + "type": "string" + }, "pageSize": { "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", "format": "int32", @@ -3290,6 +3295,11 @@ "parent" ], "parameters": { + "filter": { + "description": "Optional. A filter expression to constrain the sinks returned. Today, this only supports the following strings: '' 'in_scope(\"ALL\")', 'in_scope(\"ANCESTOR\")', 'in_scope(\"DEFAULT\")'.Description of scopes below. ALL: Includes all of the sinks which can be returned in any other scope. ANCESTOR: Includes intercepting sinks owned by ancestor resources. DEFAULT: Includes sinks owned by parent.When the empty string is provided, then the filter 'in_scope(\"DEFAULT\")' is applied.", + "location": "query", + "type": "string" + }, "pageSize": { "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", "format": "int32", @@ -5682,6 +5692,11 @@ "parent" ], "parameters": { + "filter": { + "description": "Optional. A filter expression to constrain the sinks returned. Today, this only supports the following strings: '' 'in_scope(\"ALL\")', 'in_scope(\"ANCESTOR\")', 'in_scope(\"DEFAULT\")'.Description of scopes below. ALL: Includes all of the sinks which can be returned in any other scope. ANCESTOR: Includes intercepting sinks owned by ancestor resources. DEFAULT: Includes sinks owned by parent.When the empty string is provided, then the filter 'in_scope(\"DEFAULT\")' is applied.", + "location": "query", + "type": "string" + }, "pageSize": { "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", "format": "int32", @@ -7307,6 +7322,11 @@ "parent" ], "parameters": { + "filter": { + "description": "Optional. A filter expression to constrain the sinks returned. Today, this only supports the following strings: '' 'in_scope(\"ALL\")', 'in_scope(\"ANCESTOR\")', 'in_scope(\"DEFAULT\")'.Description of scopes below. ALL: Includes all of the sinks which can be returned in any other scope. ANCESTOR: Includes intercepting sinks owned by ancestor resources. DEFAULT: Includes sinks owned by parent.When the empty string is provided, then the filter 'in_scope(\"DEFAULT\")' is applied.", + "location": "query", + "type": "string" + }, "pageSize": { "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", "format": "int32", @@ -7535,6 +7555,11 @@ "parent" ], "parameters": { + "filter": { + "description": "Optional. A filter expression to constrain the sinks returned. Today, this only supports the following strings: '' 'in_scope(\"ALL\")', 'in_scope(\"ANCESTOR\")', 'in_scope(\"DEFAULT\")'.Description of scopes below. ALL: Includes all of the sinks which can be returned in any other scope. ANCESTOR: Includes intercepting sinks owned by ancestor resources. DEFAULT: Includes sinks owned by parent.When the empty string is provided, then the filter 'in_scope(\"DEFAULT\")' is applied.", + "location": "query", + "type": "string" + }, "pageSize": { "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", "format": "int32", @@ -7743,7 +7768,7 @@ } } }, - "revision": "20240301", + "revision": "20240312", "rootUrl": "https://logging.googleapis.com/", "schemas": { "BigQueryDataset": { @@ -9138,6 +9163,10 @@ "description": "Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink's parent resource are available for export. If the field is true, then log entries from all the projects, folders, and billing accounts contained in the sink's parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink's filter expression.For example, if this field is true, then the filter resource.type=gce_instance would export all Compute Engine VM instance log entries from all projects in the sink's parent.To only export entries from certain child projects, filter on the project part of the log name:logName:(\"projects/test-project1/\" OR \"projects/test-project2/\") AND resource.type=gce_instance", "type": "boolean" }, + "interceptChildren": { + "description": "Optional. This field applies only to sinks owned by organizations and folders.When the value of 'intercept_children' is true, the following restrictions apply: The sink must have the include_children flag set to true. The sink destination must be a Cloud project.Also, the following behaviors apply: Any logs matched by the sink won't be included by non-_Required sinks owned by child resources. The sink appears in the results of a ListSinks call from a child resource if the value of the filter field in its request is either 'in_scope(\"ALL\")' or 'in_scope(\"ANCESTOR\")'.", + "type": "boolean" + }, "name": { "description": "Output only. The client-assigned sink identifier, unique within the project.For example: \"my-syslog-errors-to-pubsub\".Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, periods.First character has to be alphanumeric.", "readOnly": true, @@ -9158,6 +9187,11 @@ ], "type": "string" }, + "resourceName": { + "description": "Output only. The resource name of the sink. \"projects/[PROJECT_ID]/sinks/[SINK_NAME] \"organizations/[ORGANIZATION_ID]/sinks/[SINK_NAME] \"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_NAME] \"folders/[FOLDER_ID]/sinks/[SINK_NAME] For example: projects/my_project/sinks/SINK_NAME", + "readOnly": true, + "type": "string" + }, "updateTime": { "description": "Output only. The last update timestamp of the sink.This field may not be present for older sinks.", "format": "google-datetime", diff --git a/discovery/memcache-v1.json b/discovery/memcache-v1.json index c2f8e37838..6d52b8ebca 100644 --- a/discovery/memcache-v1.json +++ b/discovery/memcache-v1.json @@ -584,7 +584,7 @@ } } }, - "revision": "20240104", + "revision": "20240307", "rootUrl": "https://memcache.googleapis.com/", "schemas": { "ApplyParametersRequest": { @@ -1333,7 +1333,7 @@ "type": "object" }, "MaintenancePolicy": { - "description": "LINT.IfChange Defines policies to service maintenance events.", + "description": "Defines policies to service maintenance events.", "id": "MaintenancePolicy", "properties": { "createTime": { diff --git a/discovery/memcache-v1beta2.json b/discovery/memcache-v1beta2.json index fea12ef7f1..3363b676ec 100644 --- a/discovery/memcache-v1beta2.json +++ b/discovery/memcache-v1beta2.json @@ -612,7 +612,7 @@ } } }, - "revision": "20240104", + "revision": "20240307", "rootUrl": "https://memcache.googleapis.com/", "schemas": { "ApplyParametersRequest": { @@ -1384,7 +1384,7 @@ "type": "object" }, "MaintenancePolicy": { - "description": "LINT.IfChange Defines policies to service maintenance events.", + "description": "Defines policies to service maintenance events.", "id": "MaintenancePolicy", "properties": { "createTime": { diff --git a/discovery/metastore-v1.json b/discovery/metastore-v1.json index 296d293a02..248868f475 100644 --- a/discovery/metastore-v1.json +++ b/discovery/metastore-v1.json @@ -1359,40 +1359,6 @@ ] } } - }, - "migrationExecutions": { - "methods": { - "delete": { - "description": "Deletes a single migration execution.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/migrationExecutions/{migrationExecutionsId}", - "httpMethod": "DELETE", - "id": "metastore.projects.locations.services.migrationExecutions.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The relative resource name of the migrationExecution to delete, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/migrationExecutions/{migration_execution_id}.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/migrationExecutions/[^/]+$", - "required": true, - "type": "string" - }, - "requestId": { - "description": "Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } } } } @@ -1401,7 +1367,7 @@ } } }, - "revision": "20240305", + "revision": "20240312", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { diff --git a/discovery/metastore-v1alpha.json b/discovery/metastore-v1alpha.json index ab72e8cbf9..a0afd341f6 100644 --- a/discovery/metastore-v1alpha.json +++ b/discovery/metastore-v1alpha.json @@ -1599,40 +1599,6 @@ ] } } - }, - "migrationExecutions": { - "methods": { - "delete": { - "description": "Deletes a single migration execution.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/migrationExecutions/{migrationExecutionsId}", - "httpMethod": "DELETE", - "id": "metastore.projects.locations.services.migrationExecutions.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The relative resource name of the migrationExecution to delete, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/migrationExecutions/{migration_execution_id}.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/migrationExecutions/[^/]+$", - "required": true, - "type": "string" - }, - "requestId": { - "description": "Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.", - "location": "query", - "type": "string" - } - }, - "path": "v1alpha/{+name}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } } } } @@ -1641,7 +1607,7 @@ } } }, - "revision": "20240305", + "revision": "20240312", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { diff --git a/discovery/metastore-v1beta.json b/discovery/metastore-v1beta.json index 138c467580..4a9a700c57 100644 --- a/discovery/metastore-v1beta.json +++ b/discovery/metastore-v1beta.json @@ -1599,40 +1599,6 @@ ] } } - }, - "migrationExecutions": { - "methods": { - "delete": { - "description": "Deletes a single migration execution.", - "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/migrationExecutions/{migrationExecutionsId}", - "httpMethod": "DELETE", - "id": "metastore.projects.locations.services.migrationExecutions.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The relative resource name of the migrationExecution to delete, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/migrationExecutions/{migration_execution_id}.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/migrationExecutions/[^/]+$", - "required": true, - "type": "string" - }, - "requestId": { - "description": "Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta/{+name}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } } } } @@ -1641,7 +1607,7 @@ } } }, - "revision": "20240305", + "revision": "20240312", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { diff --git a/discovery/networkmanagement-v1.json b/discovery/networkmanagement-v1.json index caf9102392..870a397f81 100644 --- a/discovery/networkmanagement-v1.json +++ b/discovery/networkmanagement-v1.json @@ -591,7 +591,7 @@ } } }, - "revision": "20240228", + "revision": "20240313", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -630,7 +630,9 @@ "GOOGLE_MANAGED_SERVICE_AMBIGUOUS_PSC_ENDPOINT", "SOURCE_PSC_CLOUD_SQL_UNSUPPORTED", "SOURCE_FORWARDING_RULE_UNSUPPORTED", - "NON_ROUTABLE_IP_ADDRESS" + "NON_ROUTABLE_IP_ADDRESS", + "UNKNOWN_ISSUE_IN_GOOGLE_MANAGED_PROJECT", + "UNSUPPORTED_GOOGLE_MANAGED_PROJECT_CONFIG" ], "enumDeprecated": [ false, @@ -662,6 +664,8 @@ false, false, false, + false, + false, false ], "enumDescriptions": [ @@ -694,7 +698,9 @@ "Aborted because a PSC endpoint selection for the Google-managed service is ambiguous (several PSC endpoints satisfy test input).", "Aborted because tests with a PSC-based Cloud SQL instance as a source are not supported.", "Aborted because tests with a forwarding rule as a source are not supported.", - "Aborted because one of the endpoints is a non-routable IP address (loopback, link-local, etc)." + "Aborted because one of the endpoints is a non-routable IP address (loopback, link-local, etc).", + "Aborted due to an unknown issue in the Google-managed project.", + "Aborted due to an unsupported configuration of the Google-managed project." ], "type": "string" }, @@ -930,6 +936,10 @@ "description": "A Connectivity Test for a network reachability analysis.", "id": "ConnectivityTest", "properties": { + "bypassFirewallChecks": { + "description": "Whether the test should skip firewall checking. If not provided, we assume false.", + "type": "boolean" + }, "createTime": { "description": "Output only. The time the test was created.", "format": "google-datetime", @@ -1105,13 +1115,15 @@ "PSC_ENDPOINT_ACCESSED_FROM_PEERED_NETWORK", "PSC_NEG_PRODUCER_ENDPOINT_NO_GLOBAL_ACCESS", "PSC_NEG_PRODUCER_FORWARDING_RULE_MULTIPLE_PORTS", + "CLOUD_SQL_PSC_NEG_UNSUPPORTED", "NO_NAT_SUBNETS_FOR_PSC_SERVICE_ATTACHMENT", "HYBRID_NEG_NON_DYNAMIC_ROUTE_MATCHED", "HYBRID_NEG_NON_LOCAL_DYNAMIC_ROUTE_MATCHED", "CLOUD_RUN_REVISION_NOT_READY", "DROPPED_INSIDE_PSC_SERVICE_PRODUCER", "LOAD_BALANCER_HAS_NO_PROXY_SUBNET", - "CLOUD_NAT_NO_ADDRESSES" + "CLOUD_NAT_NO_ADDRESSES", + "ROUTING_LOOP" ], "enumDescriptions": [ "Cause is unspecified.", @@ -1165,13 +1177,15 @@ "The packet is sent to the Private Service Connect endpoint over the peering, but [it's not supported](https://cloud.google.com/vpc/docs/configure-private-service-connect-services#on-premises).", "The packet is sent to the Private Service Connect backend (network endpoint group), but the producer PSC forwarding rule does not have global access enabled.", "The packet is sent to the Private Service Connect backend (network endpoint group), but the producer PSC forwarding rule has multiple ports specified.", + "The packet is sent to the Private Service Connect backend (network endpoint group) targeting a Cloud SQL service attachment, but this configuration is not supported.", "No NAT subnets are defined for the PSC service attachment.", "The packet sent from the hybrid NEG proxy matches a non-dynamic route, but such a configuration is not supported.", "The packet sent from the hybrid NEG proxy matches a dynamic route with a next hop in a different region, but such a configuration is not supported.", "Packet sent from a Cloud Run revision that is not ready.", "Packet was dropped inside Private Service Connect service producer.", "Packet sent to a load balancer, which requires a proxy-only subnet and the subnet is not found.", - "Packet sent to Cloud Nat without active NAT IPs." + "Packet sent to Cloud Nat without active NAT IPs.", + "Packet is stuck in a routing loop." ], "type": "string" }, diff --git a/discovery/networkmanagement-v1beta1.json b/discovery/networkmanagement-v1beta1.json index b4a4e41268..9e67280c05 100644 --- a/discovery/networkmanagement-v1beta1.json +++ b/discovery/networkmanagement-v1beta1.json @@ -591,7 +591,7 @@ } } }, - "revision": "20240228", + "revision": "20240313", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -630,7 +630,9 @@ "GOOGLE_MANAGED_SERVICE_AMBIGUOUS_PSC_ENDPOINT", "SOURCE_PSC_CLOUD_SQL_UNSUPPORTED", "SOURCE_FORWARDING_RULE_UNSUPPORTED", - "NON_ROUTABLE_IP_ADDRESS" + "NON_ROUTABLE_IP_ADDRESS", + "UNKNOWN_ISSUE_IN_GOOGLE_MANAGED_PROJECT", + "UNSUPPORTED_GOOGLE_MANAGED_PROJECT_CONFIG" ], "enumDeprecated": [ false, @@ -662,6 +664,8 @@ false, false, false, + false, + false, false ], "enumDescriptions": [ @@ -694,7 +698,9 @@ "Aborted because a PSC endpoint selection for the Google-managed service is ambiguous (several PSC endpoints satisfy test input).", "Aborted because tests with a PSC-based Cloud SQL instance as a source are not supported.", "Aborted because tests with a forwarding rule as a source are not supported.", - "Aborted because one of the endpoints is a non-routable IP address (loopback, link-local, etc)." + "Aborted because one of the endpoints is a non-routable IP address (loopback, link-local, etc).", + "Aborted due to an unknown issue in the Google-managed project.", + "Aborted due to an unsupported configuration of the Google-managed project." ], "type": "string" }, @@ -935,6 +941,10 @@ "description": "A Connectivity Test for a network reachability analysis.", "id": "ConnectivityTest", "properties": { + "bypassFirewallChecks": { + "description": "Whether the test should skip firewall checking. If not provided, we assume false.", + "type": "boolean" + }, "createTime": { "description": "Output only. The time the test was created.", "format": "google-datetime", @@ -1110,13 +1120,15 @@ "PSC_ENDPOINT_ACCESSED_FROM_PEERED_NETWORK", "PSC_NEG_PRODUCER_ENDPOINT_NO_GLOBAL_ACCESS", "PSC_NEG_PRODUCER_FORWARDING_RULE_MULTIPLE_PORTS", + "CLOUD_SQL_PSC_NEG_UNSUPPORTED", "NO_NAT_SUBNETS_FOR_PSC_SERVICE_ATTACHMENT", "HYBRID_NEG_NON_DYNAMIC_ROUTE_MATCHED", "HYBRID_NEG_NON_LOCAL_DYNAMIC_ROUTE_MATCHED", "CLOUD_RUN_REVISION_NOT_READY", "DROPPED_INSIDE_PSC_SERVICE_PRODUCER", "LOAD_BALANCER_HAS_NO_PROXY_SUBNET", - "CLOUD_NAT_NO_ADDRESSES" + "CLOUD_NAT_NO_ADDRESSES", + "ROUTING_LOOP" ], "enumDescriptions": [ "Cause is unspecified.", @@ -1170,13 +1182,15 @@ "The packet is sent to the Private Service Connect endpoint over the peering, but [it's not supported](https://cloud.google.com/vpc/docs/configure-private-service-connect-services#on-premises).", "The packet is sent to the Private Service Connect backend (network endpoint group), but the producer PSC forwarding rule does not have global access enabled.", "The packet is sent to the Private Service Connect backend (network endpoint group), but the producer PSC forwarding rule has multiple ports specified.", + "The packet is sent to the Private Service Connect backend (network endpoint group) targeting a Cloud SQL service attachment, but this configuration is not supported.", "No NAT subnets are defined for the PSC service attachment.", "The packet sent from the hybrid NEG proxy matches a non-dynamic route, but such a configuration is not supported.", "The packet sent from the hybrid NEG proxy matches a dynamic route with a next hop in a different region, but such a configuration is not supported.", "Packet sent from a Cloud Run revision that is not ready.", "Packet was dropped inside Private Service Connect service producer.", "Packet sent to a load balancer, which requires a proxy-only subnet and the subnet is not found.", - "Packet sent to Cloud Nat without active NAT IPs." + "Packet sent to Cloud Nat without active NAT IPs.", + "Packet is stuck in a routing loop." ], "type": "string" }, diff --git a/discovery/networkservices-v1.json b/discovery/networkservices-v1.json index 9a3d3c0646..b67e25fcb6 100644 --- a/discovery/networkservices-v1.json +++ b/discovery/networkservices-v1.json @@ -2756,7 +2756,7 @@ } } }, - "revision": "20240224", + "revision": "20240315", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { @@ -3073,7 +3073,7 @@ "id": "ExtensionChainMatchCondition", "properties": { "celExpression": { - "description": "Required. A Common Expression Language (CEL) expression that is used to match requests for which the extension chain is executed. For more information, see [CEL matcher language reference](/service-extensions/docs/cel-matcher-language-reference).", + "description": "Required. A Common Expression Language (CEL) expression that is used to match requests for which the extension chain is executed. For more information, see [CEL matcher language reference](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference).", "type": "string" } }, @@ -4091,7 +4091,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. Set of labels associated with the `LbRouteExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources.", + "description": "Optional. Set of labels associated with the `LbRouteExtension` resource. The format must comply with [the requirements for labels](https://cloud.google.com/compute/docs/labeling-resources#requirements) for Google Cloud resources.", "type": "object" }, "loadBalancingScheme": { @@ -4153,7 +4153,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. Set of labels associated with the `LbTrafficExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources.", + "description": "Optional. Set of labels associated with the `LbTrafficExtension` resource. The format must comply with [the requirements for labels](https://cloud.google.com/compute/docs/labeling-resources#requirements) for Google Cloud resources.", "type": "object" }, "loadBalancingScheme": { diff --git a/discovery/networkservices-v1beta1.json b/discovery/networkservices-v1beta1.json index 14eeb46770..281f30541e 100644 --- a/discovery/networkservices-v1beta1.json +++ b/discovery/networkservices-v1beta1.json @@ -2483,7 +2483,7 @@ } } }, - "revision": "20240228", + "revision": "20240315", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { @@ -2757,7 +2757,7 @@ "id": "ExtensionChainMatchCondition", "properties": { "celExpression": { - "description": "Required. A Common Expression Language (CEL) expression that is used to match requests for which the extension chain is executed. For more information, see [CEL matcher language reference](/service-extensions/docs/cel-matcher-language-reference).", + "description": "Required. A Common Expression Language (CEL) expression that is used to match requests for which the extension chain is executed. For more information, see [CEL matcher language reference](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference).", "type": "string" } }, @@ -3775,7 +3775,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. Set of labels associated with the `LbRouteExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources.", + "description": "Optional. Set of labels associated with the `LbRouteExtension` resource. The format must comply with [the requirements for labels](https://cloud.google.com/compute/docs/labeling-resources#requirements) for Google Cloud resources.", "type": "object" }, "loadBalancingScheme": { @@ -3837,7 +3837,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. Set of labels associated with the `LbTrafficExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources.", + "description": "Optional. Set of labels associated with the `LbTrafficExtension` resource. The format must comply with [the requirements for labels](https://cloud.google.com/compute/docs/labeling-resources#requirements) for Google Cloud resources.", "type": "object" }, "loadBalancingScheme": { diff --git a/discovery/notebooks-v1.json b/discovery/notebooks-v1.json index dd259232e6..fc6c8fc6c9 100644 --- a/discovery/notebooks-v1.json +++ b/discovery/notebooks-v1.json @@ -2008,7 +2008,7 @@ } } }, - "revision": "20231227", + "revision": "20240314", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2031,6 +2031,7 @@ "NVIDIA_TESLA_T4", "NVIDIA_TESLA_A100", "NVIDIA_L4", + "NVIDIA_A100_80GB", "NVIDIA_TESLA_T4_VWS", "NVIDIA_TESLA_P100_VWS", "NVIDIA_TESLA_P4_VWS", @@ -2046,6 +2047,7 @@ "Accelerator type is Nvidia Tesla T4.", "Accelerator type is Nvidia Tesla A100.", "Accelerator type is Nvidia Tesla L4.", + "Accelerator type is Nvidia Tesla A100 80GB.", "Accelerator type is NVIDIA Tesla T4 Virtual Workstations.", "Accelerator type is NVIDIA Tesla P100 Virtual Workstations.", "Accelerator type is NVIDIA Tesla P4 Virtual Workstations.", @@ -2073,7 +2075,7 @@ "type": "array" }, "role": { - "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.", + "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", "type": "string" } }, @@ -2707,7 +2709,7 @@ "additionalProperties": { "type": "string" }, - "description": "Custom metadata to apply to this instance. For example, to specify a Cloud Storage bucket for automatic backup, you can use the `gcs-data-bucket` metadata tag. Format: `\"--metadata=gcs-data-bucket=``BUCKET''\"`.", + "description": "Custom metadata to apply to this instance. For example, to specify a Cloud Storage bucket for automatic backup, you can use the `gcs-data-bucket` metadata tag. Format: `\"--metadata=gcs-data-bucket=BUCKET\"`.", "type": "object" }, "migrated": { @@ -4052,6 +4054,7 @@ "NVIDIA_TESLA_T4", "NVIDIA_TESLA_A100", "NVIDIA_L4", + "NVIDIA_A100_80GB", "NVIDIA_TESLA_T4_VWS", "NVIDIA_TESLA_P100_VWS", "NVIDIA_TESLA_P4_VWS", @@ -4067,6 +4070,7 @@ "Accelerator type is Nvidia Tesla T4.", "Accelerator type is Nvidia Tesla A100.", "Accelerator type is Nvidia Tesla L4.", + "Accelerator type is Nvidia Tesla A100 80GB.", "Accelerator type is NVIDIA Tesla T4 Virtual Workstations.", "Accelerator type is NVIDIA Tesla P100 Virtual Workstations.", "Accelerator type is NVIDIA Tesla P4 Virtual Workstations.", diff --git a/discovery/notebooks-v2.json b/discovery/notebooks-v2.json index b682b714ef..d1b9f7cfcd 100644 --- a/discovery/notebooks-v2.json +++ b/discovery/notebooks-v2.json @@ -876,7 +876,7 @@ } } }, - "revision": "20231227", + "revision": "20240314", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -937,7 +937,7 @@ "type": "array" }, "role": { - "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.", + "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", "type": "string" } }, diff --git a/discovery/osconfig-v1.json b/discovery/osconfig-v1.json index 427f154fbb..7f1ecb1bf0 100644 --- a/discovery/osconfig-v1.json +++ b/discovery/osconfig-v1.json @@ -109,6 +109,69 @@ "resources": { "locations": { "resources": { + "global": { + "methods": { + "getProjectFeatureSettings": { + "description": "GetProjectFeatureSettings returns the feature settings for a project", + "flatPath": "v1/projects/{projectsId}/locations/global/projectFeatureSettings", + "httpMethod": "GET", + "id": "osconfig.projects.locations.global.getProjectFeatureSettings", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the billing config. \"projects//locations/global/projectFeatureSettings\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/global/projectFeatureSettings$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "ProjectFeatureSettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "updateProjectFeatureSettings": { + "description": "UpdateProjectFeatureSettings sets the feature settings for a project.", + "flatPath": "v1/projects/{projectsId}/locations/global/projectFeatureSettings", + "httpMethod": "PATCH", + "id": "osconfig.projects.locations.global.updateProjectFeatureSettings", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Immutable. Name of the config, e.g. projects/12345/locations/global/projectFeatureSettings", + "location": "path", + "pattern": "^projects/[^/]+/locations/global/projectFeatureSettings$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask that controls which fields of the ProjectFeatureSettings should be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "ProjectFeatureSettings" + }, + "response": { + "$ref": "ProjectFeatureSettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "instances": { "resources": { "inventories": { @@ -1000,7 +1063,7 @@ } } }, - "revision": "20240129", + "revision": "20240317", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "AptSettings": { @@ -3293,6 +3356,31 @@ "properties": {}, "type": "object" }, + "ProjectFeatureSettings": { + "description": "ProjectFeatureSettings represents the features settings for the VM Manager. The project features settings can be set for a project.", + "id": "ProjectFeatureSettings", + "properties": { + "name": { + "description": "Required. Immutable. Name of the config, e.g. projects/12345/locations/global/projectFeatureSettings", + "type": "string" + }, + "patchAndConfigFeatureSet": { + "description": "Currently set PatchAndConfigFeatureSet for name.", + "enum": [ + "PATCH_AND_CONFIG_FEATURE_SET_UNSPECIFIED", + "OSCONFIG_B", + "OSCONFIG_C" + ], + "enumDescriptions": [ + "Not specified placeholder", + "Basic feature set. Enables only the basic set of features.", + "Classic set of functionality." + ], + "type": "string" + } + }, + "type": "object" + }, "RecurringSchedule": { "description": "Sets the time for recurring patch deployments.", "id": "RecurringSchedule", diff --git a/discovery/people-v1.json b/discovery/people-v1.json index 5df0d618ef..624fd4a540 100644 --- a/discovery/people-v1.json +++ b/discovery/people-v1.json @@ -724,6 +724,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/contacts", + "https://www.googleapis.com/auth/contacts.other.readonly", "https://www.googleapis.com/auth/contacts.readonly", "https://www.googleapis.com/auth/directory.readonly", "https://www.googleapis.com/auth/user.addresses.read", @@ -788,6 +789,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/contacts", + "https://www.googleapis.com/auth/contacts.other.readonly", "https://www.googleapis.com/auth/contacts.readonly", "https://www.googleapis.com/auth/directory.readonly", "https://www.googleapis.com/auth/user.addresses.read", @@ -1188,7 +1190,7 @@ } } }, - "revision": "20240312", + "revision": "20240320", "rootUrl": "https://people.googleapis.com/", "schemas": { "Address": { diff --git a/discovery/playintegrity-v1.json b/discovery/playintegrity-v1.json index e836ad819b..f7cd862870 100644 --- a/discovery/playintegrity-v1.json +++ b/discovery/playintegrity-v1.json @@ -138,7 +138,7 @@ } } }, - "revision": "20240103", + "revision": "20240321", "rootUrl": "https://playintegrity.googleapis.com/", "schemas": { "AccountActivity": { @@ -304,7 +304,7 @@ "type": "object" }, "DeviceIntegrity": { - "description": "Contains the device attestation information.", + "description": "Contains the device attestation information. Next tag: 4", "id": "DeviceIntegrity", "properties": { "deviceRecognitionVerdict": { diff --git a/discovery/privateca-v1.json b/discovery/privateca-v1.json index e5fe1a0ef8..bf3d1cb90b 100644 --- a/discovery/privateca-v1.json +++ b/discovery/privateca-v1.json @@ -1605,7 +1605,7 @@ } } }, - "revision": "20240221", + "revision": "20240313", "rootUrl": "https://privateca.googleapis.com/", "schemas": { "AccessUrls": { @@ -2059,7 +2059,7 @@ "id": "CertificateConfigKeyId", "properties": { "keyId": { - "description": "Optional. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key.", + "description": "Required. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key.", "type": "string" } }, diff --git a/discovery/realtimebidding-v1.json b/discovery/realtimebidding-v1.json index 5d2b2a7545..02425c9c51 100644 --- a/discovery/realtimebidding-v1.json +++ b/discovery/realtimebidding-v1.json @@ -1305,7 +1305,7 @@ } } }, - "revision": "20231115", + "revision": "20240321", "rootUrl": "https://realtimebidding.googleapis.com/", "schemas": { "ActivatePretargetingConfigRequest": { @@ -2897,13 +2897,15 @@ "USER_ID_TYPE_UNSPECIFIED", "HOSTED_MATCH_DATA", "GOOGLE_COOKIE", - "DEVICE_ID" + "DEVICE_ID", + "PUBLISHER_PROVIDED_ID" ], "enumDescriptions": [ "Placeholder for unspecified user identifier.", "Hosted match data, referring to hosted_match_data in the bid request.", "Google cookie, referring to google_user_id in the bid request.", - "Mobile device advertising ID." + "Mobile device advertising ID.", + "The request has a publisher-provided ID available to the bidder." ], "type": "string" }, diff --git a/discovery/recaptchaenterprise-v1.json b/discovery/recaptchaenterprise-v1.json index 27fc16e328..67245b61ff 100644 --- a/discovery/recaptchaenterprise-v1.json +++ b/discovery/recaptchaenterprise-v1.json @@ -694,7 +694,7 @@ } } }, - "revision": "20240218", + "revision": "20240317", "rootUrl": "https://recaptchaenterprise.googleapis.com/", "schemas": { "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": { @@ -1415,7 +1415,7 @@ "type": "object" }, "GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse": { - "description": "Response to request to list firewall policies belonging to a key.", + "description": "Response to request to list firewall policies belonging to a project.", "id": "GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse", "properties": { "firewallPolicies": { diff --git a/discovery/redis-v1.json b/discovery/redis-v1.json index 7833c1ee46..f08414437f 100644 --- a/discovery/redis-v1.json +++ b/discovery/redis-v1.json @@ -821,9 +821,32 @@ } } }, - "revision": "20240307", + "revision": "20240319", "rootUrl": "https://redis.googleapis.com/", "schemas": { + "AOFConfig": { + "description": "Configuration of the AOF based persistence.", + "id": "AOFConfig", + "properties": { + "appendFsync": { + "description": "Optional. fsync configuration.", + "enum": [ + "APPEND_FSYNC_UNSPECIFIED", + "NO", + "EVERYSEC", + "ALWAYS" + ], + "enumDescriptions": [ + "Not set. Default: EVERYSEC", + "Never fsync. Normally Linux will flush data every 30 seconds with this configuration, but it's up to the kernel's exact tuning.", + "fsync every second. Fast enough, and you may lose 1 second of data if there is a disaster", + "fsync every time new commands are appended to the AOF. It has the best data loss protection at the cost of performance" + ], + "type": "string" + } + }, + "type": "object" + }, "AvailabilityConfiguration": { "description": "Configuration for availability of database instance", "id": "AvailabilityConfiguration", @@ -972,6 +995,10 @@ "description": "Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`", "type": "string" }, + "persistenceConfig": { + "$ref": "ClusterPersistenceConfig", + "description": "Optional. Persistence config (RDB, AOF) for the cluster." + }, "pscConfigs": { "description": "Required. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported.", "items": { @@ -987,6 +1014,13 @@ "readOnly": true, "type": "array" }, + "redisConfigs": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Key/Value pairs of customer overrides for mutable Redis Configs", + "type": "object" + }, "replicaCount": { "description": "Optional. The number of replica nodes per shard.", "format": "int32", @@ -1049,6 +1083,37 @@ }, "type": "object" }, + "ClusterPersistenceConfig": { + "description": "Configuration of the persistence functionality.", + "id": "ClusterPersistenceConfig", + "properties": { + "aofConfig": { + "$ref": "AOFConfig", + "description": "Optional. AOF configuration. This field will be ignored if mode is not AOF." + }, + "mode": { + "description": "Optional. The mode of persistence.", + "enum": [ + "PERSISTENCE_MODE_UNSPECIFIED", + "DISABLED", + "RDB", + "AOF" + ], + "enumDescriptions": [ + "Not set.", + "Persistence is disabled, and any snapshot data is deleted.", + "RDB based persistence is enabled.", + "AOF based persistence is enabled." + ], + "type": "string" + }, + "rdbConfig": { + "$ref": "RDBConfig", + "description": "Optional. RDB configuration. This field will be ignored if mode is not RDB." + } + }, + "type": "object" + }, "Compliance": { "description": "Contains compliance information about a security standard indicating unmet recommendations.", "id": "Compliance", @@ -1301,7 +1366,7 @@ "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", "SIGNAL_TYPE_RESTRICT_AUTHORIZED_NETWORKS", "SIGNAL_TYPE_VIOLATE_POLICY_RESTRICT_PUBLIC_IP", - "SIGNAL_TYPE_CLUSTER_QUOTA_LIMIT", + "SIGNAL_TYPE_QUOTA_LIMIT", "SIGNAL_TYPE_NO_PASSWORD_POLICY", "SIGNAL_TYPE_CONNECTIONS_PERFORMANCE_IMPACT", "SIGNAL_TYPE_TMP_TABLES_PERFORMANCE_IMPACT", @@ -1780,7 +1845,7 @@ "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", "SIGNAL_TYPE_RESTRICT_AUTHORIZED_NETWORKS", "SIGNAL_TYPE_VIOLATE_POLICY_RESTRICT_PUBLIC_IP", - "SIGNAL_TYPE_CLUSTER_QUOTA_LIMIT", + "SIGNAL_TYPE_QUOTA_LIMIT", "SIGNAL_TYPE_NO_PASSWORD_POLICY", "SIGNAL_TYPE_CONNECTIONS_PERFORMANCE_IMPACT", "SIGNAL_TYPE_TMP_TABLES_PERFORMANCE_IMPACT", @@ -2936,6 +3001,36 @@ }, "type": "object" }, + "RDBConfig": { + "description": "Configuration of the RDB based persistence.", + "id": "RDBConfig", + "properties": { + "rdbSnapshotPeriod": { + "description": "Optional. Period between RDB snapshots.", + "enum": [ + "SNAPSHOT_PERIOD_UNSPECIFIED", + "ONE_HOUR", + "SIX_HOURS", + "TWELVE_HOURS", + "TWENTY_FOUR_HOURS" + ], + "enumDescriptions": [ + "Not set.", + "One hour.", + "Six hours.", + "Twelve hours.", + "Twenty four hours." + ], + "type": "string" + }, + "rdbSnapshotStartTime": { + "description": "Optional. The time that the first snapshot was/will be attempted, and to which future snapshots will be aligned. If not provided, the current time will be used.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "ReconciliationOperationMetadata": { "description": "Operation metadata returned by the CLH during resource state reconciliation.", "id": "ReconciliationOperationMetadata", diff --git a/discovery/retail-v2.json b/discovery/retail-v2.json index 5acecaf769..ed0bc0cd1f 100644 --- a/discovery/retail-v2.json +++ b/discovery/retail-v2.json @@ -2087,7 +2087,7 @@ } } }, - "revision": "20240222", + "revision": "20240315", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -3031,7 +3031,7 @@ "id": "GoogleCloudRetailV2ExperimentInfoServingConfigExperiment", "properties": { "experimentServingConfig": { - "description": "The fully qualified resource name of the serving config VariantArm.serving_config_id responsible for generating the search response. For example: `projects/*/locations/*/catalogs/*/servingConfigs/*`.", + "description": "The fully qualified resource name of the serving config Experiment.VariantArm.serving_config_id responsible for generating the search response. For example: `projects/*/locations/*/catalogs/*/servingConfigs/*`.", "type": "string" }, "originalServingConfig": { diff --git a/discovery/retail-v2alpha.json b/discovery/retail-v2alpha.json index b77ed56f20..355f0b22f3 100644 --- a/discovery/retail-v2alpha.json +++ b/discovery/retail-v2alpha.json @@ -286,7 +286,7 @@ "type": "string" }, "updateMask": { - "description": "Indicates which fields in the provided LoggingConfig to update. The following are the only supported fields: * default_log_generation_rule * per_service_log_generation_rules If not set, all supported fields are updated.", + "description": "Indicates which fields in the provided LoggingConfig to update. The following are the only supported fields: * LoggingConfig.default_log_generation_rule * LoggingConfig.per_service_log_generation_rules If not set, all supported fields are updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -2475,7 +2475,7 @@ } } }, - "revision": "20240307", + "revision": "20240315", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -4207,7 +4207,7 @@ "id": "GoogleCloudRetailV2alphaExperimentInfoServingConfigExperiment", "properties": { "experimentServingConfig": { - "description": "The fully qualified resource name of the serving config VariantArm.serving_config_id responsible for generating the search response. For example: `projects/*/locations/*/catalogs/*/servingConfigs/*`.", + "description": "The fully qualified resource name of the serving config Experiment.VariantArm.serving_config_id responsible for generating the search response. For example: `projects/*/locations/*/catalogs/*/servingConfigs/*`.", "type": "string" }, "originalServingConfig": { diff --git a/discovery/retail-v2beta.json b/discovery/retail-v2beta.json index 3beae60ff4..4535a24054 100644 --- a/discovery/retail-v2beta.json +++ b/discovery/retail-v2beta.json @@ -2115,7 +2115,7 @@ } } }, - "revision": "20240222", + "revision": "20240315", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -4529,7 +4529,7 @@ "id": "GoogleCloudRetailV2betaExperimentInfoServingConfigExperiment", "properties": { "experimentServingConfig": { - "description": "The fully qualified resource name of the serving config VariantArm.serving_config_id responsible for generating the search response. For example: `projects/*/locations/*/catalogs/*/servingConfigs/*`.", + "description": "The fully qualified resource name of the serving config Experiment.VariantArm.serving_config_id responsible for generating the search response. For example: `projects/*/locations/*/catalogs/*/servingConfigs/*`.", "type": "string" }, "originalServingConfig": { diff --git a/discovery/run-v1.json b/discovery/run-v1.json index b34614e1da..4279212d0e 100644 --- a/discovery/run-v1.json +++ b/discovery/run-v1.json @@ -2614,7 +2614,7 @@ } } }, - "revision": "20240303", + "revision": "20240315", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -5867,7 +5867,7 @@ }, "metadata": { "$ref": "ObjectMeta", - "description": "Metadata associated with this Service, including name, namespace, labels, and annotations. 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. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal." + "description": "Metadata associated with this Service, including name, namespace, labels, and annotations. 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. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal." }, "spec": { "$ref": "ServiceSpec", diff --git a/discovery/run-v2.json b/discovery/run-v2.json index d5c8b08838..5881ed0cbb 100644 --- a/discovery/run-v2.json +++ b/discovery/run-v2.json @@ -1130,6 +1130,12 @@ "required": true, "type": "string" }, + "updateMask": { + "description": "Optional. The list of fields to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, "validateOnly": { "description": "Indicates that the request should be validated and default values populated, without persisting the request or updating any resources.", "location": "query", @@ -1317,7 +1323,7 @@ } } }, - "revision": "20240303", + "revision": "20240315", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -2829,13 +2835,15 @@ "INGRESS_TRAFFIC_UNSPECIFIED", "INGRESS_TRAFFIC_ALL", "INGRESS_TRAFFIC_INTERNAL_ONLY", - "INGRESS_TRAFFIC_INTERNAL_LOAD_BALANCER" + "INGRESS_TRAFFIC_INTERNAL_LOAD_BALANCER", + "INGRESS_TRAFFIC_NONE" ], "enumDescriptions": [ "Unspecified", "All inbound traffic is allowed.", "Only internal traffic is allowed.", - "Both internal and Google Cloud Load Balancer traffic is allowed." + "Both internal and Google Cloud Load Balancer traffic is allowed.", + "No ingress traffic is allowed." ], "type": "string" }, diff --git a/discovery/secretmanager-v1.json b/discovery/secretmanager-v1.json index 883b87bf31..9bf8cefcad 100644 --- a/discovery/secretmanager-v1.json +++ b/discovery/secretmanager-v1.json @@ -15,6 +15,13 @@ "description": "Stores sensitive data such as API keys, passwords, and certificates. Provides convenience while improving security. ", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/secret-manager/", + "endpoints": [ + { + "endpointUrl": "https://secretmanager.me-central2.rep.googleapis.com/", + "location": "me-central2", + "description": "Regional Endpoint" + } + ], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -1108,7 +1115,7 @@ } } }, - "revision": "20240309", + "revision": "20240314", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { diff --git a/discovery/secretmanager-v1beta1.json b/discovery/secretmanager-v1beta1.json index 7dea95678c..383e93f037 100644 --- a/discovery/secretmanager-v1beta1.json +++ b/discovery/secretmanager-v1beta1.json @@ -15,6 +15,13 @@ "description": "Stores sensitive data such as API keys, passwords, and certificates. Provides convenience while improving security. ", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/secret-manager/", + "endpoints": [ + { + "endpointUrl": "https://secretmanager.me-central2.rep.googleapis.com/", + "location": "me-central2", + "description": "Regional Endpoint" + } + ], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -628,7 +635,7 @@ } } }, - "revision": "20240126", + "revision": "20240314", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { diff --git a/discovery/secretmanager-v1beta2.json b/discovery/secretmanager-v1beta2.json index 58b3e0b7a5..e128b1baf1 100644 --- a/discovery/secretmanager-v1beta2.json +++ b/discovery/secretmanager-v1beta2.json @@ -15,6 +15,13 @@ "description": "Stores sensitive data such as API keys, passwords, and certificates. Provides convenience while improving security. ", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/secret-manager/", + "endpoints": [ + { + "endpointUrl": "https://secretmanager.me-central2.rep.googleapis.com/", + "location": "me-central2", + "description": "Regional Endpoint" + } + ], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -1108,7 +1115,7 @@ } } }, - "revision": "20240309", + "revision": "20240314", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { diff --git a/discovery/serviceconsumermanagement-v1beta1.json b/discovery/serviceconsumermanagement-v1beta1.json index b6084f231c..c2f6c06abb 100644 --- a/discovery/serviceconsumermanagement-v1beta1.json +++ b/discovery/serviceconsumermanagement-v1beta1.json @@ -315,12 +315,12 @@ ], "parameters": { "force": { - "description": "Whether to force the creation of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations.", + "description": "Whether to force the creation of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. If force is set to true, it is recommended to include a case id in \"X-Goog-Request-Reason\" header when sending the request.", "location": "query", "type": "boolean" }, "forceOnly": { - "description": "The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set.", + "description": "The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. If force_only is specified, it is recommended to include a case id in \"X-Goog-Request-Reason\" header when sending the request.", "enum": [ "QUOTA_SAFETY_CHECK_UNSPECIFIED", "LIMIT_DECREASE_BELOW_USAGE", @@ -364,12 +364,12 @@ ], "parameters": { "force": { - "description": "Whether to force the deletion of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations.", + "description": "Whether to force the deletion of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. If force is set to true, it is recommended to include a case id in \"X-Goog-Request-Reason\" header when sending the request.", "location": "query", "type": "boolean" }, "forceOnly": { - "description": "The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set.", + "description": "The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. If force_only is specified, it is recommended to include a case id in \"X-Goog-Request-Reason\" header when sending the request.", "enum": [ "QUOTA_SAFETY_CHECK_UNSPECIFIED", "LIMIT_DECREASE_BELOW_USAGE", @@ -446,12 +446,12 @@ ], "parameters": { "force": { - "description": "Whether to force the update of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations.", + "description": "Whether to force the update of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. If force is set to true, it is recommended to include a case id in \"X-Goog-Request-Reason\" header when sending the request.", "location": "query", "type": "boolean" }, "forceOnly": { - "description": "The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set.", + "description": "The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. If force_only is specified, it is recommended to include a case id in \"X-Goog-Request-Reason\" header when sending the request.", "enum": [ "QUOTA_SAFETY_CHECK_UNSPECIFIED", "LIMIT_DECREASE_BELOW_USAGE", @@ -500,7 +500,7 @@ } } }, - "revision": "20240103", + "revision": "20240319", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "Api": { @@ -2696,11 +2696,11 @@ "id": "V1Beta1ImportProducerOverridesRequest", "properties": { "force": { - "description": "Whether to force the creation of the quota overrides. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations.", + "description": "Whether to force the creation of the quota overrides. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. If force is set to true, it is recommended to include a case id in \"X-Goog-Request-Reason\" header when sending the request.", "type": "boolean" }, "forceOnly": { - "description": "The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set.", + "description": "The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. If force_only is specified, it is recommended to include a case id in \"X-Goog-Request-Reason\" header when sending the request.", "items": { "enum": [ "QUOTA_SAFETY_CHECK_UNSPECIFIED", diff --git a/discovery/serviceusage-v1beta1.json b/discovery/serviceusage-v1beta1.json index c45f1f7c03..dd78157ff7 100644 --- a/discovery/serviceusage-v1beta1.json +++ b/discovery/serviceusage-v1beta1.json @@ -581,12 +581,12 @@ ], "parameters": { "force": { - "description": "Whether to force the creation of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations.", + "description": "Whether to force the creation of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. If force is set to true, it is recommended to include a case id in \"X-Goog-Request-Reason\" header when sending the request.", "location": "query", "type": "boolean" }, "forceOnly": { - "description": "The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set.", + "description": "The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. If force_only is specified, it is recommended to include a case id in \"X-Goog-Request-Reason\" header when sending the request.", "enum": [ "QUOTA_SAFETY_CHECK_UNSPECIFIED", "LIMIT_DECREASE_BELOW_USAGE", @@ -631,12 +631,12 @@ ], "parameters": { "force": { - "description": "Whether to force the deletion of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations.", + "description": "Whether to force the deletion of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. If force is set to true, it is recommended to include a case id in \"X-Goog-Request-Reason\" header when sending the request.", "location": "query", "type": "boolean" }, "forceOnly": { - "description": "The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set.", + "description": "The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. If force_only is specified, it is recommended to include a case id in \"X-Goog-Request-Reason\" header when sending the request.", "enum": [ "QUOTA_SAFETY_CHECK_UNSPECIFIED", "LIMIT_DECREASE_BELOW_USAGE", @@ -715,12 +715,12 @@ ], "parameters": { "force": { - "description": "Whether to force the update of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations.", + "description": "Whether to force the update of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. If force is set to true, it is recommended to include a case id in \"X-Goog-Request-Reason\" header when sending the request.", "location": "query", "type": "boolean" }, "forceOnly": { - "description": "The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set.", + "description": "The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. If force_only is specified, it is recommended to include a case id in \"X-Goog-Request-Reason\" header when sending the request.", "enum": [ "QUOTA_SAFETY_CHECK_UNSPECIFIED", "LIMIT_DECREASE_BELOW_USAGE", @@ -775,12 +775,12 @@ ], "parameters": { "force": { - "description": "Whether to force the creation of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations.", + "description": "Whether to force the creation of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. If force is set to true, it is recommended to include a case id in \"X-Goog-Request-Reason\" header when sending the request.", "location": "query", "type": "boolean" }, "forceOnly": { - "description": "The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set.", + "description": "The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. If force_only is specified, it is recommended to include a case id in \"X-Goog-Request-Reason\" header when sending the request.", "enum": [ "QUOTA_SAFETY_CHECK_UNSPECIFIED", "LIMIT_DECREASE_BELOW_USAGE", @@ -825,12 +825,12 @@ ], "parameters": { "force": { - "description": "Whether to force the deletion of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations.", + "description": "Whether to force the deletion of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. If force is set to true, it is recommended to include a case id in \"X-Goog-Request-Reason\" header when sending the request.", "location": "query", "type": "boolean" }, "forceOnly": { - "description": "The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set.", + "description": "The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. If force_only is specified, it is recommended to include a case id in \"X-Goog-Request-Reason\" header when sending the request.", "enum": [ "QUOTA_SAFETY_CHECK_UNSPECIFIED", "LIMIT_DECREASE_BELOW_USAGE", @@ -909,12 +909,12 @@ ], "parameters": { "force": { - "description": "Whether to force the update of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations.", + "description": "Whether to force the update of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. If force is set to true, it is recommended to include a case id in \"X-Goog-Request-Reason\" header when sending the request.", "location": "query", "type": "boolean" }, "forceOnly": { - "description": "The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set.", + "description": "The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. If force_only is specified, it is recommended to include a case id in \"X-Goog-Request-Reason\" header when sending the request.", "enum": [ "QUOTA_SAFETY_CHECK_UNSPECIFIED", "LIMIT_DECREASE_BELOW_USAGE", @@ -964,7 +964,7 @@ } } }, - "revision": "20240310", + "revision": "20240319", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -2609,11 +2609,11 @@ "id": "ImportAdminOverridesRequest", "properties": { "force": { - "description": "Whether to force the creation of the quota overrides. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations.", + "description": "Whether to force the creation of the quota overrides. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. If force is set to true, it is recommended to include a case id in \"X-Goog-Request-Reason\" header when sending the request.", "type": "boolean" }, "forceOnly": { - "description": "The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set.", + "description": "The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. If force_only is specified, it is recommended to include a case id in \"X-Goog-Request-Reason\" header when sending the request.", "items": { "enum": [ "QUOTA_SAFETY_CHECK_UNSPECIFIED", @@ -2681,11 +2681,11 @@ "id": "ImportConsumerOverridesRequest", "properties": { "force": { - "description": "Whether to force the creation of the quota overrides. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations.", + "description": "Whether to force the creation of the quota overrides. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. If force is set to true, it is recommended to include a case id in \"X-Goog-Request-Reason\" header when sending the request.", "type": "boolean" }, "forceOnly": { - "description": "The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set.", + "description": "The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. If force_only is specified, it is recommended to include a case id in \"X-Goog-Request-Reason\" header when sending the request.", "items": { "enum": [ "QUOTA_SAFETY_CHECK_UNSPECIFIED", diff --git a/discovery/sheets-v4.json b/discovery/sheets-v4.json index 6727477541..e2cb17dcb4 100644 --- a/discovery/sheets-v4.json +++ b/discovery/sheets-v4.json @@ -870,7 +870,7 @@ } } }, - "revision": "20230920", + "revision": "20240318", "rootUrl": "https://sheets.googleapis.com/", "schemas": { "AddBandingRequest": { @@ -6830,6 +6830,10 @@ "$ref": "CellFormat", "description": "The default format of all cells in the spreadsheet. CellData.effectiveFormat will not be set if the cell's format is equal to this default format. This field is read-only." }, + "importFunctionsExternalUrlAccessAllowed": { + "description": "Whether to allow external url access for image and import functions. Read only when true. When false, you can set to true.", + "type": "boolean" + }, "iterativeCalculationSettings": { "$ref": "IterativeCalculationSettings", "description": "Determines whether and how circular references are resolved with iterative calculation. Absence of this field means that circular references result in calculation errors." diff --git a/discovery/spanner-v1.json b/discovery/spanner-v1.json index db54add1e2..d0a46c447d 100644 --- a/discovery/spanner-v1.json +++ b/discovery/spanner-v1.json @@ -2411,7 +2411,219 @@ } } }, + "instancePartitionOperations": { + "methods": { + "list": { + "description": "Lists instance partition long-running operations in the given instance. An instance partition operation has a name of the form `projects//instances//instancePartitions//operations/`. The long-running operation metadata field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.start_time` in descending order starting from the most recently started operation. Authorization requires `spanner.instancePartitionOperations.list` permission on the resource parent.", + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/instancePartitionOperations", + "httpMethod": "GET", + "id": "spanner.projects.instances.instancePartitionOperations.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression that filters the list of returned operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for CreateInstancePartitionMetadata is `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstancePartitionMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first, if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=` \\ `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstancePartitionMetadata) AND` \\ `(metadata.instance_partition.name:custom-instance-partition) AND` \\ `(metadata.start_time < \\\"2021-03-28T14:50:00Z\\\") AND` \\ `(error:*)` - Return operations where: * The operation's metadata type is CreateInstancePartitionMetadata. * The instance partition name contains \"custom-instance-partition\". * The operation started before 2021-03-28T14:50:00Z. * The operation resulted in an error.", + "location": "query", + "type": "string" + }, + "instancePartitionDeadline": { + "description": "Optional. Deadline used while retrieving metadata for instance partition operations. Instance partitions whose operation metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancePartitionOperationsResponse.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. If non-empty, `page_token` should contain a next_page_token from a previous ListInstancePartitionOperationsResponse to the same `parent` and with the same `filter`.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent instance of the instance partition operations. Values are of the form `projects//instances/`.", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/instancePartitionOperations", + "response": { + "$ref": "ListInstancePartitionOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ] + } + } + }, "instancePartitions": { + "methods": { + "create": { + "description": "Creates an instance partition and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance partition. The instance partition name is assigned by the caller. If the named instance partition already exists, `CreateInstancePartition` returns `ALREADY_EXISTS`. Immediately upon completion of this request: * The instance partition is readable via the API, with all requested attributes but no allocated resources. Its state is `CREATING`. Until completion of the returned operation: * Cancelling the operation renders the instance partition immediately unreadable via the API. * The instance partition can be deleted. * All other attempts to modify the instance partition are rejected. Upon completion of the returned operation: * Billing for all successfully-allocated resources begins (some types may have lower than the requested levels). * Databases can start using this instance partition. * The instance partition's allocated resource levels are readable via the API. * The instance partition's state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance partition. The metadata field type is CreateInstancePartitionMetadata. The response field type is InstancePartition, if successful.", + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/instancePartitions", + "httpMethod": "POST", + "id": "spanner.projects.instances.instancePartitions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the instance in which to create the instance partition. Values are of the form `projects//instances/`.", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/instancePartitions", + "request": { + "$ref": "CreateInstancePartitionRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ] + }, + "delete": { + "description": "Deletes an existing instance partition. Requires that the instance partition is not used by any database or backup and is not the default instance partition of an instance. Authorization requires `spanner.instancePartitions.delete` permission on the resource name.", + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/instancePartitions/{instancePartitionsId}", + "httpMethod": "DELETE", + "id": "spanner.projects.instances.instancePartitions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. If not empty, the API only deletes the instance partition when the etag provided matches the current status of the requested instance partition. Otherwise, deletes the instance partition without checking the current status of the requested instance partition.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The name of the instance partition to be deleted. Values are of the form `projects/{project}/instances/{instance}/instancePartitions/{instance_partition}`", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+/instancePartitions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ] + }, + "get": { + "description": "Gets information about a particular instance partition.", + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/instancePartitions/{instancePartitionsId}", + "httpMethod": "GET", + "id": "spanner.projects.instances.instancePartitions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the requested instance partition. Values are of the form `projects/{project}/instances/{instance}/instancePartitions/{instance_partition}`.", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+/instancePartitions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "InstancePartition" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ] + }, + "list": { + "description": "Lists all instance partitions for the given instance.", + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/instancePartitions", + "httpMethod": "GET", + "id": "spanner.projects.instances.instancePartitions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "instancePartitionDeadline": { + "description": "Optional. Deadline used while retrieving metadata for instance partitions. Instance partitions whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancePartitionsResponse.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Number of instance partitions to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "If non-empty, `page_token` should contain a next_page_token from a previous ListInstancePartitionsResponse.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The instance whose instance partitions should be listed. Values are of the form `projects//instances/`.", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/instancePartitions", + "response": { + "$ref": "ListInstancePartitionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ] + }, + "patch": { + "description": "Updates an instance partition, and begins allocating or releasing resources as requested. The returned long-running operation can be used to track the progress of updating the instance partition. If the named instance partition does not exist, returns `NOT_FOUND`. Immediately upon completion of this request: * For resource types for which a decrease in the instance partition's allocation has been requested, billing is based on the newly-requested level. Until completion of the returned operation: * Cancelling the operation sets its metadata's cancel_time, and begins restoring resources to their pre-request values. The operation is guaranteed to succeed at undoing all resource changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance partition are rejected. * Reading the instance partition via the API continues to give the pre-request resource levels. Upon completion of the returned operation: * Billing begins for all successfully-allocated resources (some types may have lower than the requested levels). * All newly-reserved resources are available for serving the instance partition's tables. * The instance partition's new resource levels are readable via the API. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance partition modification. The metadata field type is UpdateInstancePartitionMetadata. The response field type is InstancePartition, if successful. Authorization requires `spanner.instancePartitions.update` permission on the resource name.", + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/instancePartitions/{instancePartitionsId}", + "httpMethod": "PATCH", + "id": "spanner.projects.instances.instancePartitions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. A unique identifier for the instance partition. Values are of the form `projects//instances//instancePartitions/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. An instance partition's name cannot be changed after the instance partition is created.", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+/instancePartitions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "UpdateInstancePartitionRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ] + } + }, "resources": { "operations": { "methods": { @@ -2729,7 +2941,7 @@ } } }, - "revision": "20240307", + "revision": "20240315", "rootUrl": "https://spanner.googleapis.com/", "schemas": { "AutoscalingConfig": { @@ -3375,6 +3587,47 @@ }, "type": "object" }, + "CreateInstancePartitionMetadata": { + "description": "Metadata type for the operation returned by CreateInstancePartition.", + "id": "CreateInstancePartitionMetadata", + "properties": { + "cancelTime": { + "description": "The time at which this operation was cancelled. If set, this operation is in the process of undoing itself (which is guaranteed to succeed) and cannot be cancelled again.", + "format": "google-datetime", + "type": "string" + }, + "endTime": { + "description": "The time at which this operation failed or was completed successfully.", + "format": "google-datetime", + "type": "string" + }, + "instancePartition": { + "$ref": "InstancePartition", + "description": "The instance partition being created." + }, + "startTime": { + "description": "The time at which the CreateInstancePartition request was received.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "CreateInstancePartitionRequest": { + "description": "The request for CreateInstancePartition.", + "id": "CreateInstancePartitionRequest", + "properties": { + "instancePartition": { + "$ref": "InstancePartition", + "description": "Required. The instance partition to create. The instance_partition.name may be omitted, but if specified must be `/instancePartitions/`." + }, + "instancePartitionId": { + "description": "Required. The ID of the instance partition to create. Valid identifiers are of the form `a-z*[a-z0-9]` and must be between 2 and 64 characters in length.", + "type": "string" + } + }, + "type": "object" + }, "CreateInstanceRequest": { "description": "The request for CreateInstance.", "id": "CreateInstanceRequest", @@ -4200,6 +4453,82 @@ }, "type": "object" }, + "InstancePartition": { + "description": "An isolated set of Cloud Spanner resources that databases can define placements on.", + "id": "InstancePartition", + "properties": { + "config": { + "description": "Required. The name of the instance partition's configuration. Values are of the form `projects//instanceConfigs/`. See also InstanceConfig and ListInstanceConfigs.", + "type": "string" + }, + "createTime": { + "description": "Output only. The time at which the instance partition was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. The descriptive name for this instance partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.", + "type": "string" + }, + "etag": { + "description": "Used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance partition from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance partition updates in order to avoid race conditions: An etag is returned in the response which contains instance partitions, and systems are expected to put that etag in the request to update instance partitions to ensure that their change will be applied to the same version of the instance partition. If no etag is provided in the call to update instance partition, then the existing instance partition is overwritten blindly.", + "type": "string" + }, + "name": { + "description": "Required. A unique identifier for the instance partition. Values are of the form `projects//instances//instancePartitions/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. An instance partition's name cannot be changed after the instance partition is created.", + "type": "string" + }, + "nodeCount": { + "description": "The number of nodes allocated to this instance partition. Users can set the node_count field to specify the target number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`.", + "format": "int32", + "type": "integer" + }, + "processingUnits": { + "description": "The number of processing units allocated to this instance partition. Users can set the processing_units field to specify the target number of processing units allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`.", + "format": "int32", + "type": "integer" + }, + "referencingBackups": { + "description": "Output only. The names of the backups that reference this instance partition. Referencing backups should share the parent instance. The existence of any referencing backup prevents the instance partition from being deleted.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "referencingDatabases": { + "description": "Output only. The names of the databases that reference this instance partition. Referencing databases should share the parent instance. The existence of any referencing database prevents the instance partition from being deleted.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "state": { + "description": "Output only. The current instance partition state.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "READY" + ], + "enumDescriptions": [ + "Not specified.", + "The instance partition is still being created. Resources may not be available yet, and operations such as creating placements using this instance partition may not work.", + "The instance partition is fully created and ready to do work such as creating placements and using in databases." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time at which the instance partition was most recently updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "KeyRange": { "description": "KeyRange represents a range of rows in a table or index. A range has a start key and an end key. These keys can be open or closed, indicating if the range includes rows with that key. Keys are represented by lists, where the ith value in the list corresponds to the ith component of the table or index primary key. Individual values are encoded as described here. For example, consider the following table definition: CREATE TABLE UserEvents ( UserName STRING(MAX), EventDate STRING(10) ) PRIMARY KEY(UserName, EventDate); The following keys name rows in this table: \"Bob\", \"2014-09-23\" Since the `UserEvents` table's `PRIMARY KEY` clause names two columns, each `UserEvents` key has two elements; the first is the `UserName`, and the second is the `EventDate`. Key ranges with multiple components are interpreted lexicographically by component using the table or index key's declared sort order. For example, the following range returns all events for user `\"Bob\"` that occurred in the year 2015: \"start_closed\": [\"Bob\", \"2015-01-01\"] \"end_closed\": [\"Bob\", \"2015-12-31\"] Start and end keys can omit trailing key components. This affects the inclusion and exclusion of rows that exactly match the provided key components: if the key is closed, then rows that exactly match the provided components are included; if the key is open, then rows that exactly match are not included. For example, the following range includes all events for `\"Bob\"` that occurred during and after the year 2000: \"start_closed\": [\"Bob\", \"2000-01-01\"] \"end_closed\": [\"Bob\"] The next example retrieves all events for `\"Bob\"`: \"start_closed\": [\"Bob\"] \"end_closed\": [\"Bob\"] To retrieve events before the year 2000: \"start_closed\": [\"Bob\"] \"end_open\": [\"Bob\", \"2000-01-01\"] The following range includes all rows in the table: \"start_closed\": [] \"end_closed\": [] This range returns all users whose `UserName` begins with any character from A to C: \"start_closed\": [\"A\"] \"end_open\": [\"D\"] This range returns all users whose `UserName` begins with B: \"start_closed\": [\"B\"] \"end_open\": [\"C\"] Key ranges honor column sort order. For example, suppose a table is defined as follows: CREATE TABLE DescendingSortedTable { Key INT64, ... ) PRIMARY KEY(Key DESC); The following range retrieves all rows with key values between 1 and 100 inclusive: \"start_closed\": [\"100\"] \"end_closed\": [\"1\"] Note that 100 is passed as the start, and 1 is passed as the end, because `Key` is a descending column in the schema.", "id": "KeyRange", @@ -4459,6 +4788,56 @@ }, "type": "object" }, + "ListInstancePartitionOperationsResponse": { + "description": "The response for ListInstancePartitionOperations.", + "id": "ListInstancePartitionOperationsResponse", + "properties": { + "nextPageToken": { + "description": "`next_page_token` can be sent in a subsequent ListInstancePartitionOperations call to fetch more of the matching metadata.", + "type": "string" + }, + "operations": { + "description": "The list of matching instance partition long-running operations. Each operation's name will be prefixed by the instance partition's name. The operation's metadata field type `metadata.type_url` describes the type of the metadata.", + "items": { + "$ref": "Operation" + }, + "type": "array" + }, + "unreachableInstancePartitions": { + "description": "The list of unreachable instance partitions. It includes the names of instance partitions whose operation metadata could not be retrieved within instance_partition_deadline.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListInstancePartitionsResponse": { + "description": "The response for ListInstancePartitions.", + "id": "ListInstancePartitionsResponse", + "properties": { + "instancePartitions": { + "description": "The list of requested instancePartitions.", + "items": { + "$ref": "InstancePartition" + }, + "type": "array" + }, + "nextPageToken": { + "description": "`next_page_token` can be sent in a subsequent ListInstancePartitions call to fetch more of the matching instance partitions.", + "type": "string" + }, + "unreachable": { + "description": "The list of unreachable instance partitions. It includes the names of instance partitions whose metadata could not be retrieved within instance_partition_deadline.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ListInstancesResponse": { "description": "The response for ListInstances.", "id": "ListInstancesResponse", @@ -6011,6 +6390,48 @@ }, "type": "object" }, + "UpdateInstancePartitionMetadata": { + "description": "Metadata type for the operation returned by UpdateInstancePartition.", + "id": "UpdateInstancePartitionMetadata", + "properties": { + "cancelTime": { + "description": "The time at which this operation was cancelled. If set, this operation is in the process of undoing itself (which is guaranteed to succeed) and cannot be cancelled again.", + "format": "google-datetime", + "type": "string" + }, + "endTime": { + "description": "The time at which this operation failed or was completed successfully.", + "format": "google-datetime", + "type": "string" + }, + "instancePartition": { + "$ref": "InstancePartition", + "description": "The desired end state of the update." + }, + "startTime": { + "description": "The time at which UpdateInstancePartition request was received.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "UpdateInstancePartitionRequest": { + "description": "The request for UpdateInstancePartition.", + "id": "UpdateInstancePartitionRequest", + "properties": { + "fieldMask": { + "description": "Required. A mask specifying which fields in InstancePartition should be updated. The field mask must always be specified; this prevents any future fields in InstancePartition from being erased accidentally by clients that do not know about them.", + "format": "google-fieldmask", + "type": "string" + }, + "instancePartition": { + "$ref": "InstancePartition", + "description": "Required. The instance partition to update, which must always include the instance partition name. Otherwise, only fields mentioned in field_mask need be included." + } + }, + "type": "object" + }, "UpdateInstanceRequest": { "description": "The request for UpdateInstance.", "id": "UpdateInstanceRequest", diff --git a/discovery/sqladmin-v1.json b/discovery/sqladmin-v1.json index 3a29c42929..8f5392ea75 100644 --- a/discovery/sqladmin-v1.json +++ b/discovery/sqladmin-v1.json @@ -2267,7 +2267,7 @@ } } }, - "revision": "20240304", + "revision": "20240317", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -2403,6 +2403,25 @@ "description": "The number of days of transaction logs we retain for point in time restore, from 1-7.", "format": "int32", "type": "integer" + }, + "transactionalLogStorageState": { + "description": "Output only. This value contains the storage location of transactional logs for the database for point-in-time recovery.", + "enum": [ + "TRANSACTIONAL_LOG_STORAGE_STATE_UNSPECIFIED", + "DISK", + "SWITCHING_TO_CLOUD_STORAGE", + "SWITCHED_TO_CLOUD_STORAGE", + "CLOUD_STORAGE" + ], + "enumDescriptions": [ + "Unspecified.", + "The transaction logs for the instance are stored on a data disk.", + "The transaction logs for the instance are switching from being stored on a data disk to being stored in Cloud Storage.", + "The transaction logs for the instance are now stored in Cloud Storage. Previously, they were stored on a data disk.", + "The transaction logs for the instance are stored in Cloud Storage." + ], + "readOnly": true, + "type": "string" } }, "type": "object" @@ -3163,6 +3182,10 @@ "description": "The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance.", "type": "string" }, + "geminiConfig": { + "$ref": "GeminiInstanceConfig", + "description": "Gemini configuration." + }, "instanceType": { "description": "The instance type.", "enum": [ @@ -3251,6 +3274,10 @@ }, "type": "array" }, + "replicationCluster": { + "$ref": "ReplicationCluster", + "description": "Optional. The pair of a primary instance and disaster recovery (DR) replica. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance has regional failure." + }, "rootPassword": { "description": "Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.", "type": "string" @@ -3907,6 +3934,43 @@ }, "type": "object" }, + "GeminiInstanceConfig": { + "description": "Gemini configuration.", + "id": "GeminiInstanceConfig", + "properties": { + "activeQueryEnabled": { + "description": "Output only. Whether active query is enabled.", + "readOnly": true, + "type": "boolean" + }, + "entitled": { + "description": "Output only. Whether gemini is enabled.", + "readOnly": true, + "type": "boolean" + }, + "flagRecommenderEnabled": { + "description": "Output only. Whether flag recommender is enabled.", + "readOnly": true, + "type": "boolean" + }, + "googleVacuumMgmtEnabled": { + "description": "Output only. Whether vacuum management is enabled.", + "readOnly": true, + "type": "boolean" + }, + "indexAdvisorEnabled": { + "description": "Output only. Whether index advisor is enabled.", + "readOnly": true, + "type": "boolean" + }, + "oomSessionCancelEnabled": { + "description": "Output only. Whether oom session cancel is enabled.", + "readOnly": true, + "type": "boolean" + } + }, + "type": "object" + }, "GenerateEphemeralCertRequest": { "description": "Ephemeral certificate creation request.", "id": "GenerateEphemeralCertRequest", @@ -4642,7 +4706,8 @@ "REENCRYPT", "SWITCHOVER", "ACQUIRE_SSRS_LEASE", - "RELEASE_SSRS_LEASE" + "RELEASE_SSRS_LEASE", + "RECONFIGURE_OLD_PRIMARY" ], "enumDeprecated": [ false, @@ -4685,6 +4750,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -4728,7 +4794,8 @@ "Re-encrypts CMEK instances with latest key version.", "Switches over to replica instance from primary.", "Acquire a lease for the setup of SQL Server Reporting Services (SSRS).", - "Release a lease for the setup of SQL Server Reporting Services (SSRS)." + "Release a lease for the setup of SQL Server Reporting Services (SSRS).", + "Reconfigures old primary after a promote replica operation. Effect of a promote operation to the old primary is executed in this operation, asynchronously from the promote replica operation executed to the replica." ], "type": "string" }, @@ -4994,6 +5061,22 @@ }, "type": "object" }, + "ReplicationCluster": { + "description": "Primary-DR replica pair", + "id": "ReplicationCluster", + "properties": { + "drReplica": { + "description": "Output only. read-only field that indicates if the replica is a dr_replica; not set for a primary.", + "readOnly": true, + "type": "boolean" + }, + "failoverDrReplicaName": { + "description": "Optional. If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. A DR replica is an optional configuration for Enterprise Plus edition instances. If the instance is a read replica, then the field is not set. Users can set this field to set a designated DR replica for a primary. Removing this field removes the DR replica.", + "type": "string" + } + }, + "type": "object" + }, "Reschedule": { "id": "Reschedule", "properties": { @@ -5211,7 +5294,7 @@ "type": "string" }, "enableGoogleMlIntegration": { - "description": "Optional. Configuration to enable Cloud SQL Vertex AI Integration", + "description": "Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for PostgreSQL instances.", "type": "boolean" }, "insightsConfig": { @@ -5510,6 +5593,20 @@ "description": "Instance start external sync request.", "id": "SqlInstancesStartExternalSyncRequest", "properties": { + "migrationType": { + "description": "Optional. MigrationType decides if the migration is a physical file based migration or logical migration.", + "enum": [ + "MIGRATION_TYPE_UNSPECIFIED", + "LOGICAL", + "PHYSICAL" + ], + "enumDescriptions": [ + "Default value is logical migration", + "Logical Migrations", + "Physical file based Migrations" + ], + "type": "string" + }, "mysqlSyncConfig": { "$ref": "MySqlSyncConfig", "description": "MySQL-specific settings for start external sync." @@ -5555,6 +5652,20 @@ "description": "Instance verify external sync settings request.", "id": "SqlInstancesVerifyExternalSyncSettingsRequest", "properties": { + "migrationType": { + "description": "Optional. MigrationType decides if the migration is a physical file based migration or logical migration", + "enum": [ + "MIGRATION_TYPE_UNSPECIFIED", + "LOGICAL", + "PHYSICAL" + ], + "enumDescriptions": [ + "Default value is logical migration", + "Logical Migrations", + "Physical file based Migrations" + ], + "type": "string" + }, "mysqlSyncConfig": { "$ref": "MySqlSyncConfig", "description": "Optional. MySQL-specific settings for start external sync." diff --git a/discovery/sqladmin-v1beta4.json b/discovery/sqladmin-v1beta4.json index 50d4583ca9..204bdcb4f6 100644 --- a/discovery/sqladmin-v1beta4.json +++ b/discovery/sqladmin-v1beta4.json @@ -2267,7 +2267,7 @@ } } }, - "revision": "20240304", + "revision": "20240317", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -2403,6 +2403,25 @@ "description": "The number of days of transaction logs we retain for point in time restore, from 1-7.", "format": "int32", "type": "integer" + }, + "transactionalLogStorageState": { + "description": "Output only. This value contains the storage location of transactional logs for the database for point-in-time recovery.", + "enum": [ + "TRANSACTIONAL_LOG_STORAGE_STATE_UNSPECIFIED", + "DISK", + "SWITCHING_TO_CLOUD_STORAGE", + "SWITCHED_TO_CLOUD_STORAGE", + "CLOUD_STORAGE" + ], + "enumDescriptions": [ + "Unspecified.", + "The transaction logs for the instance are stored on a data disk.", + "The transaction logs for the instance are switching from being stored on a data disk to being stored in Cloud Storage.", + "The transaction logs for the instance are now stored in Cloud Storage. Previously, they were stored on a data disk.", + "The transaction logs for the instance are stored in Cloud Storage." + ], + "readOnly": true, + "type": "string" } }, "type": "object" @@ -3163,6 +3182,10 @@ "description": "The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance.", "type": "string" }, + "geminiConfig": { + "$ref": "GeminiInstanceConfig", + "description": "Gemini instance configuration." + }, "instanceType": { "description": "The instance type.", "enum": [ @@ -3251,6 +3274,10 @@ }, "type": "array" }, + "replicationCluster": { + "$ref": "ReplicationCluster", + "description": "The pair of a primary instance and disaster recovery (DR) replica. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance has regional failure." + }, "rootPassword": { "description": "Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.", "type": "string" @@ -3908,6 +3935,43 @@ }, "type": "object" }, + "GeminiInstanceConfig": { + "description": "Gemini configuration.", + "id": "GeminiInstanceConfig", + "properties": { + "activeQueryEnabled": { + "description": "Output only. Whether active query is enabled.", + "readOnly": true, + "type": "boolean" + }, + "entitled": { + "description": "Output only. Whether Gemini is enabled.", + "readOnly": true, + "type": "boolean" + }, + "flagRecommenderEnabled": { + "description": "Output only. Whether flag recommender is enabled.", + "readOnly": true, + "type": "boolean" + }, + "googleVacuumMgmtEnabled": { + "description": "Output only. Whether vacuum management is enabled.", + "readOnly": true, + "type": "boolean" + }, + "indexAdvisorEnabled": { + "description": "Output only. Whether index advisor is enabled.", + "readOnly": true, + "type": "boolean" + }, + "oomSessionCancelEnabled": { + "description": "Output only. Whether oom session cancel is enabled.", + "readOnly": true, + "type": "boolean" + } + }, + "type": "object" + }, "GenerateEphemeralCertRequest": { "description": "Ephemeral certificate creation request.", "id": "GenerateEphemeralCertRequest", @@ -4643,7 +4707,8 @@ "REENCRYPT", "SWITCHOVER", "ACQUIRE_SSRS_LEASE", - "RELEASE_SSRS_LEASE" + "RELEASE_SSRS_LEASE", + "RECONFIGURE_OLD_PRIMARY" ], "enumDeprecated": [ false, @@ -4686,6 +4751,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -4729,7 +4795,8 @@ "Re-encrypts CMEK instances with latest key version.", "Switches over to replica instance from primary.", "Acquire a lease for the setup of SQL Server Reporting Services (SSRS).", - "Release a lease for the setup of SQL Server Reporting Services (SSRS)." + "Release a lease for the setup of SQL Server Reporting Services (SSRS).", + "Reconfigures old primary after a promote replica operation. Effect of a promote operation to the old primary is executed in this operation, asynchronously from the promote replica operation executed to the replica." ], "type": "string" }, @@ -4995,6 +5062,22 @@ }, "type": "object" }, + "ReplicationCluster": { + "description": "Primary-DR replica pair", + "id": "ReplicationCluster", + "properties": { + "drReplica": { + "description": "Output only. read-only field that indicates if the replica is a dr_replica; not set for a primary.", + "readOnly": true, + "type": "boolean" + }, + "failoverDrReplicaName": { + "description": "Optional. If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. A DR replica is an optional configuration for Enterprise Plus edition instances. If the instance is a read replica, then the field is not set. Users can set this field to set a designated DR replica for a primary. Removing this field removes the DR replica.", + "type": "string" + } + }, + "type": "object" + }, "Reschedule": { "id": "Reschedule", "properties": { @@ -5212,7 +5295,7 @@ "type": "string" }, "enableGoogleMlIntegration": { - "description": "Optional. Configuration to enable Cloud SQL Vertex AI Integration", + "description": "Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for PostgreSQL instances.", "type": "boolean" }, "insightsConfig": { @@ -5510,6 +5593,20 @@ "SqlInstancesStartExternalSyncRequest": { "id": "SqlInstancesStartExternalSyncRequest", "properties": { + "migrationType": { + "description": "Optional. MigrationType decides if the migration is a physical file based migration or logical migration.", + "enum": [ + "MIGRATION_TYPE_UNSPECIFIED", + "LOGICAL", + "PHYSICAL" + ], + "enumDescriptions": [ + "If no migration type is specified it will be defaulted to LOGICAL.", + "Logical Migrations", + "Physical file based Migrations" + ], + "type": "string" + }, "mysqlSyncConfig": { "$ref": "MySqlSyncConfig", "description": "MySQL-specific settings for start external sync." @@ -5554,6 +5651,20 @@ "SqlInstancesVerifyExternalSyncSettingsRequest": { "id": "SqlInstancesVerifyExternalSyncSettingsRequest", "properties": { + "migrationType": { + "description": "Optional. MigrationType field decides if the migration is a physical file based migration or logical migration", + "enum": [ + "MIGRATION_TYPE_UNSPECIFIED", + "LOGICAL", + "PHYSICAL" + ], + "enumDescriptions": [ + "If no migration type is specified it will be defaulted to LOGICAL.", + "Logical Migrations", + "Physical file based Migrations" + ], + "type": "string" + }, "mysqlSyncConfig": { "$ref": "MySqlSyncConfig", "description": "Optional. MySQL-specific settings for start external sync." diff --git a/discovery/storage-v1.json b/discovery/storage-v1.json index 81192115bc..2a7e2f5d07 100644 --- a/discovery/storage-v1.json +++ b/discovery/storage-v1.json @@ -33,7 +33,7 @@ "description": "Regional Endpoint" } ], - "etag": "\"37303437343235343136323638383931333233\"", + "etag": "\"33303333323233383838323039393532373539\"", "icons": { "x16": "https://www.google.com/images/icons/product/cloud_storage-16.png", "x32": "https://www.google.com/images/icons/product/cloud_storage-32.png" @@ -1632,6 +1632,11 @@ "managedFolder" ], "parameters": { + "allowNonEmpty": { + "description": "Allows the deletion of a managed folder even if it is not empty. A managed folder is empty if there are no objects or managed folders that it applies to. Callers must have storage.managedFolders.setIamPolicy permission.", + "location": "query", + "type": "boolean" + }, "bucket": { "description": "Name of the bucket containing the managed folder.", "location": "path", @@ -3141,7 +3146,8 @@ "id": "storage.objects.restore", "parameterOrder": [ "bucket", - "object" + "object", + "generation" ], "parameters": { "bucket": { @@ -4037,7 +4043,7 @@ } } }, - "revision": "20240307", + "revision": "20240319", "rootUrl": "https://storage.googleapis.com/", "schemas": { "AnywhereCache": { diff --git a/discovery/sts-v1.json b/discovery/sts-v1.json index c6cf3a8007..6dfc1e1d08 100644 --- a/discovery/sts-v1.json +++ b/discovery/sts-v1.json @@ -98,36 +98,6 @@ "resources": { "v1": { "methods": { - "introspect": { - "description": "Gets information about a Google OAuth 2.0 access token issued by the Google Cloud [Security Token Service API](https://cloud.google.com/iam/docs/reference/sts/rest).", - "flatPath": "v1/introspect", - "httpMethod": "POST", - "id": "sts.introspect", - "parameterOrder": [], - "parameters": {}, - "path": "v1/introspect", - "request": { - "$ref": "GoogleIdentityStsV1IntrospectTokenRequest" - }, - "response": { - "$ref": "GoogleIdentityStsV1IntrospectTokenResponse" - } - }, - "oauthtoken": { - "description": "Exchanges a credential that represents the resource owner's authorization for a Google-generated [OAuth 2.0 access token] (https://www.rfc-editor.org/rfc/rfc6749#section-5) or [refreshes an accesstoken] (https://www.rfc-editor.org/rfc/rfc6749#section-6) following [the OAuth 2.0 authorization framework] (https://tools.ietf.org/html/rfc8693) The credential can be one of the following: - An authorization code issued by the workforce identity federation authorization endpoint - A [refresh token](https://www.rfc-editor.org/rfc/rfc6749#section-10.4) issued by this endpoint This endpoint is only meant to be called by the Google Cloud CLI. Also note that this API only accepts the authorization code issued for workforce pools.", - "flatPath": "v1/oauthtoken", - "httpMethod": "POST", - "id": "sts.oauthtoken", - "parameterOrder": [], - "parameters": {}, - "path": "v1/oauthtoken", - "request": { - "$ref": "GoogleIdentityStsV1ExchangeOauthTokenRequest" - }, - "response": { - "$ref": "GoogleIdentityStsV1ExchangeOauthTokenResponse" - } - }, "token": { "description": "Exchanges a credential for a Google OAuth 2.0 access token. The token asserts an external identity within an identity pool, or it applies a Credential Access Boundary to a Google access token. Note that workforce pools do not support Credential Access Boundaries. When you call this method, do not send the `Authorization` HTTP header in the request. This method does not require the `Authorization` header, and using the header can cause the request to fail.", "flatPath": "v1/token", @@ -146,7 +116,7 @@ } } }, - "revision": "20240129", + "revision": "20240320", "rootUrl": "https://sts.googleapis.com/", "schemas": { "GoogleIamV1Binding": { @@ -207,73 +177,6 @@ }, "type": "object" }, - "GoogleIdentityStsV1ExchangeOauthTokenRequest": { - "description": "Request message for ExchangeOauthToken", - "id": "GoogleIdentityStsV1ExchangeOauthTokenRequest", - "properties": { - "clientId": { - "description": "Optional. The client identifier for the OAuth 2.0 client that requested the provided token. It is REQUIRED when the [client] (https://www.rfc-editor.org/rfc/rfc6749#section-1.1) is not authenticating with the authorization server, i.e. when authentication method is [client authentication] (https://www.rfc-editor.org/rfc/rfc6749#section-3.2.1).", - "type": "string" - }, - "code": { - "description": "Optional. The authorization code that was previously from workforce identity federation's `authorize` endpoint. Required if the flow is authorization code flow, i.e. if grant_type is 'authorization_code'", - "type": "string" - }, - "codeVerifier": { - "description": "Optional. The code verifier for the PKCE request, Google Cloud CLI originally generates it before the authorization request. PKCE is used to protect authorization code from interception attacks. See https://www.rfc-editor.org/rfc/rfc7636#section-1.1 and https://www.rfc-editor.org/rfc/rfc7636#section-3. It is required when the flow is authorization code flow, i.e. if grant_type is 'authorization_code'", - "type": "string" - }, - "grantType": { - "description": "Required. The grant types are as follows: - 'authorization_code' : an authorization code flow, i.e. exchange of authorization code for the Oauth access token - 'refresh_token' : a refresh token flow, i.e. obtain a new access token by providing the refresh token. See https://www.rfc-editor.org/rfc/rfc6749#section-6", - "type": "string" - }, - "redirectUri": { - "description": "Optional. redirect_url is required when the flow is authorization code flow i.e. if grant_type is `authorization_code` See https://www.rfc-editor.org/rfc/rfc6749#section-4.1.3", - "type": "string" - }, - "refreshToken": { - "description": "Optional. The Refresh token is the credential that is used to obtain a new access token when the current access token becomes invalid or expires. Required when using refresh token flow, i.e. if `grant_type` is 'refresh_token' See https://www.rfc-editor.org/rfc/rfc6749#section-1.5 and https://www.rfc-editor.org/rfc/rfc6749#section-6", - "type": "string" - }, - "scope": { - "description": "Optional. An optional list of scopes that are requested for the token to be returned. See https://www.rfc-editor.org/rfc/rfc6749#section-3.3 Must be a list of space-delimited, case-sensitive strings. Note: Currently, the scopes in the request are not supported", - "type": "string" - } - }, - "type": "object" - }, - "GoogleIdentityStsV1ExchangeOauthTokenResponse": { - "description": "Response message for ExchangeOauthToken. see https://www.rfc-editor.org/rfc/rfc6749#section-5.1", - "id": "GoogleIdentityStsV1ExchangeOauthTokenResponse", - "properties": { - "access_token": { - "description": "An OAuth 2.0 security token, issued by Google, in response to the Oauth token exchange request for the authorization code and refresh token flows. The returned [access token](https://www.rfc-editor.org/rfc/rfc6749#section-4.1.4). Tokens can vary in size, depending, in part, on the size of mapped claims, up to a maximum of 12288 bytes (12 KB). Google reserves the right to change the token size and the maximum length at any time.", - "type": "string" - }, - "expires_in": { - "description": "The amount of time, in seconds, between the time when the access token was issued and the time when the access token will expires.", - "format": "int32", - "type": "integer" - }, - "id_token": { - "description": "Google issued ID token in response to the OAuth token exchange request for ID token flow.", - "type": "string" - }, - "refresh_token": { - "description": "A refresh token, issued by Google, in response to the OAuth token exchange request for refresh token flow", - "type": "string" - }, - "scope": { - "description": "A list of scopes associated with the returned token.", - "type": "string" - }, - "token_type": { - "description": "The type of token. Field reserved for RFC compliance. See https://www.rfc-editor.org/rfc/rfc6749#section-5.1", - "type": "string" - } - }, - "type": "object" - }, "GoogleIdentityStsV1ExchangeTokenRequest": { "description": "Request message for ExchangeToken.", "id": "GoogleIdentityStsV1ExchangeTokenRequest", @@ -333,62 +236,6 @@ }, "type": "object" }, - "GoogleIdentityStsV1IntrospectTokenRequest": { - "description": "Request message for IntrospectToken.", - "id": "GoogleIdentityStsV1IntrospectTokenRequest", - "properties": { - "token": { - "description": "Required. The OAuth 2.0 security token issued by the Security Token Service API.", - "type": "string" - }, - "tokenTypeHint": { - "description": "Optional. The type of the given token. Supported values are `urn:ietf:params:oauth:token-type:access_token` and `access_token`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleIdentityStsV1IntrospectTokenResponse": { - "description": "Response message for IntrospectToken.", - "id": "GoogleIdentityStsV1IntrospectTokenResponse", - "properties": { - "active": { - "description": "A boolean value that indicates whether the provided access token is currently active.", - "type": "boolean" - }, - "client_id": { - "description": "The client identifier for the OAuth 2.0 client that requested the provided token.", - "type": "string" - }, - "exp": { - "description": "The expiration timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token will expire.", - "format": "int64", - "type": "string" - }, - "iat": { - "description": "The issued timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token was originally issued.", - "format": "int64", - "type": "string" - }, - "iss": { - "description": "The issuer of the provided token.", - "type": "string" - }, - "scope": { - "description": "A list of scopes associated with the provided token.", - "type": "string" - }, - "sub": { - "description": "The unique user ID associated with the provided token. For Google Accounts, this value is based on the Google Account's user ID. For federated identities, this value is based on the identity pool ID and the value of the mapped `google.subject` attribute.", - "type": "string" - }, - "username": { - "description": "The human-readable identifier for the token principal subject. For example, if the provided token is associated with a workload identity pool, this field contains a value in the following format: `principal://iam.googleapis.com/projects//locations/global/workloadIdentityPools//subject/`. If the provided token is associated with a workforce pool, this field contains a value in the following format: `principal://iam.googleapis.com/locations/global/workforcePools//subject/`.", - "type": "string" - } - }, - "type": "object" - }, "GoogleIdentityStsV1Options": { "description": "An `Options` object configures features that the Security Token Service supports, but that are not supported by standard OAuth 2.0 token exchange endpoints, as defined in https://tools.ietf.org/html/rfc8693.", "id": "GoogleIdentityStsV1Options", diff --git a/discovery/testing-v1.json b/discovery/testing-v1.json index dccde7ac4c..12bd845791 100644 --- a/discovery/testing-v1.json +++ b/discovery/testing-v1.json @@ -16,7 +16,8 @@ "batchPath": "batch", "description": "Allows developers to run automated tests for their mobile applications on Google infrastructure.", "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/cloud-test-lab/", + "documentationLink": "https://firebase.google.com/docs/test-lab/", + "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" @@ -448,7 +449,7 @@ } } }, - "revision": "20240220", + "revision": "20240319", "rootUrl": "https://testing.googleapis.com/", "schemas": { "Account": { @@ -1227,7 +1228,7 @@ "type": "array" }, "ttl": { - "description": "Optional. The amount of time that a device will be initially allocated for. This can eventually be extended with the UpdateDeviceSession RPC. Default: 30 minutes.", + "description": "Optional. The amount of time that a device will be initially allocated for. This can eventually be extended with the UpdateDeviceSession RPC. Default: 15 minutes.", "format": "google-duration", "type": "string" } diff --git a/discovery/toolresults-v1beta3.json b/discovery/toolresults-v1beta3.json index a90d063a45..26cc72b3c2 100644 --- a/discovery/toolresults-v1beta3.json +++ b/discovery/toolresults-v1beta3.json @@ -1463,7 +1463,7 @@ } } }, - "revision": "20240201", + "revision": "20240321", "rootUrl": "https://toolresults.googleapis.com/", "schemas": { "ANR": { @@ -2643,7 +2643,8 @@ "GREY_MAX_O", "GREY_MAX_P", "GREY_MAX_Q", - "GREY_MAX_R" + "GREY_MAX_R", + "GREY_MAX_S" ], "enumDescriptions": [ "", @@ -2653,6 +2654,7 @@ "", "", "", + "", "" ], "type": "string" diff --git a/discovery/workloadmanager-v1.json b/discovery/workloadmanager-v1.json index 1f7bab8cf6..1bd656d2b5 100644 --- a/discovery/workloadmanager-v1.json +++ b/discovery/workloadmanager-v1.json @@ -761,179 +761,15 @@ ] } } - }, - "workloadProfiles": { - "methods": { - "get": { - "description": "Gets details of a single workload.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadProfiles/{workloadProfilesId}", - "httpMethod": "GET", - "id": "workloadmanager.projects.locations.workloadProfiles.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Name of the resource", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/workloadProfiles/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "WorkloadProfile" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "deprecated": true, - "description": "List workloads", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadProfiles", - "httpMethod": "GET", - "id": "workloadmanager.projects.locations.workloadProfiles.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. Filtering 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 ListWorkloadRequest", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/workloadProfiles", - "response": { - "$ref": "ListWorkloadProfilesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } } } } } } }, - "revision": "20240228", + "revision": "20240306", "rootUrl": "https://workloadmanager.googleapis.com/", "schemas": { - "APILayerServer": { - "description": "The API layer server", - "id": "APILayerServer", - "properties": { - "name": { - "description": "Output only. The api layer name", - "readOnly": true, - "type": "string" - }, - "osVersion": { - "description": "Output only. OS information", - "readOnly": true, - "type": "string" - }, - "resources": { - "description": "Output only. resources in the component", - "items": { - "$ref": "CloudResource" - }, - "readOnly": true, - "type": "array" - } - }, - "type": "object" - }, - "AvailabilityGroup": { - "description": "The availability groups for sqlserver", - "id": "AvailabilityGroup", - "properties": { - "databases": { - "description": "Output only. The databases", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" - }, - "name": { - "description": "Output only. The availability group name", - "readOnly": true, - "type": "string" - }, - "primaryServer": { - "description": "Output only. The primary server", - "readOnly": true, - "type": "string" - }, - "secondaryServers": { - "description": "Output only. The secondary servers", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" - } - }, - "type": "object" - }, - "BackendServer": { - "description": "The backend server", - "id": "BackendServer", - "properties": { - "backupFile": { - "description": "Output only. The backup file", - "readOnly": true, - "type": "string" - }, - "backupSchedule": { - "description": "Output only. The backup schedule", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "Output only. The backend name", - "readOnly": true, - "type": "string" - }, - "osVersion": { - "description": "Output only. OS information", - "readOnly": true, - "type": "string" - }, - "resources": { - "description": "Output only. resources in the component", - "items": { - "$ref": "CloudResource" - }, - "readOnly": true, - "type": "array" - } - }, - "type": "object" - }, "BigQueryDestination": { "description": "Message describing big query destination", "id": "BigQueryDestination", @@ -955,98 +791,6 @@ "properties": {}, "type": "object" }, - "CloudResource": { - "description": "The resource on GCP", - "id": "CloudResource", - "properties": { - "kind": { - "description": "Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.", - "enum": [ - "RESOURCE_KIND_UNSPECIFIED", - "RESOURCE_KIND_INSTANCE", - "RESOURCE_KIND_DISK", - "RESOURCE_KIND_ADDRESS", - "RESOURCE_KIND_FILESTORE", - "RESOURCE_KIND_HEALTH_CHECK", - "RESOURCE_KIND_FORWARDING_RULE", - "RESOURCE_KIND_BACKEND_SERVICE", - "RESOURCE_KIND_SUBNETWORK", - "RESOURCE_KIND_NETWORK", - "RESOURCE_KIND_PUBLIC_ADDRESS", - "RESOURCE_KIND_INSTANCE_GROUP" - ], - "enumDescriptions": [ - "Unspecified resource kind.", - "This is a compute instance.", - "This is a compute disk.", - "This is a compute address.", - "This is a filestore instance.", - "This is a compute health check.", - "This is a compute forwarding rule.", - "This is a compute backend service.", - "This is a compute subnetwork.", - "This is a compute network.", - "This is a public accessible IP Address.", - "This is a compute instance group." - ], - "readOnly": true, - "type": "string" - }, - "name": { - "description": "Output only. resource name", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "Cluster": { - "description": "The cluster for sqlserver", - "id": "Cluster", - "properties": { - "nodes": { - "description": "Output only. The nodes", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" - }, - "witnessServer": { - "description": "Output only. The witness server", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "Database": { - "description": "The database for sqlserver", - "id": "Database", - "properties": { - "backupFile": { - "description": "Output only. The backup file", - "readOnly": true, - "type": "string" - }, - "backupSchedule": { - "description": "Output only. The backup schedule", - "readOnly": true, - "type": "string" - }, - "hostVm": { - "description": "Output only. The host VM", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "Output only. The database name", - "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", @@ -1226,31 +970,6 @@ }, "type": "object" }, - "FrontEndServer": { - "description": "The front end server", - "id": "FrontEndServer", - "properties": { - "name": { - "description": "Output only. The frontend name", - "readOnly": true, - "type": "string" - }, - "osVersion": { - "description": "Output only. OS information", - "readOnly": true, - "type": "string" - }, - "resources": { - "description": "Output only. resources in the component", - "items": { - "$ref": "CloudResource" - }, - "readOnly": true, - "type": "array" - } - }, - "type": "object" - }, "GceInstanceFilter": { "description": "Message describing compute engine instance filter", "id": "GceInstanceFilter", @@ -1294,81 +1013,6 @@ }, "type": "object" }, - "Instance": { - "description": "a vm instance", - "id": "Instance", - "properties": { - "name": { - "description": "Output only. name of the VM", - "readOnly": true, - "type": "string" - }, - "region": { - "description": "Output only. The location of the VM", - "readOnly": true, - "type": "string" - }, - "status": { - "description": "Output only. The state of the VM", - "enum": [ - "INSTANCESTATE_UNSPECIFIED", - "PROVISIONING", - "STAGING", - "RUNNING", - "STOPPING", - "STOPPED", - "TERMINATED", - "SUSPENDING", - "SUSPENDED", - "REPAIRING", - "DEPROVISIONING" - ], - "enumDescriptions": [ - "The Status of the VM is unspecified", - "Resources are being allocated for the instance.", - "All required resources have been allocated and the instance is being started.", - "The instance is running.", - "The instance is currently stopping (either being deleted or killed).", - "The instance has stopped due to various reasons (user request, VM preemption, project freezing, etc.).", - "The instance has failed in some way.", - "The instance is suspending.", - "The instance is suspended.", - "The instance is in repair.", - "The instance is in de-provisioning state." - ], - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "Layer": { - "description": "The database layer", - "id": "Layer", - "properties": { - "applicationType": { - "description": "the application layer", - "type": "string" - }, - "databaseType": { - "description": "Optional. the database layer", - "type": "string" - }, - "instances": { - "description": "Optional. instances in a layer", - "items": { - "$ref": "Instance" - }, - "type": "array" - }, - "sid": { - "description": "Output only. system identification of a layer", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, "ListEvaluationsResponse": { "description": "Message for response to listing Evaluations", "id": "ListEvaluationsResponse", @@ -1509,50 +1153,6 @@ }, "type": "object" }, - "ListWorkloadProfilesResponse": { - "description": "List workloadResponse returns a response with the list of workload overview", - "id": "ListWorkloadProfilesResponse", - "properties": { - "nextPageToken": { - "description": "Output only. A token identifying a page of results the server should return", - "readOnly": true, - "type": "string" - }, - "unreachable": { - "description": "Locations that could not be reached.", - "items": { - "type": "string" - }, - "type": "array" - }, - "workloadOverviews": { - "description": "Output only. The list of Workload Overview", - "items": { - "$ref": "WorkloadProfileOverview" - }, - "readOnly": true, - "type": "array" - } - }, - "type": "object" - }, - "LoadBalancerServer": { - "description": "The load balancer for sqlserver", - "id": "LoadBalancerServer", - "properties": { - "ip": { - "description": "Output only. The IP address", - "readOnly": true, - "type": "string" - }, - "vm": { - "description": "Output only. The VM name", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, "Location": { "description": "A resource that represents a Google Cloud location.", "id": "Location", @@ -1822,47 +1422,6 @@ }, "type": "object" }, - "SapComponent": { - "description": "The component of sap workload", - "id": "SapComponent", - "properties": { - "haHosts": { - "description": "A list of host URIs that are part of the HA configuration if present. An empty list indicates the component is not configured for HA.", - "items": { - "type": "string" - }, - "type": "array" - }, - "resources": { - "description": "Output only. resources in the component", - "items": { - "$ref": "CloudResource" - }, - "readOnly": true, - "type": "array" - }, - "sid": { - "description": "Output only. sid is the sap component identificator", - "readOnly": true, - "type": "string" - }, - "topologyType": { - "description": "The detected topology of the component.", - "enum": [ - "TOPOLOGY_TYPE_UNSPECIFIED", - "TOPOLOGY_SCALE_UP", - "TOPOLOGY_SCALE_OUT" - ], - "enumDescriptions": [ - "Unspecified topology.", - "A scale-up single node system.", - "A scale-out multi-node system." - ], - "type": "string" - } - }, - "type": "object" - }, "SapDiscovery": { "description": "The schema of SAP system discovery data.", "id": "SapDiscovery", @@ -1975,6 +1534,10 @@ "description": "Optional. Resource URI of the recognized ASCS host of the application.", "type": "string" }, + "instanceNumber": { + "description": "Optional. Instance number of the SAP instance.", + "type": "string" + }, "kernelVersion": { "description": "Optional. Kernel version for Netweaver running in the system.", "type": "string" @@ -2010,6 +1573,10 @@ "description": "Optional. The version of the database software running in the system.", "type": "string" }, + "instanceNumber": { + "description": "Optional. Instance number of the SAP instance.", + "type": "string" + }, "primaryInstanceUri": { "description": "Required. URI of the recognized primary instance of the database.", "type": "string" @@ -2260,53 +1827,6 @@ }, "type": "object" }, - "SapWorkload": { - "description": "The body of sap workload", - "id": "SapWorkload", - "properties": { - "application": { - "$ref": "SapComponent", - "description": "Output only. the acsc componment", - "readOnly": true - }, - "database": { - "$ref": "SapComponent", - "description": "Output only. the database componment", - "readOnly": true - }, - "metadata": { - "additionalProperties": { - "type": "string" - }, - "description": "Output only. The metadata for SAP workload.", - "readOnly": true, - "type": "object" - } - }, - "type": "object" - }, - "SapWorkloadOverview": { - "description": "The overview of sap workload", - "id": "SapWorkloadOverview", - "properties": { - "appSid": { - "description": "Output only. The application SID", - "readOnly": true, - "type": "string" - }, - "dbSid": { - "description": "Output only. The database SID", - "readOnly": true, - "type": "string" - }, - "sapSystemId": { - "description": "Output only. The UUID for a SAP workload", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, "ScannedResource": { "description": "Message of scanned resource", "id": "ScannedResource", @@ -2410,59 +1930,6 @@ }, "type": "object" }, - "SqlserverWorkload": { - "description": "The body of sqlserver workload", - "id": "SqlserverWorkload", - "properties": { - "ags": { - "description": "Output only. The availability groups for sqlserver", - "items": { - "$ref": "AvailabilityGroup" - }, - "readOnly": true, - "type": "array" - }, - "cluster": { - "$ref": "Cluster", - "description": "Output only. The cluster for sqlserver", - "readOnly": true - }, - "databases": { - "description": "Output only. The databases for sqlserver", - "items": { - "$ref": "Database" - }, - "readOnly": true, - "type": "array" - }, - "loadBalancerServer": { - "$ref": "LoadBalancerServer", - "description": "Output only. The load balancer for sqlserver", - "readOnly": true - } - }, - "type": "object" - }, - "SqlserverWorkloadOverview": { - "description": "The overview of sqlserver workload", - "id": "SqlserverWorkloadOverview", - "properties": { - "availabilityGroup": { - "description": "Output only. The availability groups", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" - }, - "sqlserverSystemId": { - "description": "Output only. The UUID for a Sqlserver workload", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, "Status": { "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", @@ -2490,45 +1957,6 @@ }, "type": "object" }, - "ThreeTierWorkload": { - "description": "The body of three tier workload", - "id": "ThreeTierWorkload", - "properties": { - "apiLayer": { - "$ref": "APILayerServer", - "description": "Output only. The API layer for three tier workload", - "readOnly": true - }, - "backend": { - "$ref": "BackendServer", - "description": "Output only. The backend for three tier workload", - "readOnly": true - }, - "endpoint": { - "description": "Output only. the workload endpoint", - "readOnly": true, - "type": "string" - }, - "frontend": { - "$ref": "FrontEndServer", - "description": "Output only. The frontend for three tier workload", - "readOnly": true - } - }, - "type": "object" - }, - "ThreeTierWorkloadOverview": { - "description": "The overview of three tier workload", - "id": "ThreeTierWorkloadOverview", - "properties": { - "threeTierSystemId": { - "description": "Output only. The UUID for a three tier workload", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, "ViolationDetails": { "description": "Message describing the violdation in execution result", "id": "ViolationDetails", @@ -2551,115 +1979,14 @@ }, "type": "object" }, - "WorkloadProfile": { - "description": "workload resource", - "id": "WorkloadProfile", - "properties": { - "application": { - "$ref": "Layer", - "deprecated": true, - "description": "Optional. The application layer" - }, - "ascs": { - "$ref": "Layer", - "deprecated": true, - "description": "Optional. The ascs layer" - }, - "database": { - "$ref": "Layer", - "deprecated": true, - "description": "Optional. The database layer" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. such as name, description, version. More example can be found in deployment", - "type": "object" - }, - "name": { - "description": "Identifier. name of resource names have the form 'projects/{project_id}/workloads/{workload_id}'", - "type": "string" - }, - "refreshedTime": { - "description": "Required. time when the workload data was refreshed", - "format": "google-datetime", - "type": "string" - }, - "sapWorkload": { - "$ref": "SapWorkload", - "description": "The sap workload content" - }, - "sqlserverWorkload": { - "$ref": "SqlserverWorkload", - "description": "The sqlserver workload content" - }, - "state": { - "deprecated": true, - "description": "Output only. [output only] the current state if a a workload", - "enum": [ - "STATE_UNSPECIFIED", - "ACTIVE", - "DEPLOYING", - "DESTROYING", - "MAINTENANCE" - ], - "enumDescriptions": [ - "unspecified", - "ACTIVE state", - "workload is in Deploying state", - "The workload is in Destroying state", - "The Workload is undermaintance" - ], - "readOnly": true, - "type": "string" - }, - "threeTierWorkload": { - "$ref": "ThreeTierWorkload", - "description": "The 3 tier web app workload content" - }, - "workloadType": { - "description": "Required. The type of the workload", - "enum": [ - "WORKLOAD_TYPE_UNSPECIFIED", - "S4_HANA", - "SQL_SERVER", - "THREE_TIER_WEB_APP" - ], - "enumDescriptions": [ - "unspecified workload type", - "running sap workload s4/hana", - "running sqlserver workload", - "running 3 tier web app workload" - ], - "type": "string" - } - }, - "type": "object" - }, - "WorkloadProfileOverview": { - "description": "a workload profile overview", - "id": "WorkloadProfileOverview", - "properties": { - "sapWorkloadOverview": { - "$ref": "SapWorkloadOverview", - "description": "The sap workload overview" - }, - "sqlserverWorkloadOverview": { - "$ref": "SqlserverWorkloadOverview", - "description": "The sqlserver workload overview" - }, - "threeTierWorkloadOverview": { - "$ref": "ThreeTierWorkloadOverview", - "description": "The three tier workload overview" - } - }, - "type": "object" - }, "WriteInsightRequest": { "description": "Request for sending the data insights.", "id": "WriteInsightRequest", "properties": { + "agentVersion": { + "description": "Optional. The agent version collected this data point.", + "type": "string" + }, "insight": { "$ref": "Insight", "description": "Required. The metrics data details." diff --git a/src/apis/adsense/v2.ts b/src/apis/adsense/v2.ts index ee4deaae28..77e8165117 100644 --- a/src/apis/adsense/v2.ts +++ b/src/apis/adsense/v2.ts @@ -1370,7 +1370,7 @@ export namespace adsense_v2 { } /** - * Creates an ad unit. This method can only be used by projects enabled for the [AdSense for Platforms](https://developers.google.com/adsense/platforms/) product. Note that ad units can only be created for ad clients with an "AFC" product code. For more info see the [AdClient resource](/adsense/management/reference/rest/v2/accounts.adclients). For now, this method can only be used to create `DISPLAY` ad units. See: https://support.google.com/adsense/answer/9183566 + * Creates an ad unit. This method can be called only by a restricted set of projects, which are usually owned by [AdSense for Platforms](https://developers.google.com/adsense/platforms/) publishers. Contact your account manager if you need to use this method. Note that ad units can only be created for ad clients with an "AFC" product code. For more info see the [AdClient resource](/adsense/management/reference/rest/v2/accounts.adclients). For now, this method can only be used to create `DISPLAY` ad units. See: https://support.google.com/adsense/answer/9183566 * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1812,7 +1812,7 @@ export namespace adsense_v2 { } /** - * Updates an ad unit. This method can only be used by projects enabled for the [AdSense for Platforms](https://developers.google.com/adsense/platforms/) product. For now, this method can only be used to update `DISPLAY` ad units. See: https://support.google.com/adsense/answer/9183566 + * Updates an ad unit. This method can be called only by a restricted set of projects, which are usually owned by [AdSense for Platforms](https://developers.google.com/adsense/platforms/) publishers. Contact your account manager if you need to use this method. For now, this method can only be used to update `DISPLAY` ad units. See: https://support.google.com/adsense/answer/9183566 * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1976,7 +1976,7 @@ export namespace adsense_v2 { } /** - * Creates a custom channel. This method can only be used by projects enabled for the [AdSense for Platforms](https://developers.google.com/adsense/platforms/) product. + * Creates a custom channel. This method can be called only by a restricted set of projects, which are usually owned by [AdSense for Platforms](https://developers.google.com/adsense/platforms/) publishers. Contact your account manager if you need to use this method. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2063,7 +2063,7 @@ export namespace adsense_v2 { } /** - * Deletes a custom channel. This method can only be used by projects enabled for the [AdSense for Platforms](https://developers.google.com/adsense/platforms/) product. + * Deletes a custom channel. This method can be called only by a restricted set of projects, which are usually owned by [AdSense for Platforms](https://developers.google.com/adsense/platforms/) publishers. Contact your account manager if you need to use this method. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2420,7 +2420,7 @@ export namespace adsense_v2 { } /** - * Updates a custom channel. This method can only be used by projects enabled for the [AdSense for Platforms](https://developers.google.com/adsense/platforms/) product. + * Updates a custom channel. This method can be called only by a restricted set of projects, which are usually owned by [AdSense for Platforms](https://developers.google.com/adsense/platforms/) publishers. Contact your account manager if you need to use this method. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/aiplatform/v1.ts b/src/apis/aiplatform/v1.ts index 03b6527ce7..87cb2c0dff 100644 --- a/src/apis/aiplatform/v1.ts +++ b/src/apis/aiplatform/v1.ts @@ -2057,6 +2057,19 @@ export namespace aiplatform_v1 { */ genericMetadata?: Schema$GoogleCloudAiplatformV1GenericOperationMetadata; } + /** + * Details of operations that perform create PersistentResource. + */ + export interface Schema$GoogleCloudAiplatformV1CreatePersistentResourceOperationMetadata { + /** + * Operation metadata for PersistentResource. + */ + genericMetadata?: Schema$GoogleCloudAiplatformV1GenericOperationMetadata; + /** + * Progress Message for Create LRO + */ + progressMessage?: string | null; + } /** * Request message for PipelineService.CreatePipelineJob. */ @@ -2238,6 +2251,10 @@ export namespace aiplatform_v1 { * Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project\}/global/networks/{network\}`. Where {project\} is a project number, as in `12345`, and {network\} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network. */ network?: string | null; + /** + * Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected. + */ + persistentResourceId?: string | null; /** * The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations */ @@ -2988,10 +3005,6 @@ export namespace aiplatform_v1 { * Configures the request-response logging for online prediction. */ predictRequestResponseLoggingConfig?: Schema$GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig; - /** - * Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive. - */ - privateServiceConnectConfig?: Schema$GoogleCloudAiplatformV1PrivateServiceConnectConfig; /** * A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment. */ @@ -4426,6 +4439,10 @@ export namespace aiplatform_v1 { * Response message for FeatureOnlineStoreService.FetchFeatureValues */ export interface Schema$GoogleCloudAiplatformV1FetchFeatureValuesResponse { + /** + * The data key associated with this response. Will only be populated for FeatureOnlineStoreService.StreamingFetchFeatureValues RPCs. + */ + dataKey?: Schema$GoogleCloudAiplatformV1FeatureViewDataKey; /** * Feature values in KeyValue format. */ @@ -4603,11 +4620,11 @@ export namespace aiplatform_v1 { */ description?: string | null; /** - * Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. + * Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64. */ name?: string | null; /** - * Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + * Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 */ parameters?: Schema$GoogleCloudAiplatformV1Schema; } @@ -4766,6 +4783,15 @@ export namespace aiplatform_v1 { */ baseModelUri?: string | null; } + /** + * Tool to retrieve public web data for grounding, powered by Google. + */ + export interface Schema$GoogleCloudAiplatformV1GoogleSearchRetrieval { + /** + * Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + */ + disableAttribution?: boolean | null; + } /** * Grounding attribution. */ @@ -5813,6 +5839,16 @@ export namespace aiplatform_v1 { */ optimalTrials?: Schema$GoogleCloudAiplatformV1Trial[]; } + /** + * Response message for PersistentResourceService.ListPersistentResources + */ + export interface Schema$GoogleCloudAiplatformV1ListPersistentResourcesResponse { + /** + * A token to retrieve next page of results. Pass to ListPersistentResourcesRequest.page_token to obtain that page. + */ + nextPageToken?: string | null; + persistentResources?: Schema$GoogleCloudAiplatformV1PersistentResource[]; + } /** * Response message for PipelineService.ListPipelineJobs */ @@ -7808,6 +7844,67 @@ export namespace aiplatform_v1 { */ diskType?: string | null; } + /** + * Represents long-lasting resources that are dedicated to users to runs custom workloads. A PersistentResource can have multiple node pools and each node pool can have its own machine spec. + */ + export interface Schema$GoogleCloudAiplatformV1PersistentResource { + /** + * Output only. Time when the PersistentResource was created. + */ + createTime?: string | null; + /** + * Optional. The display name of the PersistentResource. The name can be up to 128 characters long and can consist of any UTF-8 characters. + */ + displayName?: string | null; + /** + * Optional. Customer-managed encryption key spec for a PersistentResource. If set, this PersistentResource and all sub-resources of this PersistentResource will be secured by this key. + */ + encryptionSpec?: Schema$GoogleCloudAiplatformV1EncryptionSpec; + /** + * Output only. Only populated when persistent resource's state is `STOPPING` or `ERROR`. + */ + error?: Schema$GoogleRpcStatus; + /** + * Optional. The labels with user-defined metadata to organize PersistentResource. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. + */ + labels?: {[key: string]: string} | null; + /** + * Immutable. Resource name of a PersistentResource. + */ + name?: string | null; + /** + * Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project\}/global/networks/{network\}`. Where {project\} is a project number, as in `12345`, and {network\} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network. + */ + network?: string | null; + /** + * Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. + */ + reservedIpRanges?: string[] | null; + /** + * Required. The spec of the pools of different resources. + */ + resourcePools?: Schema$GoogleCloudAiplatformV1ResourcePool[]; + /** + * Output only. Runtime information of the Persistent Resource. + */ + resourceRuntime?: Schema$GoogleCloudAiplatformV1ResourceRuntime; + /** + * Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration. + */ + resourceRuntimeSpec?: Schema$GoogleCloudAiplatformV1ResourceRuntimeSpec; + /** + * Output only. Time when the PersistentResource for the first time entered the `RUNNING` state. + */ + startTime?: string | null; + /** + * Output only. The detailed state of a Study. + */ + state?: string | null; + /** + * Output only. Time when the PersistentResource was most recently updated. + */ + updateTime?: string | null; + } /** * An instance of a machine learning PipelineJob. */ @@ -8332,6 +8429,10 @@ export namespace aiplatform_v1 { * Optional. Deploy PublisherModel to Google Kubernetes Engine. */ deployGke?: Schema$GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke; + /** + * Optional. Multiple setups to deploy the PublisherModel to Vertex Endpoint. + */ + multiDeployVertex?: Schema$GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex; /** * Optional. Open evaluation pipeline of the PublisherModel. */ @@ -8423,6 +8524,15 @@ export namespace aiplatform_v1 { */ gkeYamlConfigs?: string[] | null; } + /** + * Multiple setups to deploy the PublisherModel. + */ + export interface Schema$GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex { + /** + * Optional. One click deployment configurations. + */ + multiDeployVertex?: Schema$GoogleCloudAiplatformV1PublisherModelCallToActionDeploy[]; + } /** * Open fine tuning pipelines. */ @@ -8681,6 +8791,36 @@ export namespace aiplatform_v1 { */ httpBody?: Schema$GoogleApiHttpBody; } + /** + * Configuration for the Ray metrics. + */ + export interface Schema$GoogleCloudAiplatformV1RayMetricSpec { + /** + * Optional. Flag to disable the Ray metrics collection. + */ + disabled?: boolean | null; + } + /** + * Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes. + */ + export interface Schema$GoogleCloudAiplatformV1RaySpec { + /** + * Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set. + */ + headNodeResourcePoolId?: string | null; + /** + * Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images\} field. + */ + imageUri?: string | null; + /** + * Optional. Ray metrics configurations. + */ + rayMetricSpec?: Schema$GoogleCloudAiplatformV1RayMetricSpec; + /** + * Optional. Required if image_uri isn't set. A map of resource_pool_id to prebuild Ray image if user need to use different images for different head/worker pools. This map needs to cover all the resource pool ids. Example: { "ray_head_node_pool": "head image" "ray_worker_node_pool1": "worker image" "ray_worker_node_pool2": "another worker image" \} + */ + resourcePoolImages?: {[key: string]: string} | null; + } /** * Request message for FeaturestoreOnlineServingService.ReadFeatureValues. */ @@ -8839,6 +8979,23 @@ export namespace aiplatform_v1 { */ viewCount?: string | null; } + /** + * Details of operations that perform reboot PersistentResource. + */ + export interface Schema$GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata { + /** + * Operation metadata for PersistentResource. + */ + genericMetadata?: Schema$GoogleCloudAiplatformV1GenericOperationMetadata; + /** + * Progress Message for Reboot LRO + */ + progressMessage?: string | null; + } + /** + * Request message for PersistentResourceService.RebootPersistentResource. + */ + export interface Schema$GoogleCloudAiplatformV1RebootPersistentResourceRequest {} /** * Request message for MetadataService.DeleteContextChildrenRequest. */ @@ -8865,6 +9022,74 @@ export namespace aiplatform_v1 { * Response message for IndexService.RemoveDatapoints */ export interface Schema$GoogleCloudAiplatformV1RemoveDatapointsResponse {} + /** + * Represents the spec of a group of resources of the same type, for example machine type, disk, and accelerators, in a PersistentResource. + */ + export interface Schema$GoogleCloudAiplatformV1ResourcePool { + /** + * Optional. Optional spec to configure GKE autoscaling + */ + autoscalingSpec?: Schema$GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec; + /** + * Optional. Disk spec for the machine in this node pool. + */ + diskSpec?: Schema$GoogleCloudAiplatformV1DiskSpec; + /** + * Immutable. The unique ID in a PersistentResource for referring to this resource pool. User can specify it if necessary. Otherwise, it's generated automatically. + */ + id?: string | null; + /** + * Required. Immutable. The specification of a single machine. + */ + machineSpec?: Schema$GoogleCloudAiplatformV1MachineSpec; + /** + * Optional. The total number of machines to use for this resource pool. + */ + replicaCount?: string | null; + /** + * Output only. The number of machines currently in use by training jobs for this resource pool. Will replace idle_replica_count. + */ + usedReplicaCount?: string | null; + } + /** + * The min/max number of replicas allowed if enabling autoscaling + */ + export interface Schema$GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec { + /** + * Optional. max replicas in the node pool, must be ≥ replica_count and \> min_replica_count or will throw error + */ + maxReplicaCount?: string | null; + /** + * Optional. min replicas in the node pool, must be ≤ replica_count and < max_replica_count or will throw error + */ + minReplicaCount?: string | null; + } + /** + * Persistent Cluster runtime information as output + */ + export interface Schema$GoogleCloudAiplatformV1ResourceRuntime { + /** + * Output only. URIs for user to connect to the Cluster. Example: { "RAY_HEAD_NODE_INTERNAL_IP": "head-node-IP:10001" "RAY_DASHBOARD_URI": "ray-dashboard-address:8888" \} + */ + accessUris?: {[key: string]: string} | null; + /** + * Output only. The resource name of NotebookRuntimeTemplate for the RoV Persistent Cluster The NotebokRuntimeTemplate is created in the same VPC (if set), and with the same Ray and Python version as the Persistent Cluster. Example: "projects/1000/locations/us-central1/notebookRuntimeTemplates/abc123" + */ + notebookRuntimeTemplate?: string | null; + } + /** + * Configuration for the runtime on a PersistentResource instance, including but not limited to: * Service accounts used to run the workloads. * Whether to make it a dedicated Ray Cluster. + */ + export interface Schema$GoogleCloudAiplatformV1ResourceRuntimeSpec { + /** + * Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. + */ + raySpec?: Schema$GoogleCloudAiplatformV1RaySpec; + /** + * Optional. Configure the use of workload identity on the PersistentResource + */ + serviceAccountSpec?: Schema$GoogleCloudAiplatformV1ServiceAccountSpec; + } /** * Statistics information about resource consumption. */ @@ -8896,6 +9121,19 @@ export namespace aiplatform_v1 { */ catchUp?: boolean | null; } + /** + * Defines a retrieval tool that model can call to access external knowledge. + */ + export interface Schema$GoogleCloudAiplatformV1Retrieval { + /** + * Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + */ + disableAttribution?: boolean | null; + /** + * Set to use data source powered by Vertex AI Search. + */ + vertexAiSearch?: Schema$GoogleCloudAiplatformV1VertexAISearch; + } /** * Safety rating corresponding to the generated content. */ @@ -8933,6 +9171,10 @@ export namespace aiplatform_v1 { * Required. Harm category. */ category?: string | null; + /** + * Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. + */ + method?: string | null; /** * Required. The harm block threshold. */ @@ -9147,6 +9389,10 @@ export namespace aiplatform_v1 { * Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed. */ export interface Schema$GoogleCloudAiplatformV1Schema { + /** + * Optional. Default value of the data. + */ + default?: any | null; /** * Optional. The description of the data. */ @@ -9160,25 +9406,65 @@ export namespace aiplatform_v1 { */ example?: any | null; /** - * Optional. The format of the data. Supported formats: for NUMBER type: float, double for INTEGER type: int32, int64 + * Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc */ format?: string | null; /** - * Optional. Schema of the elements of Type.ARRAY. + * Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. */ items?: Schema$GoogleCloudAiplatformV1Schema; + /** + * Optional. Maximum value of the Type.INTEGER and Type.NUMBER + */ + maximum?: number | null; + /** + * Optional. Maximum number of the elements for Type.ARRAY. + */ + maxItems?: string | null; + /** + * Optional. Maximum length of the Type.STRING + */ + maxLength?: string | null; + /** + * Optional. Maximum number of the properties for Type.OBJECT. + */ + maxProperties?: string | null; + /** + * Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + */ + minimum?: number | null; + /** + * Optional. Minimum number of the elements for Type.ARRAY. + */ + minItems?: string | null; + /** + * Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + */ + minLength?: string | null; + /** + * Optional. Minimum number of the properties for Type.OBJECT. + */ + minProperties?: string | null; /** * Optional. Indicates if the value may be null. */ nullable?: boolean | null; /** - * Optional. Properties of Type.OBJECT. + * Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + */ + pattern?: string | null; + /** + * Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. */ properties?: {[key: string]: Schema$GoogleCloudAiplatformV1Schema} | null; /** * Optional. Required properties of Type.OBJECT. */ required?: string[] | null; + /** + * Optional. The title of the Schema. + */ + title?: string | null; /** * Optional. The type of the data. */ @@ -11871,6 +12157,19 @@ export namespace aiplatform_v1 { */ startIndex?: number | null; } + /** + * Configuration for the use of custom service account to run the workloads. + */ + export interface Schema$GoogleCloudAiplatformV1ServiceAccountSpec { + /** + * Required. If true, custom user-managed service account is enforced to run any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + */ + enableCustomServiceAccount?: boolean | null; + /** + * Optional. Default service account that this PersistentResource's workloads run as. The workloads include: * Any runtime specified via `ResourceRuntimeSpec` on creation time, for example, Ray. * Jobs submitted to PersistentResource, if no other service account specified in the job specs. Only works when custom service account is enabled and users have the `iam.serviceAccounts.actAs` permission on this service account. Required if any containers are specified in `ResourceRuntimeSpec`. + */ + serviceAccount?: string | null; + } /** * A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). */ @@ -12802,6 +13101,14 @@ export namespace aiplatform_v1 { * Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 64 function declarations can be provided. */ functionDeclarations?: Schema$GoogleCloudAiplatformV1FunctionDeclaration[]; + /** + * Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + */ + googleSearchRetrieval?: Schema$GoogleCloudAiplatformV1GoogleSearchRetrieval; + /** + * Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + */ + retrieval?: Schema$GoogleCloudAiplatformV1Retrieval; } /** * CMLE training config. For every active learning labeling iteration, system will train a machine learning model on CMLE. The trained model will be used by data sampling algorithm to select DataItems. @@ -13127,6 +13434,19 @@ export namespace aiplatform_v1 { */ genericMetadata?: Schema$GoogleCloudAiplatformV1GenericOperationMetadata; } + /** + * Details of operations that perform update PersistentResource. + */ + export interface Schema$GoogleCloudAiplatformV1UpdatePersistentResourceOperationMetadata { + /** + * Operation metadata for PersistentResource. + */ + genericMetadata?: Schema$GoogleCloudAiplatformV1GenericOperationMetadata; + /** + * Progress Message for Update LRO + */ + progressMessage?: string | null; + } /** * Runtime operation metadata for SpecialistPoolService.UpdateSpecialistPool. */ @@ -13260,6 +13580,15 @@ export namespace aiplatform_v1 { */ stringValue?: string | null; } + /** + * Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation + */ + export interface Schema$GoogleCloudAiplatformV1VertexAISearch { + /** + * Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{dataStore\} + */ + datastore?: string | null; + } /** * Metadata describes the input video content. */ @@ -14047,7 +14376,7 @@ export namespace aiplatform_v1 { } export interface Schema$LearningGenaiRootGroundingMetadataCitation { /** - * Index in the prediction output where the citation ends (exclusive). Must be \> start_index and < len(output). + * Index in the prediction output where the citation ends (exclusive). Must be \> start_index and <= len(output). */ endIndex?: number | null; /** @@ -14561,6 +14890,7 @@ export namespace aiplatform_v1 { notebookRuntimes: Resource$Projects$Locations$Notebookruntimes; notebookRuntimeTemplates: Resource$Projects$Locations$Notebookruntimetemplates; operations: Resource$Projects$Locations$Operations; + persistentResources: Resource$Projects$Locations$Persistentresources; pipelineJobs: Resource$Projects$Locations$Pipelinejobs; publishers: Resource$Projects$Locations$Publishers; schedules: Resource$Projects$Locations$Schedules; @@ -14616,6 +14946,8 @@ export namespace aiplatform_v1 { this.operations = new Resource$Projects$Locations$Operations( this.context ); + this.persistentResources = + new Resource$Projects$Locations$Persistentresources(this.context); this.pipelineJobs = new Resource$Projects$Locations$Pipelinejobs( this.context ); @@ -25178,7 +25510,7 @@ export namespace aiplatform_v1 { export interface Params$Resource$Projects$Locations$Endpoints$List extends StandardParameters { /** - * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports = and !=. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports = and, != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `base_model_name` only supports = Some examples: * `endpoint=1` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"` + * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports `=` and `!=`. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports `=` and `!=`. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:*` or `labels:key` - key existence * A key including a space must be quoted. `labels."a key"`. * `base_model_name` only supports `=`. Some examples: * `endpoint=1` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"` */ filter?: string; /** @@ -51381,7 +51713,7 @@ export namespace aiplatform_v1 { export interface Params$Resource$Projects$Locations$Notebookruntimes$List extends StandardParameters { /** - * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * `notebookRuntime="notebookRuntime123"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` * `notebookRuntimeTemplate="notebookRuntimeTemplate321"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser="test@google.com"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` + * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * `notebookRuntime="notebookRuntime123"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` * `notebookRuntimeTemplate="notebookRuntimeTemplate321"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser="test@google.com"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` */ filter?: string; /** @@ -51706,112 +52038,1295 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists NotebookRuntimeTemplates in a Location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Notebookruntimetemplates$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notebookruntimetemplates$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/notebookRuntimeTemplates').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Create + extends StandardParameters { + /** + * Optional. User specified ID for the notebook runtime template. + */ + notebookRuntimeTemplateId?: string; + /** + * Required. The resource name of the Location to create the NotebookRuntimeTemplate. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1NotebookRuntimeTemplate; + } + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete + extends StandardParameters { + /** + * Required. The name of the NotebookRuntimeTemplate resource to be deleted. Format: `projects/{project\}/locations/{location\}/notebookRuntimeTemplates/{notebook_runtime_template\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Get + extends StandardParameters { + /** + * Required. The name of the NotebookRuntimeTemplate resource. Format: `projects/{project\}/locations/{location\}/notebookRuntimeTemplates/{notebook_runtime_template\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$List + extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `notebookRuntimeType=USER_DEFINED` + */ + filter?: string; + /** + * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. + */ + orderBy?: string; + /** + * Optional. The standard list page size. + */ + pageSize?: number; + /** + * Optional. The standard list page token. Typically obtained via ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location from which to list the NotebookRuntimeTemplates. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Optional. Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions + extends StandardParameters { + /** + * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + */ + permissions?: string[]; + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + + export class Resource$Projects$Locations$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`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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 + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + 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 + | GaxiosPromise + | GaxiosPromise { + 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://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + 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`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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 + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + 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 + | GaxiosPromise + | GaxiosPromise { + 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://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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 + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + 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 + | GaxiosPromise + | GaxiosPromise { + 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://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + 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`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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 + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + 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 + | GaxiosPromise + | GaxiosPromise { + 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://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + wait( + params: Params$Resource$Projects$Locations$Operations$Wait, + options: StreamMethodOptions + ): GaxiosPromise; + wait( + params?: Params$Resource$Projects$Locations$Operations$Wait, + options?: MethodOptions + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$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; + } + export interface Params$Resource$Projects$Locations$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Persistentresources { + context: APIRequestContext; + operations: Resource$Projects$Locations$Persistentresources$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Persistentresources$Operations( + this.context + ); + } + + /** + * Creates a PersistentResource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Persistentresources$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Persistentresources$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Persistentresources$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Persistentresources$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Persistentresources$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Persistentresources$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Persistentresources$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Persistentresources$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/persistentResources').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a PersistentResource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Persistentresources$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Persistentresources$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Persistentresources$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Persistentresources$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Persistentresources$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Persistentresources$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Persistentresources$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Persistentresources$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a PersistentResource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Persistentresources$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Persistentresources$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Persistentresources$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Persistentresources$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Persistentresources$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Persistentresources$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Persistentresources$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Persistentresources$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy( - callback: BodyResponseCallback - ): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Lists NotebookRuntimeTemplates in a Location. + * Lists PersistentResources in a Location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -51819,57 +53334,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, + params: Params$Resource$Projects$Locations$Persistentresources$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, + params?: Params$Resource$Projects$Locations$Persistentresources$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, + params: Params$Resource$Projects$Locations$Persistentresources$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, + params: Params$Resource$Projects$Locations$Persistentresources$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Persistentresources$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Persistentresources$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$List; + {}) as Params$Resource$Projects$Locations$Persistentresources$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$List; + {} as Params$Resource$Projects$Locations$Persistentresources$List; options = {}; } @@ -51882,7 +53397,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/notebookRuntimeTemplates').replace( + url: (rootUrl + '/v1/{+parent}/persistentResources').replace( /([^:]\/)\/+/g, '$1' ), @@ -51896,75 +53411,77 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Updates a PersistentResource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, + patch( + params: Params$Resource$Projects$Locations$Persistentresources$Patch, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, + patch( + params?: Params$Resource$Projects$Locations$Persistentresources$Patch, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Persistentresources$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Persistentresources$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Persistentresources$Patch, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - setIamPolicy( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Persistentresources$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Persistentresources$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy; + {} as Params$Resource$Projects$Locations$Persistentresources$Patch; options = {}; } @@ -51977,89 +53494,86 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Reboots a PersistentResource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, + reboot( + params: Params$Resource$Projects$Locations$Persistentresources$Reboot, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, + reboot( + params?: Params$Resource$Projects$Locations$Persistentresources$Reboot, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, + ): GaxiosPromise; + reboot( + params: Params$Resource$Projects$Locations$Persistentresources$Reboot, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, + reboot( + params: Params$Resource$Projects$Locations$Persistentresources$Reboot, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, - callback: BodyResponseCallback + reboot( + params: Params$Resource$Projects$Locations$Persistentresources$Reboot, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + reboot( + callback: BodyResponseCallback ): void; - testIamPermissions( + reboot( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Persistentresources$Reboot + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Persistentresources$Reboot; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions; + {} as Params$Resource$Projects$Locations$Persistentresources$Reboot; options = {}; } @@ -52072,125 +53586,102 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:reboot').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Create + export interface Params$Resource$Projects$Locations$Persistentresources$Create extends StandardParameters { /** - * Optional. User specified ID for the notebook runtime template. + * Required. The resource name of the Location to create the PersistentResource in. Format: `projects/{project\}/locations/{location\}` */ - notebookRuntimeTemplateId?: string; + parent?: string; /** - * Required. The resource name of the Location to create the NotebookRuntimeTemplate. Format: `projects/{project\}/locations/{location\}` + * Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$/`. */ - parent?: string; + persistentResourceId?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1NotebookRuntimeTemplate; + requestBody?: Schema$GoogleCloudAiplatformV1PersistentResource; } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete + export interface Params$Resource$Projects$Locations$Persistentresources$Delete extends StandardParameters { /** - * Required. The name of the NotebookRuntimeTemplate resource to be deleted. Format: `projects/{project\}/locations/{location\}/notebookRuntimeTemplates/{notebook_runtime_template\}` + * Required. The name of the PersistentResource to be deleted. Format: `projects/{project\}/locations/{location\}/persistentResources/{persistent_resource\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Get + export interface Params$Resource$Projects$Locations$Persistentresources$Get extends StandardParameters { /** - * Required. The name of the NotebookRuntimeTemplate resource. Format: `projects/{project\}/locations/{location\}/notebookRuntimeTemplates/{notebook_runtime_template\}` + * Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number\}/locations/{location_id\}/persistentResources/{persistent_resource_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$List + export interface Params$Resource$Projects$Locations$Persistentresources$List extends StandardParameters { - /** - * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `notebookRuntimeType=USER_DEFINED` - */ - filter?: string; - /** - * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. - */ - orderBy?: string; /** * Optional. The standard list page size. */ pageSize?: number; /** - * Optional. The standard list page token. Typically obtained via ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates call. + * Optional. The standard list page token. Typically obtained via ListPersistentResourceResponse.next_page_token of the previous PersistentResourceService.ListPersistentResource call. */ pageToken?: string; /** - * Required. The resource name of the Location from which to list the NotebookRuntimeTemplates. Format: `projects/{project\}/locations/{location\}` + * Required. The resource name of the Location to list the PersistentResources from. Format: `projects/{project\}/locations/{location\}` */ parent?: string; - /** - * Optional. Mask specifying which fields to read. - */ - readMask?: string; } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy + export interface Params$Resource$Projects$Locations$Persistentresources$Patch 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. + * Immutable. Resource name of a PersistentResource. */ - resource?: string; + name?: string; + /** + * Required. Specify the fields to be overwritten in the PersistentResource by the update method. + */ + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + requestBody?: Schema$GoogleCloudAiplatformV1PersistentResource; } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions + export interface Params$Resource$Projects$Locations$Persistentresources$Reboot extends StandardParameters { /** - * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number\}/locations/{location_id\}/persistentResources/{persistent_resource_id\}` */ - permissions?: string[]; + name?: string; + /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * Request body metadata */ - resource?: string; + requestBody?: Schema$GoogleCloudAiplatformV1RebootPersistentResourceRequest; } - export class Resource$Projects$Locations$Operations { + export class Resource$Projects$Locations$Persistentresources$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -52205,31 +53696,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; cancel( - params?: Params$Resource$Projects$Locations$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, options?: MethodOptions ): GaxiosPromise; cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Cancel + | Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -52245,12 +53736,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + params = + {} as Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel; options = {}; } @@ -52292,31 +53784,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Operations$Delete, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Operations$Delete, + params?: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Operations$Delete, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Operations$Delete, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Operations$Delete, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Delete + | Params$Resource$Projects$Locations$Persistentresources$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -52332,12 +53824,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Delete; + params = + {} as Params$Resource$Projects$Locations$Persistentresources$Operations$Delete; options = {}; } @@ -52379,27 +53872,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Operations$Get, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Operations$Get, + params?: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Operations$Get, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Operations$Get, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Operations$Get, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -52407,7 +53900,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Get + | Params$Resource$Projects$Locations$Persistentresources$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -52423,12 +53916,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Get; + {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Get; + params = + {} as Params$Resource$Projects$Locations$Persistentresources$Operations$Get; options = {}; } @@ -52470,27 +53964,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Operations$List, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Operations$List, + params?: Params$Resource$Projects$Locations$Persistentresources$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Operations$List, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Operations$List, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Operations$List, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$List, callback: BodyResponseCallback ): void; list( @@ -52498,7 +53992,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$List + | Params$Resource$Projects$Locations$Persistentresources$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -52514,12 +54008,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$List; + {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$List; + params = + {} as Params$Resource$Projects$Locations$Persistentresources$Operations$List; options = {}; } @@ -52566,27 +54061,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Operations$Wait, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; wait( - params?: Params$Resource$Projects$Locations$Operations$Wait, + params?: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, options?: MethodOptions ): GaxiosPromise; wait( - params: Params$Resource$Projects$Locations$Operations$Wait, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Operations$Wait, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Operations$Wait, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -52594,7 +54089,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Wait + | Params$Resource$Projects$Locations$Persistentresources$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -52610,12 +54105,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Wait; + params = + {} as Params$Resource$Projects$Locations$Persistentresources$Operations$Wait; options = {}; } @@ -52649,28 +54145,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Operations$Cancel + export interface Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$Delete + export interface Params$Resource$Projects$Locations$Persistentresources$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$Get + export interface Params$Resource$Projects$Locations$Persistentresources$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$List + export interface Params$Resource$Projects$Locations$Persistentresources$Operations$List extends StandardParameters { /** * The standard list filter. @@ -52689,7 +54185,7 @@ export namespace aiplatform_v1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Locations$Operations$Wait + export interface Params$Resource$Projects$Locations$Persistentresources$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. diff --git a/src/apis/aiplatform/v1beta1.ts b/src/apis/aiplatform/v1beta1.ts index f153022dd8..ec89990f89 100644 --- a/src/apis/aiplatform/v1beta1.ts +++ b/src/apis/aiplatform/v1beta1.ts @@ -1015,6 +1015,104 @@ export namespace aiplatform_v1beta1 { */ outputName?: string | null; } + /** + * Auth configuration to run the extension. + */ + export interface Schema$GoogleCloudAiplatformV1beta1AuthConfig { + /** + * Config for API key auth. + */ + apiKeyConfig?: Schema$GoogleCloudAiplatformV1beta1AuthConfigApiKeyConfig; + /** + * Type of auth scheme. + */ + authType?: string | null; + /** + * Config for Google Service Account auth. + */ + googleServiceAccountConfig?: Schema$GoogleCloudAiplatformV1beta1AuthConfigGoogleServiceAccountConfig; + /** + * Config for HTTP Basic auth. + */ + httpBasicAuthConfig?: Schema$GoogleCloudAiplatformV1beta1AuthConfigHttpBasicAuthConfig; + /** + * Config for no auth. + */ + noAuth?: Schema$GoogleCloudAiplatformV1beta1AuthConfigNoAuth; + /** + * Config for user oauth. + */ + oauthConfig?: Schema$GoogleCloudAiplatformV1beta1AuthConfigOauthConfig; + /** + * Config for user OIDC auth. + */ + oidcConfig?: Schema$GoogleCloudAiplatformV1beta1AuthConfigOidcConfig; + } + /** + * Config for authentication with API key. + */ + export interface Schema$GoogleCloudAiplatformV1beta1AuthConfigApiKeyConfig { + /** + * Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project\}/secrets/{secrete\}/versions/{version\}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + */ + apiKeySecret?: string | null; + /** + * Required. The location of the API key. + */ + httpElementLocation?: string | null; + /** + * Required. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + */ + name?: string | null; + } + /** + * Config for Google Service Account Authentication. + */ + export interface Schema$GoogleCloudAiplatformV1beta1AuthConfigGoogleServiceAccountConfig { + /** + * Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + */ + serviceAccount?: string | null; + } + /** + * Config for HTTP Basic Authentication. + */ + export interface Schema$GoogleCloudAiplatformV1beta1AuthConfigHttpBasicAuthConfig { + /** + * Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project\}/secrets/{secrete\}/versions/{version\}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + */ + credentialSecret?: string | null; + } + /** + * Empty message, used to indicate no authentication for an endpoint. + */ + export interface Schema$GoogleCloudAiplatformV1beta1AuthConfigNoAuth {} + /** + * Config for user oauth. + */ + export interface Schema$GoogleCloudAiplatformV1beta1AuthConfigOauthConfig { + /** + * Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + */ + accessToken?: string | null; + /** + * The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + */ + serviceAccount?: string | null; + } + /** + * Config for user OIDC auth. + */ + export interface Schema$GoogleCloudAiplatformV1beta1AuthConfigOidcConfig { + /** + * OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + */ + idToken?: string | null; + /** + * The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + */ + serviceAccount?: string | null; + } /** * A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. */ @@ -1638,6 +1736,15 @@ export namespace aiplatform_v1beta1 { */ safetyRatings?: Schema$GoogleCloudAiplatformV1beta1SafetyRating[]; } + /** + * Placeholder for all checkpoint related data. Any data needed to restore a request and more go/vertex-extension-query-operation + */ + export interface Schema$GoogleCloudAiplatformV1beta1CheckPoint { + /** + * Required. encoded checkpoint + */ + content?: string | null; + } /** * This message will be placed in the metadata field of a google.longrunning.Operation associated with a CheckTrialEarlyStoppingState request. */ @@ -3066,10 +3173,6 @@ export namespace aiplatform_v1beta1 { * Configures the request-response logging for online prediction. */ predictRequestResponseLoggingConfig?: Schema$GoogleCloudAiplatformV1beta1PredictRequestResponseLoggingConfig; - /** - * Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive. - */ - privateServiceConnectConfig?: Schema$GoogleCloudAiplatformV1beta1PrivateServiceConnectConfig; /** * A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment. */ @@ -3327,6 +3430,32 @@ export namespace aiplatform_v1beta1 { */ namespaceName?: string | null; } + /** + * Request message for ExtensionExecutionService.ExecuteExtension. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ExecuteExtensionRequest { + /** + * Required. The desired ID of the operation to be executed in this extension as defined in ExtensionOperation.operation_id. + */ + operationId?: string | null; + /** + * Optional. Request parameters that will be used for executing this operation. The struct should be in a form of map with param name as the key and actual param value as the value. E.g. If this operation requires a param "name" to be set to "abc". you can set this to something like {"name": "abc"\}. + */ + operationParams?: {[key: string]: any} | null; + /** + * Optional. Auth config provided at runtime to override the default value in Extension.manifest.auth_config. The AuthConfig.auth_type should match the value in Extension.manifest.auth_config. + */ + runtimeAuthConfig?: Schema$GoogleCloudAiplatformV1beta1AuthConfig; + } + /** + * Response message for ExtensionExecutionService.ExecuteExtension. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ExecuteExtensionResponse { + /** + * Response content from the extension. The content should be conformant to the response.content schema in the extension's manifest/OpenAPI spec. + */ + content?: string | null; + } /** * Instance of a general execution. */ @@ -3376,6 +3505,45 @@ export namespace aiplatform_v1beta1 { */ updateTime?: string | null; } + /** + * Execution plan for a request. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ExecutionPlan { + /** + * Required. Sequence of steps to execute a request. + */ + steps?: Schema$GoogleCloudAiplatformV1beta1ExecutionPlanStep[]; + } + /** + * Single step in query execution plan. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ExecutionPlanStep { + /** + * Extension execution step. + */ + extensionExecution?: Schema$GoogleCloudAiplatformV1beta1ExecutionPlanStepExtensionExecution; + /** + * Respond to user step. + */ + respondToUser?: Schema$GoogleCloudAiplatformV1beta1ExecutionPlanStepRespondToUser; + } + /** + * Extension execution step. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ExecutionPlanStepExtensionExecution { + /** + * Required. extension resource name + */ + extension?: string | null; + /** + * Required. the operation id + */ + operationId?: string | null; + } + /** + * Respond to user step. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ExecutionPlanStepRespondToUser {} /** * Request message for PredictionService.Explain. */ @@ -3899,6 +4067,94 @@ export namespace aiplatform_v1beta1 { */ timeSeriesDataPoints?: Schema$GoogleCloudAiplatformV1beta1TimeSeriesDataPoint[]; } + /** + * Extensions are tools for large language models to access external data, run computations, etc. + */ + export interface Schema$GoogleCloudAiplatformV1beta1Extension { + /** + * Output only. Timestamp when this Extension was created. + */ + createTime?: string | null; + /** + * Optional. The description of the Extension. + */ + description?: string | null; + /** + * Required. The display name of the Extension. The name can be up to 128 characters long and can consist of any UTF-8 characters. + */ + displayName?: string | null; + /** + * Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. + */ + etag?: string | null; + /** + * Output only. Supported operations. + */ + extensionOperations?: Schema$GoogleCloudAiplatformV1beta1ExtensionOperation[]; + /** + * Required. Manifest of the Extension. + */ + manifest?: Schema$GoogleCloudAiplatformV1beta1ExtensionManifest; + /** + * Identifier. The resource name of the Extension. + */ + name?: string | null; + /** + * Optional. Examples to illustrate the usage of the extension as a tool. + */ + toolUseExamples?: Schema$GoogleCloudAiplatformV1beta1ToolUseExample[]; + /** + * Output only. Timestamp when this Extension was most recently updated. + */ + updateTime?: string | null; + } + /** + * Manifest spec of an Extension needed for runtime execution. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ExtensionManifest { + /** + * Required. Immutable. The API specification shown to the LLM. + */ + apiSpec?: Schema$GoogleCloudAiplatformV1beta1ExtensionManifestApiSpec; + /** + * Required. Immutable. Type of auth supported by this extension. + */ + authConfig?: Schema$GoogleCloudAiplatformV1beta1AuthConfig; + /** + * Required. The natural language description shown to the LLM. It should describe the usage of the extension, and is essential for the LLM to perform reasoning. + */ + description?: string | null; + /** + * Required. Extension name shown to the LLM. The name can be up to 128 characters long. + */ + name?: string | null; + } + /** + * The API specification shown to the LLM. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ExtensionManifestApiSpec { + /** + * Cloud Storage URI pointing to the OpenAPI spec. + */ + openApiGcsUri?: string | null; + /** + * The API spec in Open API standard and YAML format. + */ + openApiYaml?: string | null; + } + /** + * Operation of an extension. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ExtensionOperation { + /** + * Output only. Structured representation of a function declaration as defined by the OpenAPI Spec. + */ + functionDeclaration?: Schema$GoogleCloudAiplatformV1beta1FunctionDeclaration; + /** + * Operation ID that uniquely identifies the operations among the extension. See: "Operation Object" in https://swagger.io/specification/. This field is parsed from the OpenAPI spec. For HTTP extensions, if it does not exist in the spec, we will generate one from the HTTP method and path. + */ + operationId?: string | null; + } /** * Feature Metadata information. For example, color is a feature that describes an apple. */ @@ -4552,7 +4808,7 @@ export namespace aiplatform_v1beta1 { */ bruteForceConfig?: Schema$GoogleCloudAiplatformV1beta1FeatureViewVectorSearchConfigBruteForceConfig; /** - * Optional. Column of crowding. This column contains crowding attribute which is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than some value k' of the k neighbors returned have the same value of crowding_attribute. + * Optional. Column of crowding. This column contains crowding attribute which is a constraint on a neighbor list produced by FeatureOnlineStoreService.SearchNearestEntities to diversify search results. If NearestNeighborQuery.per_crowding_attribute_neighbor_count is set to K in SearchNearestEntitiesRequest, it's guaranteed that no more than K entities of the same crowding attribute are returned in the response. */ crowdingColumn?: string | null; /** @@ -4608,6 +4864,10 @@ export namespace aiplatform_v1beta1 { * Response message for FeatureOnlineStoreService.FetchFeatureValues */ export interface Schema$GoogleCloudAiplatformV1beta1FetchFeatureValuesResponse { + /** + * The data key associated with this response. Will only be populated for FeatureOnlineStoreService.StreamingFetchFeatureValues RPCs. + */ + dataKey?: Schema$GoogleCloudAiplatformV1beta1FeatureViewDataKey; /** * Feature values in KeyValue format. */ @@ -4785,11 +5045,11 @@ export namespace aiplatform_v1beta1 { */ description?: string | null; /** - * Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. + * Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64. */ name?: string | null; /** - * Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + * Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 */ parameters?: Schema$GoogleCloudAiplatformV1beta1Schema; } @@ -5783,6 +6043,19 @@ export namespace aiplatform_v1beta1 { */ nextPageToken?: string | null; } + /** + * Response message for ExtensionRegistryService.ListExtensions + */ + export interface Schema$GoogleCloudAiplatformV1beta1ListExtensionsResponse { + /** + * List of Extension in the requested page. + */ + extensions?: Schema$GoogleCloudAiplatformV1beta1Extension[]; + /** + * A token to retrieve the next page of results. Pass to ListExtensionsRequest.page_token to obtain that page. + */ + nextPageToken?: string | null; + } /** * Response message for FeatureRegistryService.ListFeatureGroups. */ @@ -8662,6 +8935,10 @@ export namespace aiplatform_v1beta1 { * Optional. Deploy PublisherModel to Google Kubernetes Engine. */ deployGke?: Schema$GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployGke; + /** + * Optional. Multiple setups to deploy the PublisherModel to Vertex Endpoint. + */ + multiDeployVertex?: Schema$GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployVertex; /** * Optional. Open evaluation pipeline of the PublisherModel. */ @@ -8753,6 +9030,15 @@ export namespace aiplatform_v1beta1 { */ gkeYamlConfigs?: string[] | null; } + /** + * Multiple setups to deploy the PublisherModel. + */ + export interface Schema$GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployVertex { + /** + * Optional. One click deployment configurations. + */ + multiDeployVertex?: Schema$GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeploy[]; + } /** * Open fine tuning pipelines. */ @@ -9015,6 +9301,110 @@ export namespace aiplatform_v1beta1 { */ totalEndpointCount?: number | null; } + /** + * Request message for ExtensionExecutionService.QueryExtension. + */ + export interface Schema$GoogleCloudAiplatformV1beta1QueryExtensionRequest { + /** + * Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. + */ + contents?: Schema$GoogleCloudAiplatformV1beta1Content[]; + /** + * Required. User provided input query message. + */ + query?: Schema$GoogleCloudAiplatformV1beta1QueryRequestQuery; + /** + * Optional. Experiment control on whether to use function call. + */ + useFunctionCall?: boolean | null; + } + /** + * Response message for ExtensionExecutionService.QueryExtension. + */ + export interface Schema$GoogleCloudAiplatformV1beta1QueryExtensionResponse { + /** + * Failure message if any. + */ + failureMessage?: string | null; + /** + * Metadata related to the query execution. + */ + metadata?: Schema$GoogleCloudAiplatformV1beta1QueryResponseResponseMetadata; + queryResponseMetadata?: Schema$GoogleCloudAiplatformV1beta1QueryResponseQueryResponseMetadata; + /** + * Response to the user's query. + */ + response?: string | null; + /** + * Steps of extension or LLM interaction, can contain function call, function response, or text response. The last step contains the final response to the query. + */ + steps?: Schema$GoogleCloudAiplatformV1beta1Content[]; + } + /** + * User provided query message. + */ + export interface Schema$GoogleCloudAiplatformV1beta1QueryRequestQuery { + /** + * Required. The query from user. + */ + query?: string | null; + } + export interface Schema$GoogleCloudAiplatformV1beta1QueryResponseQueryResponseMetadata { + /** + * ReAgent execution steps. + */ + steps?: Schema$GoogleCloudAiplatformV1beta1QueryResponseQueryResponseMetadataReAgentSteps[]; + /** + * Whether the reasoning agent used creativity (instead of extensions provided) to build the response. + */ + useCreativity?: boolean | null; + } + /** + * ReAgent execution steps. + */ + export interface Schema$GoogleCloudAiplatformV1beta1QueryResponseQueryResponseMetadataReAgentSteps { + /** + * Error messages from the extension or during response parsing. + */ + error?: string | null; + /** + * Planner's instruction to the extension. + */ + extensionInstruction?: string | null; + /** + * Planner's choice of extension to invoke. + */ + extensionInvoked?: string | null; + /** + * Response of the extension. + */ + response?: string | null; + /** + * When set to False, either the extension fails to execute or the response cannot be summarized. + */ + success?: boolean | null; + /** + * Planner's thought. + */ + thought?: string | null; + } + /** + * Metadata for response + */ + export interface Schema$GoogleCloudAiplatformV1beta1QueryResponseResponseMetadata { + /** + * Optional. Checkpoint to restore a request + */ + checkpoint?: Schema$GoogleCloudAiplatformV1beta1CheckPoint; + /** + * Optional. Execution plan for the request. + */ + executionPlan?: Schema$GoogleCloudAiplatformV1beta1ExecutionPlan; + /** + * To surface the v2 flow output. + */ + flowOutputs?: {[key: string]: any} | null; + } /** * Request message for PredictionService.RawPredict. */ @@ -9212,6 +9602,23 @@ export namespace aiplatform_v1beta1 { */ viewCount?: string | null; } + /** + * Details of operations that perform reboot PersistentResource. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RebootPersistentResourceOperationMetadata { + /** + * Operation metadata for PersistentResource. + */ + genericMetadata?: Schema$GoogleCloudAiplatformV1beta1GenericOperationMetadata; + /** + * Progress Message for Reboot LRO + */ + progressMessage?: string | null; + } + /** + * Request message for PersistentResourceService.RebootPersistentResource. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RebootPersistentResourceRequest {} /** * Request message for MetadataService.DeleteContextChildrenRequest. */ @@ -9442,6 +9849,10 @@ export namespace aiplatform_v1beta1 { * Required. Harm category. */ category?: string | null; + /** + * Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. + */ + method?: string | null; /** * Required. The harm block threshold. */ @@ -9656,6 +10067,10 @@ export namespace aiplatform_v1beta1 { * Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed. */ export interface Schema$GoogleCloudAiplatformV1beta1Schema { + /** + * Optional. Default value of the data. + */ + default?: any | null; /** * Optional. The description of the data. */ @@ -9669,19 +10084,55 @@ export namespace aiplatform_v1beta1 { */ example?: any | null; /** - * Optional. The format of the data. Supported formats: for NUMBER type: float, double for INTEGER type: int32, int64 + * Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc */ format?: string | null; /** - * Optional. Schema of the elements of Type.ARRAY. + * Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. */ items?: Schema$GoogleCloudAiplatformV1beta1Schema; + /** + * Optional. Maximum value of the Type.INTEGER and Type.NUMBER + */ + maximum?: number | null; + /** + * Optional. Maximum number of the elements for Type.ARRAY. + */ + maxItems?: string | null; + /** + * Optional. Maximum length of the Type.STRING + */ + maxLength?: string | null; + /** + * Optional. Maximum number of the properties for Type.OBJECT. + */ + maxProperties?: string | null; + /** + * Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + */ + minimum?: number | null; + /** + * Optional. Minimum number of the elements for Type.ARRAY. + */ + minItems?: string | null; + /** + * Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + */ + minLength?: string | null; + /** + * Optional. Minimum number of the properties for Type.OBJECT. + */ + minProperties?: string | null; /** * Optional. Indicates if the value may be null. */ nullable?: boolean | null; /** - * Optional. Properties of Type.OBJECT. + * Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + */ + pattern?: string | null; + /** + * Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. */ properties?: { [key: string]: Schema$GoogleCloudAiplatformV1beta1Schema; @@ -9690,6 +10141,10 @@ export namespace aiplatform_v1beta1 { * Optional. Required properties of Type.OBJECT. */ required?: string[] | null; + /** + * Optional. The title of the Schema. + */ + title?: string | null; /** * Optional. The type of the data. */ @@ -12409,6 +12864,27 @@ export namespace aiplatform_v1beta1 { */ validationFraction?: number | null; } + /** + * Request message for FeatureOnlineStoreService.StreamingFetchFeatureValues. For the entities requested, all features under the requested feature view will be returned. + */ + export interface Schema$GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesRequest { + /** + * Specify response data format. If not set, KeyValue format will be used. + */ + dataFormat?: string | null; + dataKeys?: Schema$GoogleCloudAiplatformV1beta1FeatureViewDataKey[]; + } + /** + * Response message for FeatureOnlineStoreService.StreamingFetchFeatureValues. + */ + export interface Schema$GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesResponse { + data?: Schema$GoogleCloudAiplatformV1beta1FetchFeatureValuesResponse[]; + dataKeysWithError?: Schema$GoogleCloudAiplatformV1beta1FeatureViewDataKey[]; + /** + * Response status. If OK, then StreamingFetchFeatureValuesResponse.data will be populated. Otherwise StreamingFetchFeatureValuesResponse.data_keys_with_error will be populated with the appropriate data keys. The error only applies to the listed data keys - the stream will remain open for further FeatureOnlineStoreService.StreamingFetchFeatureValuesRequest requests. + */ + status?: Schema$GoogleRpcStatus; + } /** * Request message for PredictionService.StreamingPredict. The first message must contain endpoint field and optionally input. The subsequent messages must contain input. */ @@ -13291,6 +13767,52 @@ export namespace aiplatform_v1beta1 { */ retrieval?: Schema$GoogleCloudAiplatformV1beta1Retrieval; } + /** + * A single example of the tool usage. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ToolUseExample { + /** + * Required. The display name for example. + */ + displayName?: string | null; + /** + * Extension operation to call. + */ + extensionOperation?: Schema$GoogleCloudAiplatformV1beta1ToolUseExampleExtensionOperation; + /** + * Function name to call. + */ + functionName?: string | null; + /** + * Required. Query that should be routed to this tool. + */ + query?: string | null; + /** + * Request parameters used for executing this tool. + */ + requestParams?: {[key: string]: any} | null; + /** + * Response parameters generated by this tool. + */ + responseParams?: {[key: string]: any} | null; + /** + * Summary of the tool response to the user query. + */ + responseSummary?: string | null; + } + /** + * Identifies one operation of the extension. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ToolUseExampleExtensionOperation { + /** + * Resource name of the extension. + */ + extension?: string | null; + /** + * Required. Operation ID of the extension. + */ + operationId?: string | null; + } /** * CMLE training config. For every active learning labeling iteration, system will train a machine learning model on CMLE. The trained model will be used by data sampling algorithm to select DataItems. */ @@ -13775,7 +14297,7 @@ export namespace aiplatform_v1beta1 { */ export interface Schema$GoogleCloudAiplatformV1beta1VertexAISearch { /** - * Required. Fully-qualified Vertex AI Search's datastore resource ID. projects/<\>/locations/<\>/collections/<\>/dataStores/<\> + * Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{dataStore\} */ datastore?: string | null; } @@ -14593,7 +15115,7 @@ export namespace aiplatform_v1beta1 { } export interface Schema$LearningGenaiRootGroundingMetadataCitation { /** - * Index in the prediction output where the citation ends (exclusive). Must be \> start_index and < len(output). + * Index in the prediction output where the citation ends (exclusive). Must be \> start_index and <= len(output). */ endIndex?: number | null; /** @@ -26553,7 +27075,7 @@ export namespace aiplatform_v1beta1 { export interface Params$Resource$Projects$Locations$Endpoints$List extends StandardParameters { /** - * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports = and !=. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports = and, != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `base_model_name` only supports = Some examples: * `endpoint=1` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"` + * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports `=` and `!=`. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports `=` and `!=`. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:*` or `labels:key` - key existence * A key including a space must be quoted. `labels."a key"`. * `base_model_name` only supports `=`. Some examples: * `endpoint=1` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"` */ filter?: string; /** @@ -28722,6 +29244,755 @@ export namespace aiplatform_v1beta1 { this.context ); } + + /** + * Deletes an Extension. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Extensions$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Extensions$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Extensions$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Extensions$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Extensions$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Extensions$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Extensions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Extensions$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Executes the request against a given extension. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + execute( + params: Params$Resource$Projects$Locations$Extensions$Execute, + options: StreamMethodOptions + ): GaxiosPromise; + execute( + params?: Params$Resource$Projects$Locations$Extensions$Execute, + options?: MethodOptions + ): GaxiosPromise; + execute( + params: Params$Resource$Projects$Locations$Extensions$Execute, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + execute( + params: Params$Resource$Projects$Locations$Extensions$Execute, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + execute( + params: Params$Resource$Projects$Locations$Extensions$Execute, + callback: BodyResponseCallback + ): void; + execute( + callback: BodyResponseCallback + ): void; + execute( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Extensions$Execute + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Extensions$Execute; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Extensions$Execute; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:execute').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets an Extension. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Extensions$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Extensions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Extensions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Extensions$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Extensions$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Extensions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Extensions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Extensions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Imports an Extension. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + import( + params: Params$Resource$Projects$Locations$Extensions$Import, + options: StreamMethodOptions + ): GaxiosPromise; + import( + params?: Params$Resource$Projects$Locations$Extensions$Import, + options?: MethodOptions + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Extensions$Import, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Extensions$Import, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Extensions$Import, + callback: BodyResponseCallback + ): void; + import( + callback: BodyResponseCallback + ): void; + import( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Extensions$Import + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Extensions$Import; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Extensions$Import; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/extensions:import').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists Extensions in a location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Extensions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Extensions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Extensions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Extensions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Extensions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Extensions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Extensions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Extensions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/extensions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an Extension. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Extensions$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Extensions$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Extensions$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Extensions$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Extensions$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Extensions$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Extensions$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Extensions$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Queries an extension with a default controller. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + query( + params: Params$Resource$Projects$Locations$Extensions$Query, + options: StreamMethodOptions + ): GaxiosPromise; + query( + params?: Params$Resource$Projects$Locations$Extensions$Query, + options?: MethodOptions + ): GaxiosPromise; + query( + params: Params$Resource$Projects$Locations$Extensions$Query, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + query( + params: Params$Resource$Projects$Locations$Extensions$Query, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + query( + params: Params$Resource$Projects$Locations$Extensions$Query, + callback: BodyResponseCallback + ): void; + query( + callback: BodyResponseCallback + ): void; + query( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Extensions$Query + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Extensions$Query; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Extensions$Query; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:query').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + 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$Extensions$Delete + extends StandardParameters { + /** + * Required. The name of the Extension resource to be deleted. Format: `projects/{project\}/locations/{location\}/extensions/{extension\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Extensions$Execute + extends StandardParameters { + /** + * Required. Name (identifier) of the extension; Format: `projects/{project\}/locations/{location\}/extensions/{extension\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1ExecuteExtensionRequest; + } + export interface Params$Resource$Projects$Locations$Extensions$Get + extends StandardParameters { + /** + * Required. The name of the Extension resource. Format: `projects/{project\}/locations/{location\}/extensions/{extension\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Extensions$Import + extends StandardParameters { + /** + * Required. The resource name of the Location to import the Extension in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1Extension; + } + export interface Params$Resource$Projects$Locations$Extensions$List + extends StandardParameters { + /** + * Optional. The standard list filter. Supported fields: * `display_name` * `create_time` * `update_time` More detail in [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. + */ + orderBy?: string; + /** + * Optional. The standard list page size. + */ + pageSize?: number; + /** + * Optional. The standard list page token. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list the Extensions from. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Extensions$Patch + extends StandardParameters { + /** + * Identifier. The resource name of the Extension. + */ + name?: string; + /** + * Required. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `tool_use_examples` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1Extension; + } + export interface Params$Resource$Projects$Locations$Extensions$Query + extends StandardParameters { + /** + * Required. Name (identifier) of the extension; Format: `projects/{project\}/locations/{location\}/extensions/{extension\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1QueryExtensionRequest; } export class Resource$Projects$Locations$Extensions$Deployments { @@ -33483,6 +34754,102 @@ export namespace aiplatform_v1beta1 { } } + /** + * Bidirectional streaming RPC to fetch feature values under a FeatureView. Requests may not have a one-to-one mapping to responses and responses may be returned out-of-order to reduce latency. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + streamingFetchFeatureValues( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Streamingfetchfeaturevalues, + options: StreamMethodOptions + ): GaxiosPromise; + streamingFetchFeatureValues( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Streamingfetchfeaturevalues, + options?: MethodOptions + ): GaxiosPromise; + streamingFetchFeatureValues( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Streamingfetchfeaturevalues, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + streamingFetchFeatureValues( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Streamingfetchfeaturevalues, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + streamingFetchFeatureValues( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Streamingfetchfeaturevalues, + callback: BodyResponseCallback + ): void; + streamingFetchFeatureValues( + callback: BodyResponseCallback + ): void; + streamingFetchFeatureValues( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Streamingfetchfeaturevalues + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Streamingfetchfeaturevalues; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Streamingfetchfeaturevalues; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1beta1/{+featureView}:streamingFetchFeatureValues' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['featureView'], + pathParams: ['featureView'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Triggers on-demand sync for the FeatureView. * @@ -33798,6 +35165,18 @@ export namespace aiplatform_v1beta1 { */ requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Streamingfetchfeaturevalues + extends StandardParameters { + /** + * Required. FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` + */ + featureView?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesRequest; + } export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync extends StandardParameters { /** @@ -57048,7 +58427,7 @@ export namespace aiplatform_v1beta1 { export interface Params$Resource$Projects$Locations$Notebookruntimes$List extends StandardParameters { /** - * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * `notebookRuntime="notebookRuntime123"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` * `notebookRuntimeTemplate="notebookRuntimeTemplate321"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser="test@google.com"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` + * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * `notebookRuntime="notebookRuntime123"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` * `notebookRuntimeTemplate="notebookRuntimeTemplate321"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser="test@google.com"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` */ filter?: string; /** @@ -58864,6 +60243,101 @@ export namespace aiplatform_v1beta1 { return createAPIRequest(parameters); } } + + /** + * Reboots a PersistentResource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + reboot( + params: Params$Resource$Projects$Locations$Persistentresources$Reboot, + options: StreamMethodOptions + ): GaxiosPromise; + reboot( + params?: Params$Resource$Projects$Locations$Persistentresources$Reboot, + options?: MethodOptions + ): GaxiosPromise; + reboot( + params: Params$Resource$Projects$Locations$Persistentresources$Reboot, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + reboot( + params: Params$Resource$Projects$Locations$Persistentresources$Reboot, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + reboot( + params: Params$Resource$Projects$Locations$Persistentresources$Reboot, + callback: BodyResponseCallback + ): void; + reboot( + callback: BodyResponseCallback + ): void; + reboot( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Persistentresources$Reboot + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Persistentresources$Reboot; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Persistentresources$Reboot; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:reboot').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + 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$Persistentresources$Create @@ -58927,6 +60401,18 @@ export namespace aiplatform_v1beta1 { */ requestBody?: Schema$GoogleCloudAiplatformV1beta1PersistentResource; } + export interface Params$Resource$Projects$Locations$Persistentresources$Reboot + extends StandardParameters { + /** + * Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number\}/locations/{location_id\}/persistentResources/{persistent_resource_id\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1RebootPersistentResourceRequest; + } export class Resource$Projects$Locations$Persistentresources$Operations { context: APIRequestContext; diff --git a/src/apis/alloydb/v1.ts b/src/apis/alloydb/v1.ts index 01d9523bb9..bce57aa967 100644 --- a/src/apis/alloydb/v1.ts +++ b/src/apis/alloydb/v1.ts @@ -124,6 +124,15 @@ export namespace alloydb_v1 { } } + /** + * AuthorizedNetwork contains metadata for an authorized network. + */ + export interface Schema$AuthorizedNetwork { + /** + * CIDR range for one authorzied network of the instance. + */ + cidrRange?: string | null; + } /** * Message describing the user-specified automated backup policy. All fields in the automated backup policy are optional. Defaults for each field are provided if they are not set. */ @@ -423,6 +432,10 @@ export namespace alloydb_v1 { * The name of the ConnectionInfo singleton resource, e.g.: projects/{project\}/locations/{location\}/clusters/x/instances/x/connectionInfo This field currently has no semantic meaning. */ name?: string | null; + /** + * Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application. + */ + publicIpAddress?: string | null; } /** * ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster. @@ -514,40 +527,6 @@ export namespace alloydb_v1 { */ validateOnly?: boolean | null; } - /** - * Message for requests to generate a client certificate signed by the Cluster CA. - */ - export interface Schema$GenerateClientCertificateRequest { - /** - * Optional. An optional hint to the endpoint to generate the client certificate with the requested duration. The duration can be from 1 hour to 24 hours. The endpoint may or may not honor the hint. If the hint is left unspecified or is not honored, then the endpoint will pick an appropriate default duration. - */ - certDuration?: string | null; - /** - * Optional. The public key from the client. - */ - publicKey?: string | null; - /** - * 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; - /** - * Optional. An optional hint to the endpoint to generate a client ceritificate that can be used by AlloyDB connectors to exchange additional metadata with the server after TLS handshake. - */ - useMetadataExchange?: boolean | null; - } - /** - * Message returned by a GenerateClientCertificate operation. - */ - export interface Schema$GenerateClientCertificateResponse { - /** - * Optional. The pem-encoded cluster ca X.509 certificate. - */ - caCert?: string | null; - /** - * Output only. The pem-encoded chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246. - */ - pemCertificateChain?: string[] | null; - } /** * The response message for Locations.ListLocations. */ @@ -684,10 +663,18 @@ export namespace alloydb_v1 { * Output only. The name of the instance resource with the format: * projects/{project\}/locations/{region\}/clusters/{cluster_id\}/instances/{instance_id\} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61\}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project\}/locations/{region\}/clusters/{cluster_id\} */ name?: string | null; + /** + * Optional. Instance level network configuration. + */ + networkConfig?: Schema$InstanceNetworkConfig; /** * Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance. */ nodes?: Schema$Node[]; + /** + * Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application. + */ + publicIpAddress?: string | null; /** * Configuration for query insights. */ @@ -721,6 +708,19 @@ export namespace alloydb_v1 { */ writableNode?: Schema$Node; } + /** + * Metadata related to instance level network configuration. + */ + export interface Schema$InstanceNetworkConfig { + /** + * Optional. A list of external network authorized to access this instance. + */ + authorizedExternalNetworks?: Schema$AuthorizedNetwork[]; + /** + * Optional. Enabling public ip for the instance. + */ + enablePublicIp?: boolean | null; + } /** * Restrictions on INTEGER type values. */ @@ -1359,6 +1359,10 @@ export namespace alloydb_v1 { * User-provided labels, represented as a dictionary where each label is a single key value pair. */ userLabels?: {[key: string]: string} | null; + /** + * User-provided labels associated with the resource + */ + userLabelSet?: Schema$StorageDatabasecenterPartnerapiV1mainUserLabels; } /** * Common model for database resource recommendation signal data. @@ -1432,6 +1436,12 @@ export namespace alloydb_v1 { retentionUnit?: string | null; timeBasedRetention?: string | null; } + /** + * Message type for storing user labels. User labels are used to tag App Engine resources, allowing users to search for resources matching a set of labels and to aggregate usage data by labels. + */ + export interface Schema$StorageDatabasecenterPartnerapiV1mainUserLabels { + labels?: {[key: string]: string} | null; + } /** * Product specification for Condor resources. */ @@ -2599,103 +2609,6 @@ export namespace alloydb_v1 { } } - /** - * Generate a client certificate signed by a Cluster CA. The sole purpose of this endpoint is to support AlloyDB connectors and the Auth Proxy client. The endpoint's behavior is subject to change without notice, so do not rely on its behavior remaining constant. Future changes will not break AlloyDB connectors or the Auth Proxy client. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - generateClientCertificate( - params: Params$Resource$Projects$Locations$Clusters$Generateclientcertificate, - options: StreamMethodOptions - ): GaxiosPromise; - generateClientCertificate( - params?: Params$Resource$Projects$Locations$Clusters$Generateclientcertificate, - options?: MethodOptions - ): GaxiosPromise; - generateClientCertificate( - params: Params$Resource$Projects$Locations$Clusters$Generateclientcertificate, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - generateClientCertificate( - params: Params$Resource$Projects$Locations$Clusters$Generateclientcertificate, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - generateClientCertificate( - params: Params$Resource$Projects$Locations$Clusters$Generateclientcertificate, - callback: BodyResponseCallback - ): void; - generateClientCertificate( - callback: BodyResponseCallback - ): void; - generateClientCertificate( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Clusters$Generateclientcertificate - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Clusters$Generateclientcertificate; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Clusters$Generateclientcertificate; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}:generateClientCertificate').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - /** * Gets details of a single Cluster. * @@ -3202,18 +3115,6 @@ export namespace alloydb_v1 { */ validateOnly?: boolean; } - export interface Params$Resource$Projects$Locations$Clusters$Generateclientcertificate - extends StandardParameters { - /** - * Required. The name of the parent resource. The required format is: * projects/{project\}/locations/{location\}/clusters/{cluster\} - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GenerateClientCertificateRequest; - } export interface Params$Resource$Projects$Locations$Clusters$Get extends StandardParameters { /** diff --git a/src/apis/alloydb/v1alpha.ts b/src/apis/alloydb/v1alpha.ts index fe4773bba4..7cd0264d09 100644 --- a/src/apis/alloydb/v1alpha.ts +++ b/src/apis/alloydb/v1alpha.ts @@ -366,6 +366,10 @@ export namespace alloydb_v1alpha { * For Resource freshness validation (https://google.aip.dev/154) */ etag?: string | null; + /** + * Optional. Configuration parameters related to the Gemini in Databases add-on. See go/prd-enable-duet-ai-databases for more details. + */ + geminiConfig?: Schema$GeminiClusterConfig; /** * Input only. Initial user to setup during cluster creation. Required. If used in `RestoreCluster` this is ignored. */ @@ -374,6 +378,10 @@ export namespace alloydb_v1alpha { * Labels as key value pairs */ labels?: {[key: string]: string} | null; + /** + * Optional. The maintenance update policy determines when to allow or deny updates. + */ + maintenanceUpdatePolicy?: Schema$MaintenanceUpdatePolicy; /** * Output only. Cluster created via DMS migration. */ @@ -508,6 +516,23 @@ export namespace alloydb_v1alpha { */ pointInTime?: string | null; } + /** + * DenyMaintenancePeriod definition. Excepting emergencies, maintenance will not be scheduled to start within this deny period. The start_date must be less than the end_date. + */ + export interface Schema$DenyMaintenancePeriod { + /** + * Deny period end date. This can be: * A full date, with non-zero year, month and day values. * A month and day value, with a zero year for recurring. Date matching this period will have to be before the end. + */ + endDate?: Schema$GoogleTypeDate; + /** + * Deny period start date. This can be: * A full date, with non-zero year, month and day values. * A month and day value, with a zero year for recurring. Date matching this period will have to be the same or after the start. + */ + startDate?: Schema$GoogleTypeDate; + /** + * Time in UTC when the deny period starts on start_date and ends on end_date. This can be: * Full time. * All zeros for 00:00:00 UTC + */ + time?: Schema$GoogleTypeTimeOfDay; + } /** * 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); \} */ @@ -548,46 +573,22 @@ export namespace alloydb_v1alpha { validateOnly?: boolean | null; } /** - * Message for requests to generate a client certificate signed by the Cluster CA. + * Cluster level configuration parameters related to the Gemini in Databases add-on. See go/prd-enable-duet-ai-databases for more details. */ - export interface Schema$GenerateClientCertificateRequest { - /** - * Optional. An optional hint to the endpoint to generate the client certificate with the requested duration. The duration can be from 1 hour to 24 hours. The endpoint may or may not honor the hint. If the hint is left unspecified or is not honored, then the endpoint will pick an appropriate default duration. - */ - certDuration?: string | null; - /** - * Optional. A pem-encoded X.509 certificate signing request (CSR). It is recommended to use public_key instead. - */ - pemCsr?: string | null; + export interface Schema$GeminiClusterConfig { /** - * Optional. The public key from the client. + * Output only. Whether the Gemini in Databases add-on is enabled for the cluster. It will be true only if the add-on has been enabled for the billing account corresponding to the cluster. Its status is toggled from the Admin Control Center (ACC) and cannot be toggled using AlloyDB's APIs. */ - publicKey?: string | null; - /** - * 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; - /** - * Optional. An optional hint to the endpoint to generate a client ceritificate that can be used by AlloyDB connectors to exchange additional metadata with the server after TLS handshake. - */ - useMetadataExchange?: boolean | null; + entitled?: boolean | null; } /** - * Message returned by a GenerateClientCertificate operation. + * Instance level configuration parameters related to the Gemini in Databases add-on. See go/prd-enable-duet-ai-databases for more details. */ - export interface Schema$GenerateClientCertificateResponse { - /** - * Optional. The pem-encoded cluster ca X.509 certificate. - */ - caCert?: string | null; - /** - * Output only. The pem-encoded, signed X.509 certificate. - */ - pemCertificate?: string | null; + export interface Schema$GeminiInstanceConfig { /** - * Output only. The pem-encoded chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246. + * Output only. Whether the Gemini in Databases add-on is enabled for the instance. It will be true only if the add-on has been enabled for the billing account corresponding to the instance. Its status is toggled from the Admin Control Center (ACC) and cannot be toggled using AlloyDB's APIs. */ - pemCertificateChain?: string[] | null; + entitled?: boolean | null; } /** * The response message for Locations.ListLocations. @@ -627,6 +628,23 @@ export namespace alloydb_v1alpha { */ name?: string | null; } + /** + * Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp + */ + export interface Schema$GoogleTypeDate { + /** + * Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + */ + day?: number | null; + /** + * Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + */ + month?: number | null; + /** + * Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + */ + year?: number | null; + } /** * Represents 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`. */ @@ -705,6 +723,10 @@ export namespace alloydb_v1alpha { * The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity. */ gceZone?: string | null; + /** + * Optional. Configuration parameters related to the Gemini in Databases add-on. See go/prd-enable-duet-ai-databases for more details. + */ + geminiConfig?: Schema$GeminiInstanceConfig; /** * Required. The type of the instance. Specified at creation time. */ @@ -733,6 +755,10 @@ export namespace alloydb_v1alpha { * Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance. */ nodes?: Schema$Node[]; + /** + * Configuration for observability. + */ + observabilityConfig?: Schema$ObservabilityInstanceConfig; /** * Optional. The configuration for Private Service Connect (PSC) for the instance. */ @@ -911,6 +937,32 @@ export namespace alloydb_v1alpha { */ cpuCount?: number | null; } + /** + * MaintenanceUpdatePolicy defines the policy for system updates. + */ + export interface Schema$MaintenanceUpdatePolicy { + /** + * Periods to deny maintenance. Currently limited to 1. + */ + denyMaintenancePeriods?: Schema$DenyMaintenancePeriod[]; + /** + * Preferred windows to perform maintenance. Currently limited to 1. + */ + maintenanceWindows?: Schema$MaintenanceWindow[]; + } + /** + * MaintenanceWindow specifies a preferred day and time for maintenance. + */ + export interface Schema$MaintenanceWindow { + /** + * Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc. + */ + day?: string | null; + /** + * Preferred time to start the maintenance operation on the specified day. Maintenance will start within 1 hour of this time. + */ + startTime?: Schema$GoogleTypeTimeOfDay; + } /** * Subset of the source instance configuration that is available when reading the cluster resource. */ @@ -962,6 +1014,43 @@ export namespace alloydb_v1alpha { */ zoneId?: string | null; } + /** + * Observability Instance specific configuration. + */ + export interface Schema$ObservabilityInstanceConfig { + /** + * Observability feature status for an instance. This is a read-only flag and modifiable only by producer API. This flag is turned "off" by default. + */ + enabled?: boolean | null; + /** + * Query string length. The default value is 10k. + */ + maxQueryStringLength?: number | null; + /** + * Preserve comments in query string for an instance. This flag is turned "off" by default. + */ + preserveComments?: boolean | null; + /** + * Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 to 20 is considered valid. + */ + queryPlansPerMinute?: number | null; + /** + * Record application tags for an instance. This flag is turned "off" by default. + */ + recordApplicationTags?: boolean | null; + /** + * Track actively running queries on the instance. If not set, this flag is "off" by default. + */ + trackActiveQueries?: boolean | null; + /** + * Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. + */ + trackWaitEvents?: boolean | null; + /** + * Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by producer API. + */ + trackWaitEventTypes?: boolean | null; + } /** * This resource represents a long-running operation that is the result of a network API call. */ @@ -1488,6 +1577,10 @@ export namespace alloydb_v1alpha { * User-provided labels, represented as a dictionary where each label is a single key value pair. */ userLabels?: {[key: string]: string} | null; + /** + * User-provided labels associated with the resource + */ + userLabelSet?: Schema$StorageDatabasecenterPartnerapiV1mainUserLabels; } /** * Common model for database resource recommendation signal data. @@ -1561,6 +1654,12 @@ export namespace alloydb_v1alpha { retentionUnit?: string | null; timeBasedRetention?: string | null; } + /** + * Message type for storing user labels. User labels are used to tag App Engine resources, allowing users to search for resources matching a set of labels and to aggregate usage data by labels. + */ + export interface Schema$StorageDatabasecenterPartnerapiV1mainUserLabels { + labels?: {[key: string]: string} | null; + } /** * Product specification for Condor resources. */ @@ -2736,102 +2835,6 @@ export namespace alloydb_v1alpha { } } - /** - * Generate a client certificate signed by a Cluster CA. The sole purpose of this endpoint is to support AlloyDB connectors and the Auth Proxy client. The endpoint's behavior is subject to change without notice, so do not rely on its behavior remaining constant. Future changes will not break AlloyDB connectors or the Auth Proxy client. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - generateClientCertificate( - params: Params$Resource$Projects$Locations$Clusters$Generateclientcertificate, - options: StreamMethodOptions - ): GaxiosPromise; - generateClientCertificate( - params?: Params$Resource$Projects$Locations$Clusters$Generateclientcertificate, - options?: MethodOptions - ): GaxiosPromise; - generateClientCertificate( - params: Params$Resource$Projects$Locations$Clusters$Generateclientcertificate, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - generateClientCertificate( - params: Params$Resource$Projects$Locations$Clusters$Generateclientcertificate, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - generateClientCertificate( - params: Params$Resource$Projects$Locations$Clusters$Generateclientcertificate, - callback: BodyResponseCallback - ): void; - generateClientCertificate( - callback: BodyResponseCallback - ): void; - generateClientCertificate( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Clusters$Generateclientcertificate - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Clusters$Generateclientcertificate; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Clusters$Generateclientcertificate; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1alpha/{+parent}:generateClientCertificate' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - /** * Gets details of a single Cluster. * @@ -3338,18 +3341,6 @@ export namespace alloydb_v1alpha { */ validateOnly?: boolean; } - export interface Params$Resource$Projects$Locations$Clusters$Generateclientcertificate - extends StandardParameters { - /** - * Required. The name of the parent resource. The required format is: * projects/{project\}/locations/{location\}/clusters/{cluster\} - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GenerateClientCertificateRequest; - } export interface Params$Resource$Projects$Locations$Clusters$Get extends StandardParameters { /** diff --git a/src/apis/alloydb/v1beta.ts b/src/apis/alloydb/v1beta.ts index 349b5e5def..e93775c478 100644 --- a/src/apis/alloydb/v1beta.ts +++ b/src/apis/alloydb/v1beta.ts @@ -358,6 +358,10 @@ export namespace alloydb_v1beta { * For Resource freshness validation (https://google.aip.dev/154) */ etag?: string | null; + /** + * Optional. Configuration parameters related to the Gemini in Databases add-on. See go/prd-enable-duet-ai-databases for more details. + */ + geminiConfig?: Schema$GeminiClusterConfig; /** * Input only. Initial user to setup during cluster creation. Required. If used in `RestoreCluster` this is ignored. */ @@ -366,6 +370,10 @@ export namespace alloydb_v1beta { * Labels as key value pairs */ labels?: {[key: string]: string} | null; + /** + * Optional. The maintenance update policy determines when to allow or deny updates. + */ + maintenanceUpdatePolicy?: Schema$MaintenanceUpdatePolicy; /** * Output only. Cluster created via DMS migration. */ @@ -496,6 +504,23 @@ export namespace alloydb_v1beta { */ pointInTime?: string | null; } + /** + * DenyMaintenancePeriod definition. Excepting emergencies, maintenance will not be scheduled to start within this deny period. The start_date must be less than the end_date. + */ + export interface Schema$DenyMaintenancePeriod { + /** + * Deny period end date. This can be: * A full date, with non-zero year, month and day values. * A month and day value, with a zero year for recurring. Date matching this period will have to be before the end. + */ + endDate?: Schema$GoogleTypeDate; + /** + * Deny period start date. This can be: * A full date, with non-zero year, month and day values. * A month and day value, with a zero year for recurring. Date matching this period will have to be the same or after the start. + */ + startDate?: Schema$GoogleTypeDate; + /** + * Time in UTC when the deny period starts on start_date and ends on end_date. This can be: * Full time. * All zeros for 00:00:00 UTC + */ + time?: Schema$GoogleTypeTimeOfDay; + } /** * 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); \} */ @@ -536,46 +561,22 @@ export namespace alloydb_v1beta { validateOnly?: boolean | null; } /** - * Message for requests to generate a client certificate signed by the Cluster CA. + * Cluster level configuration parameters related to the Gemini in Databases add-on. See go/prd-enable-duet-ai-databases for more details. */ - export interface Schema$GenerateClientCertificateRequest { - /** - * Optional. An optional hint to the endpoint to generate the client certificate with the requested duration. The duration can be from 1 hour to 24 hours. The endpoint may or may not honor the hint. If the hint is left unspecified or is not honored, then the endpoint will pick an appropriate default duration. - */ - certDuration?: string | null; - /** - * Optional. A pem-encoded X.509 certificate signing request (CSR). It is recommended to use public_key instead. - */ - pemCsr?: string | null; + export interface Schema$GeminiClusterConfig { /** - * Optional. The public key from the client. + * Output only. Whether the Gemini in Databases add-on is enabled for the cluster. It will be true only if the add-on has been enabled for the billing account corresponding to the cluster. Its status is toggled from the Admin Control Center (ACC) and cannot be toggled using AlloyDB's APIs. */ - publicKey?: string | null; - /** - * 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; - /** - * Optional. An optional hint to the endpoint to generate a client ceritificate that can be used by AlloyDB connectors to exchange additional metadata with the server after TLS handshake. - */ - useMetadataExchange?: boolean | null; + entitled?: boolean | null; } /** - * Message returned by a GenerateClientCertificate operation. + * Instance level configuration parameters related to the Gemini in Databases add-on. See go/prd-enable-duet-ai-databases for more details. */ - export interface Schema$GenerateClientCertificateResponse { - /** - * Optional. The pem-encoded cluster ca X.509 certificate. - */ - caCert?: string | null; - /** - * Output only. The pem-encoded, signed X.509 certificate. - */ - pemCertificate?: string | null; + export interface Schema$GeminiInstanceConfig { /** - * Output only. The pem-encoded chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246. + * Output only. Whether the Gemini in Databases add-on is enabled for the instance. It will be true only if the add-on has been enabled for the billing account corresponding to the instance. Its status is toggled from the Admin Control Center (ACC) and cannot be toggled using AlloyDB's APIs. */ - pemCertificateChain?: string[] | null; + entitled?: boolean | null; } /** * The response message for Locations.ListLocations. @@ -615,6 +616,23 @@ export namespace alloydb_v1beta { */ name?: string | null; } + /** + * Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp + */ + export interface Schema$GoogleTypeDate { + /** + * Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + */ + day?: number | null; + /** + * Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + */ + month?: number | null; + /** + * Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + */ + year?: number | null; + } /** * Represents 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`. */ @@ -693,6 +711,10 @@ export namespace alloydb_v1beta { * The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity. */ gceZone?: string | null; + /** + * Optional. Configuration parameters related to the Gemini in Databases add-on. See go/prd-enable-duet-ai-databases for more details. + */ + geminiConfig?: Schema$GeminiInstanceConfig; /** * Required. The type of the instance. Specified at creation time. */ @@ -721,6 +743,10 @@ export namespace alloydb_v1beta { * Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance. */ nodes?: Schema$Node[]; + /** + * Configuration for observability. + */ + observabilityConfig?: Schema$ObservabilityInstanceConfig; /** * Optional. The configuration for Private Service Connect (PSC) for the instance. */ @@ -895,6 +921,32 @@ export namespace alloydb_v1beta { */ cpuCount?: number | null; } + /** + * MaintenanceUpdatePolicy defines the policy for system updates. + */ + export interface Schema$MaintenanceUpdatePolicy { + /** + * Periods to deny maintenance. Currently limited to 1. + */ + denyMaintenancePeriods?: Schema$DenyMaintenancePeriod[]; + /** + * Preferred windows to perform maintenance. Currently limited to 1. + */ + maintenanceWindows?: Schema$MaintenanceWindow[]; + } + /** + * MaintenanceWindow specifies a preferred day and time for maintenance. + */ + export interface Schema$MaintenanceWindow { + /** + * Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc. + */ + day?: string | null; + /** + * Preferred time to start the maintenance operation on the specified day. Maintenance will start within 1 hour of this time. + */ + startTime?: Schema$GoogleTypeTimeOfDay; + } /** * Subset of the source instance configuration that is available when reading the cluster resource. */ @@ -946,6 +998,43 @@ export namespace alloydb_v1beta { */ zoneId?: string | null; } + /** + * Observability Instance specific configuration. + */ + export interface Schema$ObservabilityInstanceConfig { + /** + * Observability feature status for an instance. This is a read-only flag and modifiable only by producer API. This flag is turned "off" by default. + */ + enabled?: boolean | null; + /** + * Query string length. The default value is 10k. + */ + maxQueryStringLength?: number | null; + /** + * Preserve comments in query string for an instance. This flag is turned "off" by default. + */ + preserveComments?: boolean | null; + /** + * Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 to 20 is considered valid. + */ + queryPlansPerMinute?: number | null; + /** + * Record application tags for an instance. This flag is turned "off" by default. + */ + recordApplicationTags?: boolean | null; + /** + * Track actively running queries on the instance. If not set, this flag is "off" by default. + */ + trackActiveQueries?: boolean | null; + /** + * Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. + */ + trackWaitEvents?: boolean | null; + /** + * Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by producer API. + */ + trackWaitEventTypes?: boolean | null; + } /** * This resource represents a long-running operation that is the result of a network API call. */ @@ -1472,6 +1561,10 @@ export namespace alloydb_v1beta { * User-provided labels, represented as a dictionary where each label is a single key value pair. */ userLabels?: {[key: string]: string} | null; + /** + * User-provided labels associated with the resource + */ + userLabelSet?: Schema$StorageDatabasecenterPartnerapiV1mainUserLabels; } /** * Common model for database resource recommendation signal data. @@ -1545,6 +1638,12 @@ export namespace alloydb_v1beta { retentionUnit?: string | null; timeBasedRetention?: string | null; } + /** + * Message type for storing user labels. User labels are used to tag App Engine resources, allowing users to search for resources matching a set of labels and to aggregate usage data by labels. + */ + export interface Schema$StorageDatabasecenterPartnerapiV1mainUserLabels { + labels?: {[key: string]: string} | null; + } /** * Product specification for Condor resources. */ @@ -2720,102 +2819,6 @@ export namespace alloydb_v1beta { } } - /** - * Generate a client certificate signed by a Cluster CA. The sole purpose of this endpoint is to support AlloyDB connectors and the Auth Proxy client. The endpoint's behavior is subject to change without notice, so do not rely on its behavior remaining constant. Future changes will not break AlloyDB connectors or the Auth Proxy client. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - generateClientCertificate( - params: Params$Resource$Projects$Locations$Clusters$Generateclientcertificate, - options: StreamMethodOptions - ): GaxiosPromise; - generateClientCertificate( - params?: Params$Resource$Projects$Locations$Clusters$Generateclientcertificate, - options?: MethodOptions - ): GaxiosPromise; - generateClientCertificate( - params: Params$Resource$Projects$Locations$Clusters$Generateclientcertificate, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - generateClientCertificate( - params: Params$Resource$Projects$Locations$Clusters$Generateclientcertificate, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - generateClientCertificate( - params: Params$Resource$Projects$Locations$Clusters$Generateclientcertificate, - callback: BodyResponseCallback - ): void; - generateClientCertificate( - callback: BodyResponseCallback - ): void; - generateClientCertificate( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Clusters$Generateclientcertificate - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Clusters$Generateclientcertificate; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Clusters$Generateclientcertificate; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1beta/{+parent}:generateClientCertificate' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - /** * Gets details of a single Cluster. * @@ -3322,18 +3325,6 @@ export namespace alloydb_v1beta { */ validateOnly?: boolean; } - export interface Params$Resource$Projects$Locations$Clusters$Generateclientcertificate - extends StandardParameters { - /** - * Required. The name of the parent resource. The required format is: * projects/{project\}/locations/{location\}/clusters/{cluster\} - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GenerateClientCertificateRequest; - } export interface Params$Resource$Projects$Locations$Clusters$Get extends StandardParameters { /** diff --git a/src/apis/androidpublisher/v3.ts b/src/apis/androidpublisher/v3.ts index e94625c510..a2c7ade7df 100644 --- a/src/apis/androidpublisher/v3.ts +++ b/src/apis/androidpublisher/v3.ts @@ -2259,6 +2259,10 @@ export namespace androidpublisher_v3 { * The quantity associated with the purchase of the inapp product. If not present, the quantity is 1. */ quantity?: number | null; + /** + * The quantity eligible for refund, i.e. quantity that hasn't been refunded. The value reflects quantity-based partial refunds and full refunds. + */ + refundableQuantity?: number | null; /** * ISO 3166-1 alpha-2 billing region code of the user at the time the product was granted. */ @@ -3671,6 +3675,10 @@ export namespace androidpublisher_v3 { * The token which uniquely identifies a one-time purchase or subscription. To uniquely identify subscription renewals use order_id (available starting from version 3 of the API). */ purchaseToken?: string | null; + /** + * The voided quantity as the result of a quantity-based partial refund. Voided purchases of quantity-based partial refunds may only be returned when includeQuantityBasedPartialRefund is set to true. + */ + voidedQuantity?: number | null; /** * The reason why the purchase was voided, possible values are: 0. Other 1. Remorse 2. Not_received 3. Defective 4. Accidental_purchase 5. Fraud 6. Friendly_fraud 7. Chargeback */ @@ -9167,7 +9175,7 @@ export namespace androidpublisher_v3 { export interface Params$Resource$Externaltransactions$Createexternaltransaction extends StandardParameters { /** - * Required. The id to use for the external transaction. Must be unique across all other transactions for the app. This value should be 1-63 characters and valid characters are /a-z0-9_-/. Do not use this field to store any Personally Identifiable Information (PII) such as emails. Attempting to store PII in this field may result in requests being blocked. + * Required. The id to use for the external transaction. Must be unique across all other transactions for the app. This value should be 1-63 characters and valid characters are /a-zA-Z0-9_-/. Do not use this field to store any Personally Identifiable Information (PII) such as emails. Attempting to store PII in this field may result in requests being blocked. */ externalTransactionId?: string; /** @@ -15214,6 +15222,10 @@ export namespace androidpublisher_v3 { * The time, in milliseconds since the Epoch, of the newest voided purchase that you want to see in the response. The value of this parameter cannot be greater than the current time and is ignored if a pagination token is set. Default value is current time. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response. */ endTime?: string; + /** + * Optional. Whether to include voided purchases of quantity-based partial refunds, which are applicable only to multi-quantity purchases. If true, additional voided purchases may be returned with voidedQuantity that indicates the refund quantity of a quantity-based partial refund. The default value is false. + */ + includeQuantityBasedPartialRefund?: boolean; /** * Defines how many results the list operation should return. The default number depends on the resource collection. */ diff --git a/src/apis/batch/README.md b/src/apis/batch/README.md index fe0b8dd25d..8cb43e236f 100644 --- a/src/apis/batch/README.md +++ b/src/apis/batch/README.md @@ -2,7 +2,7 @@ # batch -> An API to manage the running of batch resources on Google Cloud Platform. +> An API to manage the running of Batch resources on Google Cloud Platform. ## Support status **Note**: Google provides multiple libraries for this service. This library is in diff --git a/src/apis/batch/v1.ts b/src/apis/batch/v1.ts index b08bbdfe30..8cf5333d2b 100644 --- a/src/apis/batch/v1.ts +++ b/src/apis/batch/v1.ts @@ -102,7 +102,7 @@ export namespace batch_v1 { /** * Batch API * - * An API to manage the running of batch resources on Google Cloud Platform. + * An API to manage the running of Batch resources on Google Cloud Platform. * * @example * ```js @@ -380,7 +380,7 @@ export namespace batch_v1 { */ environment?: Schema$AgentEnvironment; /** - * Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit. + * Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit. The valid value range for max_run_duration in seconds is [0, 315576000000.999999999], */ maxRunDuration?: string | null; /** @@ -1272,7 +1272,7 @@ export namespace batch_v1 { */ maxRetryCount?: number | null; /** - * Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit. + * Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit. The valid value range for max_run_duration in seconds is [0, 315576000000.999999999], */ maxRunDuration?: string | null; /** diff --git a/src/apis/bigqueryreservation/v1.ts b/src/apis/bigqueryreservation/v1.ts index 8ddc9d5f73..4323bbf383 100644 --- a/src/apis/bigqueryreservation/v1.ts +++ b/src/apis/bigqueryreservation/v1.ts @@ -232,6 +232,10 @@ export namespace bigqueryreservation_v1 { * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} */ export interface Schema$Empty {} + /** + * The request for ReservationService.FailoverReservation. + */ + export interface Schema$FailoverReservationRequest {} /** * The response for ReservationService.ListAssignments. */ @@ -325,6 +329,18 @@ export namespace bigqueryreservation_v1 { * The resource name of the reservation, e.g., `projects/x/locations/x/reservations/team1-prod`. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters. */ name?: string | null; + /** + * Optional. The original primary location of the reservation which is set only during its creation and remains unchanged afterwards. It can be used by the customer to answer questions about disaster recovery billing. The field is output only for customers and should not be specified, however, the google.api.field_behavior is not set to OUTPUT_ONLY since these fields are set in rerouted requests sent across regions. + */ + originalPrimaryLocation?: string | null; + /** + * Optional. The primary location of the reservation. The field is only meaningful for reservation used for cross region disaster recovery. The field is output only for customers and should not be specified, however, the google.api.field_behavior is not set to OUTPUT_ONLY since these fields are set in rerouted requests sent across regions. + */ + primaryLocation?: string | null; + /** + * Optional. The secondary location of the reservation which is used for cross region disaster recovery purposes. Customer can set this in create/update reservation calls to create a failover reservation or convert a non-failover reservation to a failover reservation. + */ + secondaryLocation?: string | null; /** * Baseline slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false, or autoscaling is enabled. If edition is EDITION_UNSPECIFIED and total slot_capacity of the reservation and its siblings exceeds the total slot_count of all capacity commitments, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`. If edition is any value but EDITION_UNSPECIFIED, then the above requirement is not needed. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes. */ @@ -1792,6 +1808,97 @@ export namespace bigqueryreservation_v1 { } } + /** + * Failover a reservation to the secondary location. The operation should be done in the current secondary location, which will be promoted to the new primary location for the reservation. Attempting to failover a reservation in the current primary location will fail with the error code `google.rpc.Code.FAILED_PRECONDITION`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + failoverReservation( + params: Params$Resource$Projects$Locations$Reservations$Failoverreservation, + options: StreamMethodOptions + ): GaxiosPromise; + failoverReservation( + params?: Params$Resource$Projects$Locations$Reservations$Failoverreservation, + options?: MethodOptions + ): GaxiosPromise; + failoverReservation( + params: Params$Resource$Projects$Locations$Reservations$Failoverreservation, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + failoverReservation( + params: Params$Resource$Projects$Locations$Reservations$Failoverreservation, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + failoverReservation( + params: Params$Resource$Projects$Locations$Reservations$Failoverreservation, + callback: BodyResponseCallback + ): void; + failoverReservation( + callback: BodyResponseCallback + ): void; + failoverReservation( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Reservations$Failoverreservation + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Reservations$Failoverreservation; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Reservations$Failoverreservation; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigqueryreservation.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:failoverReservation').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Returns information about the reservation. * @@ -2079,6 +2186,18 @@ export namespace bigqueryreservation_v1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Reservations$Failoverreservation + extends StandardParameters { + /** + * Required. Resource name of the reservation to failover. E.g., `projects/myproject/locations/US/reservations/team1-prod` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FailoverReservationRequest; + } export interface Params$Resource$Projects$Locations$Reservations$Get extends StandardParameters { /** diff --git a/src/apis/bigtableadmin/v2.ts b/src/apis/bigtableadmin/v2.ts index 0c2667962e..86b9035714 100644 --- a/src/apis/bigtableadmin/v2.ts +++ b/src/apis/bigtableadmin/v2.ts @@ -130,6 +130,10 @@ export namespace bigtableadmin_v2 { * A configuration object describing how Cloud Bigtable should treat traffic from a particular end user application. */ export interface Schema$AppProfile { + /** + * Specifies that this app profile is intended for read-only usage via the Data Boost feature. + */ + dataBoostIsolationReadOnly?: Schema$DataBoostIsolationReadOnly; /** * Long form description of the use case for this AppProfile. */ @@ -345,6 +349,14 @@ export namespace bigtableadmin_v2 { * Required. The token created using GenerateConsistencyToken for the Table. */ consistencyToken?: string | null; + /** + * Checks that reads using an app profile with `DataBoostIsolationReadOnly` can see all writes committed before the token was created, but only if the read and write target the same cluster. + */ + dataBoostReadLocalWrites?: Schema$DataBoostReadLocalWrites; + /** + * Checks that reads using an app profile with `StandardIsolation` can see all writes committed before the token was created, even if the read and write target different clusters. + */ + standardReadRemoteWrites?: Schema$StandardReadRemoteWrites; } /** * Response message for google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency @@ -435,6 +447,10 @@ export namespace bigtableadmin_v2 { * Output only. Only available with STATS_VIEW, this includes summary statistics about column family contents. For statistics over an entire table, see TableStats above. */ stats?: Schema$ColumnFamilyStats; + /** + * The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + */ + valueType?: Schema$Type; } /** * Approximate statistics related to a single column family within a table. This information may change rapidly, interpreting these values at a point in time may already preset out-of-date information. Everything below is approximate, unless otherwise specified. @@ -635,6 +651,19 @@ export namespace bigtableadmin_v2 { */ tableId?: string | null; } + /** + * Data Boost is a serverless compute capability that lets you run high-throughput read jobs on your Bigtable data, without impacting the performance of the clusters that handle your application traffic. Currently, Data Boost exclusively supports read-only use-cases with single-cluster routing. Data Boost reads are only guaranteed to see the results of writes that were written at least 30 minutes ago. This means newly written values may not become visible for up to 30m, and also means that old values may remain visible for up to 30m after being deleted or overwritten. To mitigate the staleness of the data, users may either wait 30m, or use CheckConsistency. + */ + export interface Schema$DataBoostIsolationReadOnly { + /** + * The Compute Billing Owner for this Data Boost App Profile. + */ + computeBillingOwner?: string | null; + } + /** + * Checks that all writes before the consistency token was generated in the same cluster are readable by Databoost. + */ + export interface Schema$DataBoostReadLocalWrites {} /** * Request message for google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange */ @@ -779,6 +808,76 @@ export namespace bigtableadmin_v2 { */ rowPrefixes?: string[] | null; } + /** + * A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . + */ + export interface Schema$GoogleBigtableAdminV2TypeAggregate { + /** + * Type of the inputs that are accumulated by this `Aggregate`, which must specify a full encoding. Use `AddInput` mutations to accumulate new inputs. + */ + inputType?: Schema$Type; + /** + * Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen, and will always specify a full encoding. + */ + stateType?: Schema$Type; + /** + * Sum aggregator. + */ + sum?: Schema$GoogleBigtableAdminV2TypeAggregateSum; + } + /** + * Computes the sum of the input values. Allowed input: `Int64` State: same as input + */ + export interface Schema$GoogleBigtableAdminV2TypeAggregateSum {} + /** + * Bytes Values of type `Bytes` are stored in `Value.bytes_value`. + */ + export interface Schema$GoogleBigtableAdminV2TypeBytes { + /** + * The encoding to use when converting to/from lower level types. + */ + encoding?: Schema$GoogleBigtableAdminV2TypeBytesEncoding; + } + /** + * Rules used to convert to/from lower level types. + */ + export interface Schema$GoogleBigtableAdminV2TypeBytesEncoding { + /** + * Use `Raw` encoding. + */ + raw?: Schema$GoogleBigtableAdminV2TypeBytesEncodingRaw; + } + /** + * Leaves the value "as-is" * Natural sort? Yes * Self-delimiting? No * Compatibility? N/A + */ + export interface Schema$GoogleBigtableAdminV2TypeBytesEncodingRaw {} + /** + * Int64 Values of type `Int64` are stored in `Value.int_value`. + */ + export interface Schema$GoogleBigtableAdminV2TypeInt64 { + /** + * The encoding to use when converting to/from lower level types. + */ + encoding?: Schema$GoogleBigtableAdminV2TypeInt64Encoding; + } + /** + * Rules used to convert to/from lower level types. + */ + export interface Schema$GoogleBigtableAdminV2TypeInt64Encoding { + /** + * Use `BigEndianBytes` encoding. + */ + bigEndianBytes?: Schema$GoogleBigtableAdminV2TypeInt64EncodingBigEndianBytes; + } + /** + * Encodes the value as an 8-byte big endian twos complement `Bytes` value. * Natural sort? No (positive values only) * Self-delimiting? Yes * Compatibility? - BigQuery Federation `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` + */ + export interface Schema$GoogleBigtableAdminV2TypeInt64EncodingBigEndianBytes { + /** + * The underlying `Bytes` type, which may be able to encode further. + */ + bytesType?: Schema$GoogleBigtableAdminV2TypeBytes; + } /** * A tablet is a defined by a start and end key and is explained in https://cloud.google.com/bigtable/docs/overview#architecture and https://cloud.google.com/bigtable/docs/performance#optimization. A Hot tablet is a tablet that exhibits high average cpu usage during the time interval from start time to end time. */ @@ -1266,6 +1365,10 @@ export namespace bigtableadmin_v2 { */ priority?: string | null; } + /** + * Checks that all writes before the consistency token was generated are replicated in every cluster and readable. + */ + export interface Schema$StandardReadRemoteWrites {} /** * 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). */ @@ -1377,6 +1480,23 @@ export namespace bigtableadmin_v2 { */ permissions?: string[] | null; } + /** + * `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. This might involve composing a series of steps into an "encoding chain," for example to convert from INT64 -\> STRING -\> raw bytes. In most cases, a "link" in the encoding chain will be based an on existing GoogleSQL conversion function like `CAST`. Each link in the encoding chain also defines the following properties: * Natural sort: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: STRING values sort in the same order as their UTF-8 encodings. - Counterexample: Encoding INT64 to a fixed-width STRING does *not* preserve sort order when dealing with negative numbers. INT64(1) \> INT64(-1), but STRING("-00001") \> STRING("00001). - The overall encoding chain sorts naturally if *every* link does. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. - The overall encoding chain is self-delimiting if *any* link is. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? + */ + export interface Schema$Type { + /** + * Aggregate + */ + aggregateType?: Schema$GoogleBigtableAdminV2TypeAggregate; + /** + * Bytes + */ + bytesType?: Schema$GoogleBigtableAdminV2TypeBytes; + /** + * Int64 + */ + int64Type?: Schema$GoogleBigtableAdminV2TypeInt64; + } /** * Metadata type for the operation returned by google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTable. */ diff --git a/src/apis/certificatemanager/v1.ts b/src/apis/certificatemanager/v1.ts index b97d0b68aa..d994e40e01 100644 --- a/src/apis/certificatemanager/v1.ts +++ b/src/apis/certificatemanager/v1.ts @@ -124,6 +124,15 @@ export namespace certificatemanager_v1 { } } + /** + * Defines an allowlisted certificate. + */ + export interface Schema$AllowlistedCertificate { + /** + * Required. PEM certificate that is allowlisted. The certificate can be up to 5k bytes, and must be a parseable X.509 certificate. + */ + pemCertificate?: string | null; + } /** * State of the latest attempt to authorize a domain for certificate issuance. */ @@ -720,6 +729,10 @@ export namespace certificatemanager_v1 { * Defines a trust config. */ export interface Schema$TrustConfig { + /** + * Optional. A certificate matching an allowlisted certificate is always considered valid as long as the certificate is parseable, proof of private key possession is established, and constraints on the certificate’s SAN field are met. + */ + allowlistedCertificates?: Schema$AllowlistedCertificate[]; /** * Output only. The creation timestamp of a TrustConfig. */ diff --git a/src/apis/chat/v1.ts b/src/apis/chat/v1.ts index a8dea9d904..354965792b 100644 --- a/src/apis/chat/v1.ts +++ b/src/apis/chat/v1.ts @@ -471,7 +471,7 @@ export namespace chat_v1 { deletionType?: string | null; } /** - * A Google Chat app interaction event. To learn about interaction events, see [Receive and respond to interactions with your Google Chat app](https://developers.google.com/chat/api/guides/message-formats). To learn about event types and for example event payloads, see [Types of Google Chat app interaction events](https://developers.google.com/chat/api/guides/message-formats/events). + * A Google Chat app interaction event. To learn about interaction events, see [Receive and respond to interactions with your Google Chat app](https://developers.google.com/workspace/chat/api/guides/message-formats). To learn about event types and for example event payloads, see [Types of Google Chat app interaction events](https://developers.google.com/workspace/chat/events). In addition to receiving events from user interactions, Chat apps can receive events about changes to spaces, such as when a new member is added to a space. To learn about space events, see [Work with events from Google Chat](https://developers.google.com/workspace/chat/events-overview). */ export interface Schema$DeprecatedEvent { /** @@ -515,7 +515,7 @@ export namespace chat_v1 { */ token?: string | null; /** - * The type of interaction event. For details, see [Types of Google Chat app interaction events](https://developers.google.com/chat/api/guides/message-formats/events). + * The type of interaction event. For details, see [Types of Google Chat app interaction events](https://developers.google.com/workspace/chat/events). */ type?: string | null; /** @@ -969,6 +969,10 @@ export namespace chat_v1 { * Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/chat/format-messages#builtinicons). */ knownIcon?: string | null; + /** + * Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use "material_icon": { "name": "check_box" \} Available for Chat apps and in [Developer Preview](https://developers.google.com/workspace/preview) for Google Workspace Add-ons. + */ + materialIcon?: Schema$GoogleAppsCardV1MaterialIcon; } /** * An image that is specified by a URL and can have an `onClick` action. For an example, see [Image](https://developers.google.com/chat/ui/widgets/image). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): @@ -1021,6 +1025,27 @@ export namespace chat_v1 { */ type?: string | null; } + /** + * A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write { "name": "check_box", "fill": true, "weight": 300, "grade": -25 \} Available for Chat apps and in [Developer Preview](https://developers.google.com/workspace/preview) for Google Workspace Add-ons. + */ + export interface Schema$GoogleAppsCardV1MaterialIcon { + /** + * Whether it renders a filled icon. Default value is false. See Customization in [Google Font Icon](https://fonts.google.com/icons) for details. + */ + fill?: boolean | null; + /** + * Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200\}. If absent, default value is 0. If any other value is specified, a broken image icon is displayed. See Customization in [Google Font Icon](https://fonts.google.com/icons) for details. + */ + grade?: number | null; + /** + * The icon name defined in the [Google Material Icon Icon](https://fonts.google.com/icons) in snake_case. e.g. "check_box". Any invalid names are abandoned and replaced with empty string and results in the icon failing to render. + */ + name?: string | null; + /** + * The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700\}. If absent, default value is 400. If any other value is specified, a broken image icon is displayed. See Customization in [Google Font Icon](https://fonts.google.com/icons) for details. + */ + weight?: number | null; + } /** * Represents how to respond when users click an interactive element on a card, such as a button. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): */ diff --git a/src/apis/chromemanagement/v1.ts b/src/apis/chromemanagement/v1.ts index b989b35e4f..44b7996b0b 100644 --- a/src/apis/chromemanagement/v1.ts +++ b/src/apis/chromemanagement/v1.ts @@ -547,6 +547,32 @@ export namespace chromemanagement_v1 { */ recentlyEnrolledCount?: string | null; } + /** + * Response contains a list of CrashEventCountByVersionPerDay which count the chrome crash at the certain date. + */ + export interface Schema$GoogleChromeManagementV1CountChromeCrashEventsResponse { + /** + * Crash event counts grouped by date and browser version. + */ + crashEventCounts?: Schema$GoogleChromeManagementV1CountChromeCrashEventsResponseCrashEventCount[]; + } + /** + * The `count` of the Chrome crash events at the `date`. + */ + export interface Schema$GoogleChromeManagementV1CountChromeCrashEventsResponseCrashEventCount { + /** + * Browser version this is counting. + */ + browserVersion?: string | null; + /** + * Total count of crash events. + */ + count?: string | null; + /** + * Date of the crash event. + */ + date?: Schema$GoogleTypeDate; + } /** * Response containing a list of devices expiring in each month of a selected time frame. Counts are grouped by model and Auto Update Expiration date. */ @@ -2888,6 +2914,102 @@ export namespace chromemanagement_v1 { } } + /** + * Get a count of Chrome crash events. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + countChromeCrashEvents( + params: Params$Resource$Customers$Reports$Countchromecrashevents, + options: StreamMethodOptions + ): GaxiosPromise; + countChromeCrashEvents( + params?: Params$Resource$Customers$Reports$Countchromecrashevents, + options?: MethodOptions + ): GaxiosPromise; + countChromeCrashEvents( + params: Params$Resource$Customers$Reports$Countchromecrashevents, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + countChromeCrashEvents( + params: Params$Resource$Customers$Reports$Countchromecrashevents, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + countChromeCrashEvents( + params: Params$Resource$Customers$Reports$Countchromecrashevents, + callback: BodyResponseCallback + ): void; + countChromeCrashEvents( + callback: BodyResponseCallback + ): void; + countChromeCrashEvents( + paramsOrCallback?: + | Params$Resource$Customers$Reports$Countchromecrashevents + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customers$Reports$Countchromecrashevents; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customers$Reports$Countchromecrashevents; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://chromemanagement.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+customer}/reports:countChromeCrashEvents' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['customer'], + pathParams: ['customer'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Generate report of the number of devices expiring in each month of the selected time frame. Devices are grouped by auto update expiration date and model. Further information can be found [here](https://support.google.com/chrome/a/answer/10564947). * @@ -3772,6 +3894,25 @@ export namespace chromemanagement_v1 { */ orgUnitId?: string; } + export interface Params$Resource$Customers$Reports$Countchromecrashevents + extends StandardParameters { + /** + * Customer ID. + */ + customer?: string; + /** + * Query string to filter results, AND-separated fields in EBNF syntax. Supported filter fields: * major_browser_version * minor_browser_version * browser_channel * device_platform * past_number_days Example: `major_browser_version = 'M115' AND past_number_days = '28'`. + */ + filter?: string; + /** + * Field used to order results. Supported order by fields: * browser_version * count * date + */ + orderBy?: string; + /** + * If specified, only count the number of crash events of the devices in this organizational unit. + */ + orgUnitId?: string; + } export interface Params$Resource$Customers$Reports$Countchromedevicesreachingautoexpirationdate extends StandardParameters { /** @@ -4216,7 +4357,7 @@ export namespace chromemanagement_v1 { export interface Params$Resource$Customers$Telemetry$Devices$List extends StandardParameters { /** - * Optional. Only include resources that match the filter. Supported filter fields: - org_unit_id - serial_number - device_id - reports_timestamp The "reports_timestamp" filter accepts either the Unix Epoch milliseconds format or the RFC3339 UTC "Zulu" format with nanosecond resolution and up to nine fractional digits. Both formats should be surrounded by simple double quotes. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", "1679283943823". + * Optional. Only include resources that match the filter. Requests that don't specify a "reports_timestamp" value will default to returning only recent reports. Specify "reports_timestamp\>=0" to get all report data. Supported filter fields: - org_unit_id - serial_number - device_id - reports_timestamp The "reports_timestamp" filter accepts either the Unix Epoch milliseconds format or the RFC3339 UTC "Zulu" format with nanosecond resolution and up to nine fractional digits. Both formats should be surrounded by simple double quotes. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", "1679283943823". */ filter?: string; /** diff --git a/src/apis/cloudbilling/v1beta.ts b/src/apis/cloudbilling/v1beta.ts index 777cbf41ab..d17ad8f964 100644 --- a/src/apis/cloudbilling/v1beta.ts +++ b/src/apis/cloudbilling/v1beta.ts @@ -113,7 +113,6 @@ export namespace cloudbilling_v1beta { export class Cloudbilling { context: APIRequestContext; billingAccounts: Resource$Billingaccounts; - projects: Resource$Projects; skuGroups: Resource$Skugroups; skus: Resource$Skus; v1beta: Resource$V1beta; @@ -125,7 +124,6 @@ export namespace cloudbilling_v1beta { }; this.billingAccounts = new Resource$Billingaccounts(this.context); - this.projects = new Resource$Projects(this.context); this.skuGroups = new Resource$Skugroups(this.context); this.skus = new Resource$Skus(this.context); this.v1beta = new Resource$V1beta(this.context); @@ -482,102 +480,6 @@ export namespace cloudbilling_v1beta { */ estimationTimeFrameOffset?: string | null; } - /** - * Encapsulates an anomaly. - */ - export interface Schema$GoogleCloudBillingAnomaliesV1betaAnomaly { - /** - * Time that the anomaly was detected. Will be set to 00:00 google time of the detected date. - */ - detectionTime?: string | null; - /** - * Deviation information of the anomaly. - */ - deviation?: Schema$GoogleCloudBillingAnomaliesV1betaAnomalyDeviation; - /** - * Identifier. Resource name for the anomaly. - */ - name?: string | null; - /** - * The display name of the resource that the anomaly occurred in/belongs to. - */ - resourceDisplayName?: string | null; - /** - * A list of causes which contribute to the anomaly. - */ - rootCauses?: Schema$GoogleCloudBillingAnomaliesV1betaCause[]; - /** - * Indicate the scope of the anomaly. - */ - scope?: string | null; - /** - * Severity of the anomaly. Unspecified if severity is not met/assigned. - */ - severity?: string | null; - /** - * Output only. The most recent anomaly's last updated time. - */ - updateTime?: string | null; - } - /** - * Encapsulates the deviation information. - */ - export interface Schema$GoogleCloudBillingAnomaliesV1betaAnomalyDeviation { - /** - * The actual spend for the anomaly. - */ - actualSpend?: Schema$Money; - /** - * The difference between the actual spend and expected spend's upper bound. Calculation formula: deviation_amount = actual_spend - expected_spend. - */ - deviationAmount?: Schema$Money; - /** - * The percentage of devition amount from expected spend's upper bound. Calculation formula: deviation_percentage = divation_amount / expected_spend * 100. - */ - deviationPercentage?: number | null; - /** - * The expected spend for the anomaly. - */ - expectedSpend?: Schema$Money; - } - /** - * Encapsulates the information of the reason which caused the anomaly. - */ - export interface Schema$GoogleCloudBillingAnomaliesV1betaCause { - /** - * The cause type. - */ - causeType?: string | null; - /** - * The deviation information for the cause. - */ - deviation?: Schema$GoogleCloudBillingAnomaliesV1betaAnomalyDeviation; - /** - * The display name of the cause. - */ - displayName?: string | null; - /** - * The resource name of the cause. project: projects/{project\}. service: services/{service\}. sku: services/{service\}/skus/{sku\}. location: locations/{location\}. - */ - resource?: string | null; - /** - * The sub causes. - */ - subCauses?: Schema$GoogleCloudBillingAnomaliesV1betaCause[]; - } - /** - * Response message for ListAnomalies. - */ - export interface Schema$GoogleCloudBillingAnomaliesV1betaListAnomaliesResponse { - /** - * The returned anomalies. - */ - anomalies?: Schema$GoogleCloudBillingAnomaliesV1betaAnomaly[]; - /** - * Token that can be sent as `page_token` in the subsequent request to retrieve the next page. If this field is empty, there are no subsequent pages. - */ - nextPageToken?: string | null; - } /** * Encapsulates the aggregation information such as aggregation level and interval for a billing account price. */ @@ -1705,13 +1607,11 @@ export namespace cloudbilling_v1beta { export class Resource$Billingaccounts { context: APIRequestContext; - anomalies: Resource$Billingaccounts$Anomalies; services: Resource$Billingaccounts$Services; skuGroups: Resource$Billingaccounts$Skugroups; skus: Resource$Billingaccounts$Skus; constructor(context: APIRequestContext) { this.context = context; - this.anomalies = new Resource$Billingaccounts$Anomalies(this.context); this.services = new Resource$Billingaccounts$Services(this.context); this.skuGroups = new Resource$Billingaccounts$Skugroups(this.context); this.skus = new Resource$Billingaccounts$Skus(this.context); @@ -1826,229 +1726,6 @@ export namespace cloudbilling_v1beta { requestBody?: Schema$EstimateCostScenarioForBillingAccountRequest; } - export class Resource$Billingaccounts$Anomalies { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Gets an anomaly for a billing account or a project. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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$Billingaccounts$Anomalies$Get, - options: StreamMethodOptions - ): GaxiosPromise; - get( - params?: Params$Resource$Billingaccounts$Anomalies$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Billingaccounts$Anomalies$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Billingaccounts$Anomalies$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Billingaccounts$Anomalies$Get, - callback: BodyResponseCallback - ): void; - get( - callback: BodyResponseCallback - ): void; - get( - paramsOrCallback?: - | Params$Resource$Billingaccounts$Anomalies$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Billingaccounts$Anomalies$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Billingaccounts$Anomalies$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://cloudbilling.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Lists anomalies for a billing account or a project. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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$Billingaccounts$Anomalies$List, - options: StreamMethodOptions - ): GaxiosPromise; - list( - params?: Params$Resource$Billingaccounts$Anomalies$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Billingaccounts$Anomalies$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Billingaccounts$Anomalies$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Billingaccounts$Anomalies$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Billingaccounts$Anomalies$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Billingaccounts$Anomalies$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Billingaccounts$Anomalies$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://cloudbilling.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta/{+parent}/anomalies').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Billingaccounts$Anomalies$Get - extends StandardParameters { - /** - * Required. Format for project: projects/{project\}/anomalies/{anomalies\}. Format for billing account: billingAccounts/{billing_account\}/anomalies/{anomalies\}. - */ - name?: string; - } - export interface Params$Resource$Billingaccounts$Anomalies$List - extends StandardParameters { - /** - * Optional. Options for how to filter the anomalies. Currently, only filter on `start_time` and `end_time` is supported. Only =, AND operators are supported. If start_time and/or end_time empty, we only retrieve the most recent 30 days' anomalies. Examples: - start_time = "20231201" AND end_time = "20240120" . - */ - filter?: string; - /** - * Optional. Maximum number of anomalies to return. Results may return fewer than this value. Default value is 50 and maximum value is 1000. - */ - pageSize?: number; - /** - * Optional. Page token received from a previous ListAnomalies call to retrieve the next page of results. If this field is empty, the first page is returned. - */ - pageToken?: string; - /** - * Required. The project to list Anomaly for the project. Format for project: projects/{project\}. Format for billing account: billingAccounts/{billing_account\}. - */ - parent?: string; - } - export class Resource$Billingaccounts$Services { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -3170,238 +2847,6 @@ export namespace cloudbilling_v1beta { parent?: string; } - export class Resource$Projects { - context: APIRequestContext; - anomalies: Resource$Projects$Anomalies; - constructor(context: APIRequestContext) { - this.context = context; - this.anomalies = new Resource$Projects$Anomalies(this.context); - } - } - - export class Resource$Projects$Anomalies { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Gets an anomaly for a billing account or a project. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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$Anomalies$Get, - options: StreamMethodOptions - ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Anomalies$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Anomalies$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Anomalies$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Anomalies$Get, - callback: BodyResponseCallback - ): void; - get( - callback: BodyResponseCallback - ): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Anomalies$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Anomalies$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Anomalies$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://cloudbilling.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Lists anomalies for a billing account or a project. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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$Anomalies$List, - options: StreamMethodOptions - ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Anomalies$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Anomalies$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Anomalies$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Anomalies$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Anomalies$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Anomalies$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Anomalies$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://cloudbilling.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta/{+parent}/anomalies').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - 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$Anomalies$Get - extends StandardParameters { - /** - * Required. Format for project: projects/{project\}/anomalies/{anomalies\}. Format for billing account: billingAccounts/{billing_account\}/anomalies/{anomalies\}. - */ - name?: string; - } - export interface Params$Resource$Projects$Anomalies$List - extends StandardParameters { - /** - * Optional. Options for how to filter the anomalies. Currently, only filter on `start_time` and `end_time` is supported. Only =, AND operators are supported. If start_time and/or end_time empty, we only retrieve the most recent 30 days' anomalies. Examples: - start_time = "20231201" AND end_time = "20240120" . - */ - filter?: string; - /** - * Optional. Maximum number of anomalies to return. Results may return fewer than this value. Default value is 50 and maximum value is 1000. - */ - pageSize?: number; - /** - * Optional. Page token received from a previous ListAnomalies call to retrieve the next page of results. If this field is empty, the first page is returned. - */ - pageToken?: string; - /** - * Required. The project to list Anomaly for the project. Format for project: projects/{project\}. Format for billing account: billingAccounts/{billing_account\}. - */ - parent?: string; - } - export class Resource$Skugroups { context: APIRequestContext; skus: Resource$Skugroups$Skus; diff --git a/src/apis/cloudbuild/v2.ts b/src/apis/cloudbuild/v2.ts index 36afdf7b2b..e74eeb7e09 100644 --- a/src/apis/cloudbuild/v2.ts +++ b/src/apis/cloudbuild/v2.ts @@ -3783,7 +3783,7 @@ export namespace cloudbuild_v2 { export interface Params$Resource$Projects$Locations$Connections$Repositories$Fetchgitrefs extends StandardParameters { /** - * Optional. Number of results to return in the list. Default to 100. + * Optional. Number of results to return in the list. Default to 20. */ pageSize?: number; /** diff --git a/src/apis/clouderrorreporting/v1beta1.ts b/src/apis/clouderrorreporting/v1beta1.ts index e55bff049d..64b9d89114 100644 --- a/src/apis/clouderrorreporting/v1beta1.ts +++ b/src/apis/clouderrorreporting/v1beta1.ts @@ -608,7 +608,7 @@ export namespace clouderrorreporting_v1beta1 { } /** - * Report an individual error event and record the event to a log. This endpoint accepts **either** an OAuth token, **or** an [API key](https://support.google.com/cloud/answer/6158862) for authentication. To use an API key, append it to the URL as the value of a `key` parameter. For example: `POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName\}/events:report?key=123ABC456` **Note:** [Error Reporting] (https://cloud.google.com/error-reporting) is a global service built on Cloud Logging and doesn't analyze logs stored in regional log buckets or logs routed to other Google Cloud projects. + * Report an individual error event and record the event to a log. This endpoint accepts **either** an OAuth token, **or** an [API key](https://support.google.com/cloud/answer/6158862) for authentication. To use an API key, append it to the URL as the value of a `key` parameter. For example: `POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName\}/events:report?key=123ABC456` **Note:** [Error Reporting] (https://cloud.google.com/error-reporting) is a global service built on Cloud Logging and doesn't analyze logs stored in regional log buckets. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/cloudsupport/v2beta.ts b/src/apis/cloudsupport/v2beta.ts index d8ef1018f6..138faa7785 100644 --- a/src/apis/cloudsupport/v2beta.ts +++ b/src/apis/cloudsupport/v2beta.ts @@ -284,10 +284,6 @@ export namespace cloudsupport_v2beta { * The unique ID for a classification. Must be specified for case creation. To retrieve valid classification IDs for case creation, use `caseClassifications.search`. Classification IDs returned by `caseClassifications.search` are guaranteed to be valid for at least 6 months. If a given classification is deactiveated, it will immediately stop being returned. After 6 months, `case.create` requests using the classification ID will fail. */ id?: string | null; - /** - * The full product the classification corresponds to. - */ - product?: Schema$Product; } /** * The request message for the CloseCase endpoint. @@ -694,19 +690,6 @@ export namespace cloudsupport_v2beta { */ objectName?: string | null; } - /** - * The full product a case may be associated with, including Product Line and Product Subline. - */ - export interface Schema$Product { - /** - * The Product Line of the Product. - */ - productLine?: string | null; - /** - * The Product Subline of the Product, such as "Maps Billing". - */ - productSubline?: string | null; - } /** * The response message for SearchCaseClassifications endpoint. */ @@ -864,14 +847,6 @@ export namespace cloudsupport_v2beta { * A token identifying the page of results to return. If unspecified, the first page is retrieved. */ pageToken?: string; - /** - * The Product Line of the Product. - */ - 'product.productLine'?: string; - /** - * The Product Subline of the Product, such as "Maps Billing". - */ - 'product.productSubline'?: string; /** * An expression used to filter case classifications. If it's an empty string, then no filtering happens. Otherwise, case classifications will be returned that match the filter. */ @@ -1547,10 +1522,6 @@ export namespace cloudsupport_v2beta { * Required. The name of a parent to list cases under. */ parent?: string; - /** - * The product line for which to request cases for. If unspecified, only Google Cloud cases will be returned. - */ - productLine?: string; } export interface Params$Resource$Cases$Patch extends StandardParameters { /** diff --git a/src/apis/composer/v1.ts b/src/apis/composer/v1.ts index c9e8f35083..0203565f0f 100644 --- a/src/apis/composer/v1.ts +++ b/src/apis/composer/v1.ts @@ -232,7 +232,7 @@ export namespace composer_v1 { statusMessage?: string | null; } /** - * Configuration for resources used by Airflow DAG processors. + * Configuration for resources used by Airflow DAG processors. This field is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer. */ export interface Schema$DagProcessorResource { /** @@ -278,7 +278,7 @@ export namespace composer_v1 { */ export interface Schema$DataRetentionConfig { /** - * Optional. The retention policy for airflow metadata database. Details: go/composer-database-retention-2 + * Optional. The retention policy for airflow metadata database. */ airflowMetadataRetentionConfig?: Schema$AirflowMetadataRetentionPolicyConfig; /** @@ -394,7 +394,7 @@ export namespace composer_v1 { */ gkeCluster?: string | null; /** - * Optional. The maintenance window is the period when Cloud Composer components may undergo maintenance. It is defined so that maintenance is not executed during peak hours or critical time periods. The system will not be under maintenance for every occurrence of this window, but when maintenance is planned, it will be scheduled during the window. The maintenance window period must encompass at least 12 hours per week. This may be split into multiple chunks, each with a size of at least 4 hours. If this value is omitted, the default value for maintenance window will be applied. The default value is Saturday and Sunday 00-06 GMT. + * Optional. The maintenance window is the period when Cloud Composer components may undergo maintenance. It is defined so that maintenance is not executed during peak hours or critical time periods. The system will not be under maintenance for every occurrence of this window, but when maintenance is planned, it will be scheduled during the window. The maintenance window period must encompass at least 12 hours per week. This may be split into multiple chunks, each with a size of at least 4 hours. If this value is omitted, the default value for maintenance window is applied. By default, maintenance windows are from 00:00:00 to 04:00:00 (GMT) on Friday, Saturday, and Sunday every week. */ maintenanceWindow?: Schema$MaintenanceWindow; /** @@ -1101,7 +1101,7 @@ export namespace composer_v1 { */ export interface Schema$TaskLogsRetentionConfig { /** - * Optional. The mode of storage for Airflow workers task logs. For details, see go/composer-store-task-logs-in-cloud-logging-only-design-doc + * Optional. The mode of storage for Airflow workers task logs. */ storageMode?: string | null; } diff --git a/src/apis/composer/v1beta1.ts b/src/apis/composer/v1beta1.ts index d2aa8909c5..e16e665085 100644 --- a/src/apis/composer/v1beta1.ts +++ b/src/apis/composer/v1beta1.ts @@ -241,7 +241,7 @@ export namespace composer_v1beta1 { statusMessage?: string | null; } /** - * Configuration for resources used by Airflow DAG processors. + * Configuration for resources used by Airflow DAG processors. This field is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer. */ export interface Schema$DagProcessorResource { /** @@ -407,7 +407,7 @@ export namespace composer_v1beta1 { */ gkeCluster?: string | null; /** - * Optional. The maintenance window is the period when Cloud Composer components may undergo maintenance. It is defined so that maintenance is not executed during peak hours or critical time periods. The system will not be under maintenance for every occurrence of this window, but when maintenance is planned, it will be scheduled during the window. The maintenance window period must encompass at least 12 hours per week. This may be split into multiple chunks, each with a size of at least 4 hours. If this value is omitted, Cloud Composer components may be subject to maintenance at any time. + * Optional. The maintenance window is the period when Cloud Composer components may undergo maintenance. It is defined so that maintenance is not executed during peak hours or critical time periods. The system will not be under maintenance for every occurrence of this window, but when maintenance is planned, it will be scheduled during the window. The maintenance window period must encompass at least 12 hours per week. This may be split into multiple chunks, each with a size of at least 4 hours. If this value is omitted, the default value for maintenance window is applied. By default, maintenance windows are from 00:00:00 to 04:00:00 (GMT) on Friday, Saturday, and Sunday every week. */ maintenanceWindow?: Schema$MaintenanceWindow; /** @@ -1122,7 +1122,7 @@ export namespace composer_v1beta1 { */ export interface Schema$TaskLogsRetentionConfig { /** - * Optional. The mode of storage for Airflow workers task logs. For details, see go/composer-store-task-logs-in-cloud-logging-only-design-doc + * Optional. The mode of storage for Airflow workers task logs. */ storageMode?: string | null; } diff --git a/src/apis/compute/alpha.ts b/src/apis/compute/alpha.ts index ea18b78878..ec47e77cc9 100644 --- a/src/apis/compute/alpha.ts +++ b/src/apis/compute/alpha.ts @@ -159,6 +159,7 @@ export namespace compute_alpha { networkEdgeSecurityServices: Resource$Networkedgesecurityservices; networkEndpointGroups: Resource$Networkendpointgroups; networkFirewallPolicies: Resource$Networkfirewallpolicies; + networkPlacements: Resource$Networkplacements; networks: Resource$Networks; nodeGroups: Resource$Nodegroups; nodeTemplates: Resource$Nodetemplates; @@ -291,6 +292,7 @@ export namespace compute_alpha { this.networkFirewallPolicies = new Resource$Networkfirewallpolicies( this.context ); + this.networkPlacements = new Resource$Networkplacements(this.context); this.networks = new Resource$Networks(this.context); this.nodeGroups = new Resource$Nodegroups(this.context); this.nodeTemplates = new Resource$Nodetemplates(this.context); @@ -7084,7 +7086,7 @@ export namespace compute_alpha { */ export interface Schema$InstanceGroupManagerParams { /** - * Resource manager tags to be bound to the instance group manager. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/123`, and values are in the format `tagValues/456`. The field is allowed for INSERT only. + * Resource manager tags to bind to the managed instance group. The tags are key-value pairs. Keys must be in the format tagKeys/123 and values in the format tagValues/456. For more information, see Manage tags for resources. */ resourceManagerTags?: {[key: string]: string} | null; } @@ -7953,7 +7955,7 @@ export namespace compute_alpha { */ shortName?: string | null; /** - * [Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL. + * [Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, SYSTEM_REGIONAL. */ type?: string | null; } @@ -11259,6 +11261,159 @@ export namespace compute_alpha { externalIpEgressBandwidthTier?: string | null; totalEgressBandwidthTier?: string | null; } + /** + * NetworkPlacement Represents a Google managed network placement resource. + */ + export interface Schema$NetworkPlacement { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * [Output Only] An optional description of this resource. + */ + description?: string | null; + /** + * [Output Only] Features supported by the network. + */ + features?: Schema$NetworkPlacementNetworkFeatures; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#networkPlacement for network placements. + */ + kind?: string | null; + /** + * [Output Only] Name of the resource. + */ + name?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * [Output Only] Zone to which the network is restricted. + */ + zone?: string | null; + } + export interface Schema$NetworkPlacementNetworkFeatures { + /** + * Specifies whether auto mode subnet creation is allowed. + */ + allowAutoModeSubnet?: string | null; + /** + * Specifies whether cloud NAT creation is allowed. + */ + allowCloudNat?: string | null; + /** + * Specifies whether cloud router creation is allowed. + */ + allowCloudRouter?: string | null; + /** + * Specifies which subnetwork purposes are supported. + */ + allowedSubnetPurposes?: string[] | null; + /** + * Specifies which subnetwork stack types are supported. + */ + allowedSubnetStackTypes?: string[] | null; + /** + * Specifies whether Cloud Interconnect creation is allowed. + */ + allowInterconnect?: string | null; + /** + * Specifies whether cloud load balancing is allowed. + */ + allowLoadBalancing?: string | null; + /** + * Specifies whether multi-nic in the same network is allowed. + */ + allowMultiNicInSameNetwork?: string | null; + /** + * Specifies whether Packet Mirroring 1.0 is supported. + */ + allowPacketMirroring?: string | null; + /** + * Specifies whether private Google access is allowed. + */ + allowPrivateGoogleAccess?: string | null; + /** + * Specifies whether PSC creation is allowed. + */ + allowPsc?: string | null; + /** + * Specifies whether unicast within the same network is allowed. + */ + allowSameNetworkUnicast?: string | null; + /** + * Specifies whether static route creation is allowed. + */ + allowStaticRoutes?: string | null; + /** + * Specifies whether VPC peering is allowed. + */ + allowVpcPeering?: string | null; + /** + * Specifies whether VPN creation is allowed. + */ + allowVpn?: string | null; + /** + * If set, limits the interface types that the network supports. If empty, all interface types are supported. + */ + interfaceTypes?: string[] | null; + /** + * Specifies which type of multicast is supported. + */ + multicast?: string | null; + /** + * Specifies which type of unicast is supported. + */ + unicast?: string | null; + } + /** + * Contains a list of network placements. + */ + export interface Schema$NetworkPlacementsListResponse { + etag?: string | null; + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of NetworkPlacement resources. + */ + items?: Schema$NetworkPlacement[]; + /** + * [Output Only] Type of resource. Always compute#networkPlacementList for network placements. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder + */ + unreachables?: string[] | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } /** * A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide. */ @@ -13911,10 +14066,6 @@ export namespace compute_alpha { * The URLs of one or more instances to delete. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. */ instances?: string[] | null; - /** - * Skip instances which cannot be deleted (instances not belonging to this managed group, already being deleted or being abandoned). If `false`, fail whole flow, if such instance is passed. DEPRECATED: Use skip_instances_on_validation_error instead. - */ - skipInapplicableInstances?: boolean | null; /** * Specifies whether the request should proceed despite the inclusion of instances that are not members of the group or that are already in the process of being deleted or abandoned. If this field is set to `false` and such an instance is specified in the request, the operation fails. The operation always fails if the request contains a malformed instance URL or a reference to an instance that exists in a zone or region other than the group's zone or region. */ @@ -64645,6 +64796,235 @@ export namespace compute_alpha { requestBody?: Schema$TestPermissionsRequest; } + export class Resource$Networkplacements { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Returns the specified network placement. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Networkplacements$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Networkplacements$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Networkplacements$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Networkplacements$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Networkplacements$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Networkplacements$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Networkplacements$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Networkplacements$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/networkPlacements/{networkPlacement}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'networkPlacement'], + pathParams: ['networkPlacement', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of network placements available to the specified project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Networkplacements$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Networkplacements$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Networkplacements$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Networkplacements$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Networkplacements$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Networkplacements$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Networkplacements$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Networkplacements$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/networkPlacements' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Networkplacements$Get + extends StandardParameters { + /** + * Name of the network placement to return. + */ + networkPlacement?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Networkplacements$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + export class Resource$Networks { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/compute/beta.ts b/src/apis/compute/beta.ts index 14a0eac954..08db8254d5 100644 --- a/src/apis/compute/beta.ts +++ b/src/apis/compute/beta.ts @@ -2265,6 +2265,51 @@ export namespace compute_beta { */ numTx?: number | null; } + export interface Schema$BgpRoute { + /** + * [Output only] AS-PATH for the route + */ + asPaths?: Schema$BgpRouteAsPath[]; + /** + * [Output only] BGP communities in human-readable A:B format. + */ + communities?: string[] | null; + /** + * [Output only] Destination IP range for the route, in human-readable CIDR format + */ + destination?: Schema$BgpRouteNetworkLayerReachabilityInformation; + /** + * [Output only] BGP multi-exit discriminator + */ + med?: number | null; + /** + * [Output only] BGP origin (EGP, IGP or INCOMPLETE) + */ + origin?: string | null; + } + export interface Schema$BgpRouteAsPath { + /** + * [Output only] ASNs in the path segment. When type is SEQUENCE, these are ordered. + */ + asns?: number[] | null; + /** + * [Output only] Type of AS-PATH segment (SEQUENCE or SET) + */ + type?: string | null; + } + /** + * Network Layer Reachability Information (NLRI) for a route. + */ + export interface Schema$BgpRouteNetworkLayerReachabilityInformation { + /** + * If the BGP session supports multiple paths (RFC 7911), the path identifier for this route. + */ + pathId?: number | null; + /** + * Human readable CIDR notation for a prefix. E.g. 10.42.0.0/16. + */ + prefix?: string | null; + } /** * Associates `members`, or principals, with a `role`. */ @@ -5922,6 +5967,10 @@ export namespace compute_beta { * Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. */ params?: Schema$InstanceParams; + /** + * Partner Metadata assigned to the instance. A map from a subdomain (namespace) to entries map. + */ + partnerMetadata?: {[key: string]: Schema$StructuredEntries} | null; /** * PostKeyRevocationActionType of the instance. */ @@ -6500,7 +6549,7 @@ export namespace compute_beta { */ export interface Schema$InstanceGroupManagerParams { /** - * Resource manager tags to be bound to the instance group manager. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/123`, and values are in the format `tagValues/456`. The field is allowed for INSERT only. + * Resource manager tags to bind to the managed instance group. The tags are key-value pairs. Keys must be in the format tagKeys/123 and values in the format tagValues/456. For more information, see Manage tags for resources. */ resourceManagerTags?: {[key: string]: string} | null; } @@ -7194,6 +7243,10 @@ export namespace compute_beta { * Note that for MachineImage, this is not supported yet. */ networkPerformanceConfig?: Schema$NetworkPerformanceConfig; + /** + * Partner Metadata assigned to the instance properties. A map from a subdomain (namespace) to entries map. + */ + partnerMetadata?: {[key: string]: Schema$StructuredEntries} | null; /** * PostKeyRevocationActionType of the instance. */ @@ -7331,7 +7384,7 @@ export namespace compute_beta { */ shortName?: string | null; /** - * [Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL. + * [Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, SYSTEM_REGIONAL. */ type?: string | null; } @@ -11562,6 +11615,19 @@ export namespace compute_beta { message?: string; } | null; } + /** + * Model definition of partner_metadata field. To be used in dedicated Partner Metadata methods and to be inlined in the Instance and InstanceTemplate resources. + */ + export interface Schema$PartnerMetadata { + /** + * Instance-level hash to be used for optimistic locking. + */ + fingerprint?: string | null; + /** + * Partner Metadata assigned to the instance. A map from a subdomain to entries map. Subdomain name must be compliant with RFC1035 definition. The total size of all keys and values must be less than 2MB. Subdomain 'metadata.compute.googleapis.com' is reserverd for instance's metadata. + */ + partnerMetadata?: {[key: string]: Schema$StructuredEntries} | null; + } /** * A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service is used. */ @@ -13492,6 +13558,35 @@ export namespace compute_beta { message?: string; } | null; } + export interface Schema$RoutePolicy { + /** + * A fingerprint for the Route Policy being applied to this Router, which is essentially a hash of the Route Policy used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update Route Policy. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make a getRoutePolicy() request to retrieve a Route Policy. + */ + fingerprint?: string | null; + /** + * Route Policy name, which must be a resource ID segment and unique within all the router's Route Policies. Name should conform to RFC1035. + */ + name?: string | null; + /** + * List of terms (the order in the list is not important, they are evaluated in order of priority). Order of policies is not retained and might change when getting policy later. + */ + terms?: Schema$RoutePolicyPolicyTerm[]; + type?: string | null; + } + export interface Schema$RoutePolicyPolicyTerm { + /** + * CEL expressions to evaluate to modify a route when this term matches. + */ + actions?: Schema$Expr[]; + /** + * CEL expression evaluated against a route to determine if this term applies. When not set, the term applies to all routes. + */ + match?: Schema$Expr; + /** + * The evaluation priority for this term, which must be between 0 (inclusive) and 2^31 (exclusive), and unique within the list. + */ + priority?: number | null; + } /** * Represents a Cloud Router resource. For more information about Cloud Router, read the Cloud Router overview. */ @@ -13972,6 +14067,79 @@ export namespace compute_beta { */ sourceIpRangesToNat?: string[] | null; } + export interface Schema$RoutersGetRoutePolicyResponse { + resource?: Schema$RoutePolicy; + } + export interface Schema$RoutersListBgpRoutes { + etag?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of resource. Always compute#routersListBgpRoutes for lists of bgp routes. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] A list of bgp routes. + */ + result?: Schema$BgpRoute[]; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Unreachable resources. + */ + unreachables?: string[] | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$RoutersListRoutePolicies { + etag?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of resource. Always compute#routersListRoutePolicies for lists of route policies. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] A list of route policies. + */ + result?: Schema$RoutePolicy[]; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Unreachable resources. + */ + unreachables?: string[] | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } export interface Schema$RoutersPreviewResponse { /** * Preview of given router. @@ -16616,6 +16784,12 @@ export namespace compute_beta { message?: string; } | null; } + export interface Schema$StructuredEntries { + /** + * Map of a partner metadata that belong to the same subdomain. It accepts any value including google.protobuf.Struct. + */ + entries?: {[key: string]: any} | null; + } /** * Represents a Subnetwork resource. A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network. */ @@ -45167,6 +45341,95 @@ export namespace compute_beta { } } + /** + * Gets partner metadata of the specified instance and namespaces. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getPartnerMetadata( + params: Params$Resource$Instances$Getpartnermetadata, + options: StreamMethodOptions + ): GaxiosPromise; + getPartnerMetadata( + params?: Params$Resource$Instances$Getpartnermetadata, + options?: MethodOptions + ): GaxiosPromise; + getPartnerMetadata( + params: Params$Resource$Instances$Getpartnermetadata, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getPartnerMetadata( + params: Params$Resource$Instances$Getpartnermetadata, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getPartnerMetadata( + params: Params$Resource$Instances$Getpartnermetadata, + callback: BodyResponseCallback + ): void; + getPartnerMetadata( + callback: BodyResponseCallback + ): void; + getPartnerMetadata( + paramsOrCallback?: + | Params$Resource$Instances$Getpartnermetadata + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Getpartnermetadata; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Getpartnermetadata; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/instances/{instance}/getPartnerMetadata' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Returns the screenshot from the specified instance. * @@ -45795,6 +46058,95 @@ export namespace compute_beta { } } + /** + * Patches partner metadata of the specified instance. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patchPartnerMetadata( + params: Params$Resource$Instances$Patchpartnermetadata, + options: StreamMethodOptions + ): GaxiosPromise; + patchPartnerMetadata( + params?: Params$Resource$Instances$Patchpartnermetadata, + options?: MethodOptions + ): GaxiosPromise; + patchPartnerMetadata( + params: Params$Resource$Instances$Patchpartnermetadata, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patchPartnerMetadata( + params: Params$Resource$Instances$Patchpartnermetadata, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patchPartnerMetadata( + params: Params$Resource$Instances$Patchpartnermetadata, + callback: BodyResponseCallback + ): void; + patchPartnerMetadata( + callback: BodyResponseCallback + ): void; + patchPartnerMetadata( + paramsOrCallback?: + | Params$Resource$Instances$Patchpartnermetadata + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Patchpartnermetadata; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Patchpartnermetadata; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/instances/{instance}/patchPartnerMetadata' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Perform a manual maintenance on the instance. * @@ -48817,6 +49169,10 @@ export namespace compute_beta { * Project ID for this request. */ project?: string; + /** + * View of the instance. + */ + view?: string; /** * The name of the zone for this request. */ @@ -48883,6 +49239,25 @@ export namespace compute_beta { */ zone?: string; } + export interface Params$Resource$Instances$Getpartnermetadata + extends StandardParameters { + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Comma separated partner metadata namespaces. + */ + namespaces?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } export interface Params$Resource$Instances$Getscreenshot extends StandardParameters { /** @@ -49003,6 +49378,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ returnPartialSuccess?: boolean; + /** + * View of the instance. + */ + view?: string; /** * The name of the zone for this request. */ @@ -49043,6 +49422,30 @@ export namespace compute_beta { */ zone?: string; } + export interface Params$Resource$Instances$Patchpartnermetadata + extends StandardParameters { + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PartnerMetadata; + } export interface Params$Resource$Instances$Performmaintenance extends StandardParameters { /** @@ -50791,6 +51194,10 @@ export namespace compute_beta { * Project ID for this request. */ project?: string; + /** + * View of the instance template. + */ + view?: string; } export interface Params$Resource$Instancetemplates$Getiampolicy extends StandardParameters { @@ -50849,6 +51256,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ returnPartialSuccess?: boolean; + /** + * View of the instance template. + */ + view?: string; } export interface Params$Resource$Instancetemplates$Setiampolicy extends StandardParameters { @@ -81165,6 +81576,10 @@ export namespace compute_beta { * The name of the region for this request. */ region?: string; + /** + * View of the instance template. + */ + view?: string; } export interface Params$Resource$Regioninstancetemplates$Insert extends StandardParameters { @@ -81216,6 +81631,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */ returnPartialSuccess?: boolean; + /** + * View of the instance template. + */ + view?: string; } export class Resource$Regioninstantsnapshots { @@ -93960,6 +94379,93 @@ export namespace compute_beta { } } + /** + * Deletes Route Policy + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + deleteRoutePolicy( + params: Params$Resource$Routers$Deleteroutepolicy, + options: StreamMethodOptions + ): GaxiosPromise; + deleteRoutePolicy( + params?: Params$Resource$Routers$Deleteroutepolicy, + options?: MethodOptions + ): GaxiosPromise; + deleteRoutePolicy( + params: Params$Resource$Routers$Deleteroutepolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deleteRoutePolicy( + params: Params$Resource$Routers$Deleteroutepolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deleteRoutePolicy( + params: Params$Resource$Routers$Deleteroutepolicy, + callback: BodyResponseCallback + ): void; + deleteRoutePolicy(callback: BodyResponseCallback): void; + deleteRoutePolicy( + paramsOrCallback?: + | Params$Resource$Routers$Deleteroutepolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Routers$Deleteroutepolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Routers$Deleteroutepolicy; + 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}/regions/{region}/routers/{router}/deleteRoutePolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'router'], + pathParams: ['project', 'region', 'router'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Returns the specified Router resource. * @@ -94232,6 +94738,102 @@ export namespace compute_beta { } } + /** + * Returns specified Route Policy + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getRoutePolicy( + params: Params$Resource$Routers$Getroutepolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getRoutePolicy( + params?: Params$Resource$Routers$Getroutepolicy, + options?: MethodOptions + ): GaxiosPromise; + getRoutePolicy( + params: Params$Resource$Routers$Getroutepolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getRoutePolicy( + params: Params$Resource$Routers$Getroutepolicy, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getRoutePolicy( + params: Params$Resource$Routers$Getroutepolicy, + callback: BodyResponseCallback + ): void; + getRoutePolicy( + callback: BodyResponseCallback + ): void; + getRoutePolicy( + paramsOrCallback?: + | Params$Resource$Routers$Getroutepolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Routers$Getroutepolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Routers$Getroutepolicy; + 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}/regions/{region}/routers/{router}/getRoutePolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'router'], + pathParams: ['project', 'region', 'router'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Retrieves runtime information of the specified router. * @@ -94498,6 +95100,194 @@ export namespace compute_beta { } } + /** + * Retrieves a list of router bgp routes available to the specified project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listBgpRoutes( + params: Params$Resource$Routers$Listbgproutes, + options: StreamMethodOptions + ): GaxiosPromise; + listBgpRoutes( + params?: Params$Resource$Routers$Listbgproutes, + options?: MethodOptions + ): GaxiosPromise; + listBgpRoutes( + params: Params$Resource$Routers$Listbgproutes, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listBgpRoutes( + params: Params$Resource$Routers$Listbgproutes, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listBgpRoutes( + params: Params$Resource$Routers$Listbgproutes, + callback: BodyResponseCallback + ): void; + listBgpRoutes( + callback: BodyResponseCallback + ): void; + listBgpRoutes( + paramsOrCallback?: + | Params$Resource$Routers$Listbgproutes + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Routers$Listbgproutes; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Routers$Listbgproutes; + 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}/regions/{region}/routers/{router}/listBgpRoutes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'router'], + pathParams: ['project', 'region', 'router'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of router route policy subresources available to the specified project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listRoutePolicies( + params: Params$Resource$Routers$Listroutepolicies, + options: StreamMethodOptions + ): GaxiosPromise; + listRoutePolicies( + params?: Params$Resource$Routers$Listroutepolicies, + options?: MethodOptions + ): GaxiosPromise; + listRoutePolicies( + params: Params$Resource$Routers$Listroutepolicies, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listRoutePolicies( + params: Params$Resource$Routers$Listroutepolicies, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listRoutePolicies( + params: Params$Resource$Routers$Listroutepolicies, + callback: BodyResponseCallback + ): void; + listRoutePolicies( + callback: BodyResponseCallback + ): void; + listRoutePolicies( + paramsOrCallback?: + | Params$Resource$Routers$Listroutepolicies + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Routers$Listroutepolicies; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Routers$Listroutepolicies; + 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}/regions/{region}/routers/{router}/listRoutePolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'router'], + pathParams: ['project', 'region', 'router'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. * @@ -94856,6 +95646,93 @@ export namespace compute_beta { return createAPIRequest(parameters); } } + + /** + * Updates or creates new Route Policy + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + updateRoutePolicy( + params: Params$Resource$Routers$Updateroutepolicy, + options: StreamMethodOptions + ): GaxiosPromise; + updateRoutePolicy( + params?: Params$Resource$Routers$Updateroutepolicy, + options?: MethodOptions + ): GaxiosPromise; + updateRoutePolicy( + params: Params$Resource$Routers$Updateroutepolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateRoutePolicy( + params: Params$Resource$Routers$Updateroutepolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateRoutePolicy( + params: Params$Resource$Routers$Updateroutepolicy, + callback: BodyResponseCallback + ): void; + updateRoutePolicy(callback: BodyResponseCallback): void; + updateRoutePolicy( + paramsOrCallback?: + | Params$Resource$Routers$Updateroutepolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Routers$Updateroutepolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Routers$Updateroutepolicy; + 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}/regions/{region}/routers/{router}/updateRoutePolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'router'], + pathParams: ['project', 'region', 'router'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Routers$Aggregatedlist @@ -94911,6 +95788,29 @@ export namespace compute_beta { */ router?: string; } + export interface Params$Resource$Routers$Deleteroutepolicy + extends StandardParameters { + /** + * The Policy name for this request. Name must conform to RFC1035 + */ + policy?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the Router resource where Route Policy is defined. + */ + router?: string; + } export interface Params$Resource$Routers$Get extends StandardParameters { /** * Project ID for this request. @@ -94983,6 +95883,25 @@ export namespace compute_beta { */ router?: string; } + export interface Params$Resource$Routers$Getroutepolicy + extends StandardParameters { + /** + * The Policy name for this request. Name must conform to RFC1035 + */ + policy?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * Name of the Router resource to query for the route policy. The name should conform to RFC1035. + */ + router?: string; + } export interface Params$Resource$Routers$Getrouterstatus extends StandardParameters { /** @@ -95047,6 +95966,96 @@ export namespace compute_beta { */ returnPartialSuccess?: boolean; } + export interface Params$Resource$Routers$Listbgproutes + extends StandardParameters { + /** + * (Required) limit results to this address family (either IPv4 or IPv6) + */ + addressFamily?: string; + /** + * Limit results to destinations that are subnets of this CIDR range + */ + destinationPrefix?: string; + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * (Required) limit results to the BGP peer with the given name. Name should conform to RFC1035. + */ + peer?: string; + /** + * When true, the method returns post-policy routes. Otherwise, it returns pre-policy routes. + */ + policyApplied?: boolean; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * Name or id of the resource for this request. Name should conform to RFC1035. + */ + router?: string; + /** + * (Required) limit results to this type of route (either LEARNED or ADVERTISED) + */ + routeType?: string; + } + export interface Params$Resource$Routers$Listroutepolicies + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * Name or id of the resource for this request. Name should conform to RFC1035. + */ + router?: string; + } export interface Params$Resource$Routers$Patch extends StandardParameters { /** * Project ID for this request. @@ -95132,6 +96141,30 @@ export namespace compute_beta { */ requestBody?: Schema$Router; } + export interface Params$Resource$Routers$Updateroutepolicy + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the Router resource where Route Policy is defined. + */ + router?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RoutePolicy; + } export class Resource$Routes { context: APIRequestContext; diff --git a/src/apis/compute/v1.ts b/src/apis/compute/v1.ts index e6e764396f..bf21197624 100644 --- a/src/apis/compute/v1.ts +++ b/src/apis/compute/v1.ts @@ -142,6 +142,7 @@ export namespace compute_v1 { instanceGroupManagers: Resource$Instancegroupmanagers; instanceGroups: Resource$Instancegroups; instances: Resource$Instances; + instanceSettings: Resource$Instancesettings; instanceTemplates: Resource$Instancetemplates; instantSnapshots: Resource$Instantsnapshots; interconnectAttachments: Resource$Interconnectattachments; @@ -256,6 +257,7 @@ export namespace compute_v1 { ); this.instanceGroups = new Resource$Instancegroups(this.context); this.instances = new Resource$Instances(this.context); + this.instanceSettings = new Resource$Instancesettings(this.context); this.instanceTemplates = new Resource$Instancetemplates(this.context); this.instantSnapshots = new Resource$Instantsnapshots(this.context); this.interconnectAttachments = new Resource$Interconnectattachments( @@ -6656,6 +6658,37 @@ export namespace compute_v1 { [key: string]: Schema$BulkInsertOperationStatus; } | null; } + /** + * Represents a Instance Settings resource. You can use instance settings to configure default settings for Compute Engine VM instances. For example, you can use it to configure default machine type of Compute Engine VM instances. + */ + export interface Schema$InstanceSettings { + /** + * Specifies a fingerprint for instance settings, which is essentially a hash of the instance settings resource's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance settings resource. You must always provide an up-to-date fingerprint hash in order to update or change the resource, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the resource. + */ + fingerprint?: string | null; + /** + * [Output Only] Type of the resource. Always compute#instance_settings for instance settings. + */ + kind?: string | null; + /** + * The metadata key/value pairs assigned to all the instances in the corresponding scope. + */ + metadata?: Schema$InstanceSettingsMetadata; + /** + * [Output Only] URL of the zone where the resource resides You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + zone?: string | null; + } + export interface Schema$InstanceSettingsMetadata { + /** + * A metadata key/value items map. The total size of all keys and values must be less than 512KB. + */ + items?: {[key: string]: string} | null; + /** + * [Output Only] Type of the resource. Always compute#metadata for metadata. + */ + kind?: string | null; + } export interface Schema$InstancesGetEffectiveFirewallsResponse { /** * Effective firewalls from firewall policies. @@ -6684,7 +6717,7 @@ export namespace compute_v1 { */ shortName?: string | null; /** - * [Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL. + * [Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, SYSTEM_REGIONAL. */ type?: string | null; } @@ -45383,6 +45416,223 @@ export namespace compute_v1 { requestBody?: Schema$ShieldedInstanceConfig; } + export class Resource$Instancesettings { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Get Instance settings. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Instancesettings$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Instancesettings$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Instancesettings$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Instancesettings$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Instancesettings$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Instancesettings$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancesettings$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancesettings$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/instanceSettings' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Patch Instance settings + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Instancesettings$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Instancesettings$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Instancesettings$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Instancesettings$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Instancesettings$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Instancesettings$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancesettings$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancesettings$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/instanceSettings' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Instancesettings$Get + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instancesettings$Patch + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * update_mask indicates fields to be updated as part of this request. + */ + updateMask?: string; + /** + * The zone scoping this request. It should conform to RFC1035. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceSettings; + } + export class Resource$Instancetemplates { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/connectors/v1.ts b/src/apis/connectors/v1.ts index 8dcf605ced..03855e4b48 100644 --- a/src/apis/connectors/v1.ts +++ b/src/apis/connectors/v1.ts @@ -610,6 +610,10 @@ export namespace connectors_v1 { * Output only. List of auth configs supported by the Connector Version. */ authConfigTemplates?: Schema$AuthConfigTemplate[]; + /** + * Output only. Flag to mark the dynamic auth override. + */ + authOverrideEnabled?: boolean | null; /** * Output only. List of config variables needed to create a connection. */ @@ -662,6 +666,10 @@ export namespace connectors_v1 { * Output only. Role grant configurations for this connector version. */ roleGrants?: Schema$RoleGrant[]; + /** + * Connection Schema Refresh Config + */ + schemaRefreshConfig?: Schema$SchemaRefreshConfig; /** * Output only. Ssl configuration supported by the Connector. */ @@ -1940,7 +1948,7 @@ export namespace connectors_v1 { logicalOperator?: string | null; } /** - * LINT.IfChange Defines policies to service maintenance events. + * Defines policies to service maintenance events. */ export interface Schema$MaintenancePolicy { /** @@ -2551,6 +2559,19 @@ export namespace connectors_v1 { */ startTime?: Schema$TimeOfDay; } + /** + * Config for connection schema refresh + */ + export interface Schema$SchemaRefreshConfig { + /** + * Whether to use displayName for actions in UI. + */ + useActionDisplayNames?: boolean | null; + /** + * Whether to use synchronous schema refresh. + */ + useSynchronousSchemaRefresh?: boolean | null; + } /** * Secret provides a reference to entries in Secret Manager. */ @@ -5976,8 +5997,13 @@ export namespace connectors_v1 { export class Resource$Projects$Locations$Customconnectors { context: APIRequestContext; + customConnectorVersions: Resource$Projects$Locations$Customconnectors$Customconnectorversions; constructor(context: APIRequestContext) { this.context = context; + this.customConnectorVersions = + new Resource$Projects$Locations$Customconnectors$Customconnectorversions( + this.context + ); } /** @@ -6091,6 +6117,106 @@ export namespace connectors_v1 { requestBody?: Schema$ValidateCustomConnectorSpecRequest; } + export class Resource$Projects$Locations$Customconnectors$Customconnectorversions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes a single CustomConnectorVersion. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Customconnectors$Customconnectorversions$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Customconnectors$Customconnectorversions$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Customconnectors$Customconnectorversions$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Customconnectors$Customconnectorversions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Customconnectors$Customconnectorversions$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Customconnectors$Customconnectorversions$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Customconnectors$Customconnectorversions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Customconnectors$Customconnectorversions$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://connectors.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + 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$Customconnectors$Customconnectorversions$Delete + extends StandardParameters { + /** + * Required. Resource name of the form: `projects/{project\}/locations/{location\}/customConnectors/{custom_connector\}/customConnectorVersions/{custom_connector_version\}` + */ + name?: string; + } + export class Resource$Projects$Locations$Endpointattachments { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/connectors/v2.ts b/src/apis/connectors/v2.ts index 5f73af06ad..c241fe9a85 100644 --- a/src/apis/connectors/v2.ts +++ b/src/apis/connectors/v2.ts @@ -562,7 +562,7 @@ export namespace connectors_v2 { unsupportedTypeNames?: string[] | null; } /** - * LINT.IfChange Defines policies to service maintenance events. + * Defines policies to service maintenance events. */ export interface Schema$MaintenancePolicy { /** diff --git a/src/apis/container/v1.ts b/src/apis/container/v1.ts index a9a2551528..435a1bf917 100644 --- a/src/apis/container/v1.ts +++ b/src/apis/container/v1.ts @@ -897,6 +897,10 @@ export namespace container_v1 { * Enable/Disable FQDN Network Policy for the cluster. */ desiredEnableFqdnNetworkPolicy?: boolean | null; + /** + * Enable/Disable Multi-Networking for the cluster + */ + desiredEnableMultiNetworking?: boolean | null; /** * Enable/Disable private endpoint for the cluster's master. */ @@ -2122,6 +2126,10 @@ export namespace container_v1 { * List of secondary boot disks attached to the nodes. */ secondaryBootDisks?: Schema$SecondaryBootDisk[]; + /** + * Secondary boot disk update strategy. + */ + secondaryBootDiskUpdateStrategy?: Schema$SecondaryBootDiskUpdateStrategy; /** * The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used. */ @@ -2817,6 +2825,10 @@ export namespace container_v1 { */ mode?: string | null; } + /** + * SecondaryBootDiskUpdateStrategy is a placeholder which will be extended in the future to define different options for updating secondary boot disks. + */ + export interface Schema$SecondaryBootDiskUpdateStrategy {} /** * SecurityBulletinEvent is a notification sent to customers when a security bulletin has been posted that they are vulnerable to. */ diff --git a/src/apis/container/v1beta1.ts b/src/apis/container/v1beta1.ts index 94ae84bde5..333547a1ef 100644 --- a/src/apis/container/v1beta1.ts +++ b/src/apis/container/v1beta1.ts @@ -1321,10 +1321,22 @@ export namespace container_v1beta1 { * Configuration of etcd encryption. */ export interface Schema$DatabaseEncryption { + /** + * Output only. The current state of etcd encryption. + */ + currentState?: string | null; + /** + * Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. + */ + decryptionKeys?: string[] | null; /** * Name of CloudKMS key to use for the encryption of secrets in etcd. Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key */ keyName?: string | null; + /** + * Output only. Records errors seen during DatabaseEncryption update operations. + */ + lastOperationErrors?: Schema$OperationError[]; /** * The desired state of etcd encryption. */ @@ -2768,6 +2780,23 @@ export namespace container_v1beta1 { */ zone?: string | null; } + /** + * OperationError records errors seen from CloudKMS keys encountered during updates to DatabaseEncryption configuration. + */ + export interface Schema$OperationError { + /** + * Description of the error seen during the operation. + */ + errorMessage?: string | null; + /** + * CloudKMS key resource that had the error. + */ + keyName?: string | null; + /** + * Time when the CloudKMS error was seen. + */ + timestamp?: string | null; + } /** * Information about operation (or operation stage) progress. */ diff --git a/src/apis/content/v2.1.ts b/src/apis/content/v2.1.ts index b8c881a48d..de714ee442 100644 --- a/src/apis/content/v2.1.ts +++ b/src/apis/content/v2.1.ts @@ -7534,7 +7534,7 @@ export namespace content_v2_1 { */ segments?: Schema$Segments; /** - * Topic trends fields requested by the merchant in the query. Field values are only set if the merchant queries `TopicTrendsView`. https://support.google.com/merchants/answer/13542370. + * [Topic trends](https://support.google.com/merchants/answer/13542370) fields requested by the merchant in the query. Field values are only set if the merchant queries `TopicTrendsView`. */ topicTrends?: Schema$TopicTrends; } @@ -8869,7 +8869,7 @@ export namespace content_v2_1 { version?: string | null; } /** - * Topic trends fields requested by the merchant in the query. Field values are only set if the merchant queries `TopicTrendsView`. + * Topic trends fields requested by the merchant in the query. Field values are only set if the merchant queries `TopicTrendsView`. Forecast data can be queried up to 13 weeks by passing a future date in the `date` field. Historical data is measured daily, and forecasted data is projected weekly. All data points are normalized based on the highest data points returned in the response. If you make separate queries with different date ranges, you might see different values for the same date in each response. The recommended way to get a trend score of a topic is `last7_days_search_interest / last{$day\}_days_search_interest - 1`. You can view trends for up to eight topics at a time. */ export interface Schema$TopicTrends { /** diff --git a/src/apis/customsearch/v1.ts b/src/apis/customsearch/v1.ts index c5ef0c0889..567b04a337 100644 --- a/src/apis/customsearch/v1.ts +++ b/src/apis/customsearch/v1.ts @@ -602,6 +602,10 @@ export namespace customsearch_v1 { * Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: include */ siteSearchFilter?: string; + /** + * Optional. Maximum length of snippet text, in characters, to be returned with results. * Valid values are integers between 1 and 160, inclusive. + */ + snippetLength?: number; /** * The sort expression to apply to the results. The sort parameter specifies that the results be sorted according to the specified expression i.e. sort by date. [Example: sort=date](https://developers.google.com/custom-search/docs/structured_search#sort-by-attribute). */ @@ -824,6 +828,10 @@ export namespace customsearch_v1 { * Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: include */ siteSearchFilter?: string; + /** + * Optional. Maximum length of snippet text, in characters, to be returned with results. * Valid values are integers between 1 and 160, inclusive. + */ + snippetLength?: number; /** * The sort expression to apply to the results. The sort parameter specifies that the results be sorted according to the specified expression i.e. sort by date. [Example: sort=date](https://developers.google.com/custom-search/docs/structured_search#sort-by-attribute). */ diff --git a/src/apis/datacatalog/v1.ts b/src/apis/datacatalog/v1.ts index 1efdcdf41b..b1774690b1 100644 --- a/src/apis/datacatalog/v1.ts +++ b/src/apis/datacatalog/v1.ts @@ -659,7 +659,7 @@ export namespace datacatalog_v1 { */ modelSpec?: Schema$GoogleCloudDatacatalogV1ModelSpec; /** - * Output only. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name. + * Output only. Identifier. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name. */ name?: string | null; /** @@ -720,7 +720,7 @@ export namespace datacatalog_v1 { */ displayName?: string | null; /** - * The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name. + * Identifier. The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name. */ name?: string | null; } @@ -1490,7 +1490,7 @@ export namespace datacatalog_v1 { */ fields?: {[key: string]: Schema$GoogleCloudDatacatalogV1TagField} | null; /** - * The resource name of the tag in URL format where tag ID is a system-generated identifier. Note: The tag itself might not be stored in the location specified in its name. + * Identifier. The resource name of the tag in URL format where tag ID is a system-generated identifier. Note: The tag itself might not be stored in the location specified in its name. */ name?: string | null; /** @@ -1569,6 +1569,10 @@ export namespace datacatalog_v1 { * A tag template defines a tag that can have one or more typed fields. The template is used to create tags that are attached to Google Cloud resources. [Tag template roles] (https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles) provide permissions to create, edit, and use the template. For example, see the [TagTemplate User] (https://cloud.google.com/data-catalog/docs/how-to/template-user) role that includes a permission to use the tag template to tag resources. */ export interface Schema$GoogleCloudDatacatalogV1TagTemplate { + /** + * Optional. Transfer status of the TagTemplate + */ + dataplexTransferStatus?: string | null; /** * Display name for this template. Defaults to an empty string. The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum length is 200 characters. */ @@ -1584,7 +1588,7 @@ export namespace datacatalog_v1 { */ isPubliclyReadable?: boolean | null; /** - * The resource name of the tag template in URL format. Note: The tag template itself and its child resources might not be stored in the location specified in its name. + * Identifier. The resource name of the tag template in URL format. Note: The tag template itself and its child resources might not be stored in the location specified in its name. */ name?: string | null; } @@ -1605,7 +1609,7 @@ export namespace datacatalog_v1 { */ isRequired?: boolean | null; /** - * Output only. The resource name of the tag template field in URL format. Example: `projects/{PROJECT_ID\}/locations/{LOCATION\}/tagTemplates/{TAG_TEMPLATE\}/fields/{FIELD\}` Note: The tag template field itself might not be stored in the location specified in its name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 64 characters. + * Identifier. The resource name of the tag template field in URL format. Example: `projects/{PROJECT_ID\}/locations/{LOCATION\}/tagTemplates/{TAG_TEMPLATE\}/fields/{FIELD\}` Note: The tag template field itself might not be stored in the location specified in its name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 64 characters. */ name?: string | null; /** @@ -2953,7 +2957,7 @@ export namespace datacatalog_v1 { export interface Params$Resource$Projects$Locations$Entrygroups$Patch extends StandardParameters { /** - * The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name. + * Identifier. The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name. */ name?: string; /** @@ -4222,7 +4226,7 @@ export namespace datacatalog_v1 { export interface Params$Resource$Projects$Locations$Entrygroups$Entries$Patch extends StandardParameters { /** - * Output only. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name. + * Output only. Identifier. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name. */ name?: string; /** @@ -4767,7 +4771,7 @@ export namespace datacatalog_v1 { export interface Params$Resource$Projects$Locations$Entrygroups$Entries$Tags$Patch extends StandardParameters { /** - * The resource name of the tag in URL format where tag ID is a system-generated identifier. Note: The tag itself might not be stored in the location specified in its name. + * Identifier. The resource name of the tag in URL format where tag ID is a system-generated identifier. Note: The tag itself might not be stored in the location specified in its name. */ name?: string; /** @@ -5199,7 +5203,7 @@ export namespace datacatalog_v1 { export interface Params$Resource$Projects$Locations$Entrygroups$Tags$Patch extends StandardParameters { /** - * The resource name of the tag in URL format where tag ID is a system-generated identifier. Note: The tag itself might not be stored in the location specified in its name. + * Identifier. The resource name of the tag in URL format where tag ID is a system-generated identifier. Note: The tag itself might not be stored in the location specified in its name. */ name?: string; /** @@ -6302,7 +6306,7 @@ export namespace datacatalog_v1 { export interface Params$Resource$Projects$Locations$Tagtemplates$Patch extends StandardParameters { /** - * The resource name of the tag template in URL format. Note: The tag template itself and its child resources might not be stored in the location specified in its name. + * Identifier. The resource name of the tag template in URL format. Note: The tag template itself and its child resources might not be stored in the location specified in its name. */ name?: string; /** diff --git a/src/apis/datacatalog/v1beta1.ts b/src/apis/datacatalog/v1beta1.ts index bf0f279904..ea4ce0fa60 100644 --- a/src/apis/datacatalog/v1beta1.ts +++ b/src/apis/datacatalog/v1beta1.ts @@ -280,7 +280,7 @@ export namespace datacatalog_v1beta1 { */ linkedResource?: string | null; /** - * Output only. The Data Catalog resource name of the entry in URL format. Example: * projects/{project_id\}/locations/{location\}/entryGroups/{entry_group_id\}/entries/{entry_id\} Note that this Entry and its child resources may not actually be stored in the location in this name. + * Output only. Identifier. The Data Catalog resource name of the entry in URL format. Example: * projects/{project_id\}/locations/{location\}/entryGroups/{entry_group_id\}/entries/{entry_id\} Note that this Entry and its child resources may not actually be stored in the location in this name. */ name?: string | null; /** @@ -325,7 +325,7 @@ export namespace datacatalog_v1beta1 { */ displayName?: string | null; /** - * The resource name of the entry group in URL format. Example: * projects/{project_id\}/locations/{location\}/entryGroups/{entry_group_id\} Note that this EntryGroup and its child resources may not actually be stored in the location in this name. + * Identifier. The resource name of the entry group in URL format. Example: * projects/{project_id\}/locations/{location\}/entryGroups/{entry_group_id\} Note that this EntryGroup and its child resources may not actually be stored in the location in this name. */ name?: string | null; } @@ -706,7 +706,7 @@ export namespace datacatalog_v1beta1 { [key: string]: Schema$GoogleCloudDatacatalogV1beta1TagField; } | null; /** - * The resource name of the tag in URL format. Example: * projects/{project_id\}/locations/{location\}/entrygroups/{entry_group_id\}/entries/{entry_id\}/tags/{tag_id\} where `tag_id` is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name. + * Identifier. The resource name of the tag in URL format. Example: * projects/{project_id\}/locations/{location\}/entrygroups/{entry_group_id\}/entries/{entry_id\}/tags/{tag_id\} where `tag_id` is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name. */ name?: string | null; /** @@ -764,6 +764,10 @@ export namespace datacatalog_v1beta1 { * A tag template defines a tag, which can have one or more typed fields. The template is used to create and attach the tag to Google Cloud resources. [Tag template roles](https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles) provide permissions to create, edit, and use the template. See, for example, the [TagTemplate User](https://cloud.google.com/data-catalog/docs/how-to/template-user) role, which includes permission to use the tag template to tag resources. */ export interface Schema$GoogleCloudDatacatalogV1beta1TagTemplate { + /** + * Output only. Transfer status of the TagTemplate + */ + dataplexTransferStatus?: string | null; /** * The display name for this template. Defaults to an empty string. */ @@ -775,7 +779,7 @@ export namespace datacatalog_v1beta1 { [key: string]: Schema$GoogleCloudDatacatalogV1beta1TagTemplateField; } | null; /** - * The resource name of the tag template in URL format. Example: * projects/{project_id\}/locations/{location\}/tagTemplates/{tag_template_id\} Note that this TagTemplate and its child resources may not actually be stored in the location in this name. + * Identifier. The resource name of the tag template in URL format. Example: * projects/{project_id\}/locations/{location\}/tagTemplates/{tag_template_id\} Note that this TagTemplate and its child resources may not actually be stored in the location in this name. */ name?: string | null; } @@ -796,7 +800,7 @@ export namespace datacatalog_v1beta1 { */ isRequired?: boolean | null; /** - * Output only. The resource name of the tag template field in URL format. Example: * projects/{project_id\}/locations/{location\}/tagTemplates/{tag_template\}/fields/{field\} Note that this TagTemplateField may not actually be stored in the location in this name. + * Output only. Identifier. The resource name of the tag template field in URL format. Example: * projects/{project_id\}/locations/{location\}/tagTemplates/{tag_template\}/fields/{field\} Note that this TagTemplateField may not actually be stored in the location in this name. */ name?: string | null; /** @@ -1361,7 +1365,7 @@ export namespace datacatalog_v1beta1 { */ modelSpec?: Schema$GoogleCloudDatacatalogV1ModelSpec; /** - * Output only. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name. + * Output only. Identifier. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name. */ name?: string | null; /** @@ -1770,7 +1774,7 @@ export namespace datacatalog_v1beta1 { */ fields?: {[key: string]: Schema$GoogleCloudDatacatalogV1TagField} | null; /** - * The resource name of the tag in URL format where tag ID is a system-generated identifier. Note: The tag itself might not be stored in the location specified in its name. + * Identifier. The resource name of the tag in URL format where tag ID is a system-generated identifier. Note: The tag itself might not be stored in the location specified in its name. */ name?: string | null; /** @@ -3079,7 +3083,7 @@ export namespace datacatalog_v1beta1 { export interface Params$Resource$Projects$Locations$Entrygroups$Patch extends StandardParameters { /** - * The resource name of the entry group in URL format. Example: * projects/{project_id\}/locations/{location\}/entryGroups/{entry_group_id\} Note that this EntryGroup and its child resources may not actually be stored in the location in this name. + * Identifier. The resource name of the entry group in URL format. Example: * projects/{project_id\}/locations/{location\}/entryGroups/{entry_group_id\} Note that this EntryGroup and its child resources may not actually be stored in the location in this name. */ name?: string; /** @@ -3842,7 +3846,7 @@ export namespace datacatalog_v1beta1 { export interface Params$Resource$Projects$Locations$Entrygroups$Entries$Patch extends StandardParameters { /** - * Output only. The Data Catalog resource name of the entry in URL format. Example: * projects/{project_id\}/locations/{location\}/entryGroups/{entry_group_id\}/entries/{entry_id\} Note that this Entry and its child resources may not actually be stored in the location in this name. + * Output only. Identifier. The Data Catalog resource name of the entry in URL format. Example: * projects/{project_id\}/locations/{location\}/entryGroups/{entry_group_id\}/entries/{entry_id\} Note that this Entry and its child resources may not actually be stored in the location in this name. */ name?: string; /** @@ -4285,7 +4289,7 @@ export namespace datacatalog_v1beta1 { export interface Params$Resource$Projects$Locations$Entrygroups$Entries$Tags$Patch extends StandardParameters { /** - * The resource name of the tag in URL format. Example: * projects/{project_id\}/locations/{location\}/entrygroups/{entry_group_id\}/entries/{entry_id\}/tags/{tag_id\} where `tag_id` is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name. + * Identifier. The resource name of the tag in URL format. Example: * projects/{project_id\}/locations/{location\}/entrygroups/{entry_group_id\}/entries/{entry_id\}/tags/{tag_id\} where `tag_id` is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name. */ name?: string; /** @@ -4715,7 +4719,7 @@ export namespace datacatalog_v1beta1 { export interface Params$Resource$Projects$Locations$Entrygroups$Tags$Patch extends StandardParameters { /** - * The resource name of the tag in URL format. Example: * projects/{project_id\}/locations/{location\}/entrygroups/{entry_group_id\}/entries/{entry_id\}/tags/{tag_id\} where `tag_id` is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name. + * Identifier. The resource name of the tag in URL format. Example: * projects/{project_id\}/locations/{location\}/entrygroups/{entry_group_id\}/entries/{entry_id\}/tags/{tag_id\} where `tag_id` is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name. */ name?: string; /** @@ -5426,7 +5430,7 @@ export namespace datacatalog_v1beta1 { export interface Params$Resource$Projects$Locations$Tagtemplates$Patch extends StandardParameters { /** - * The resource name of the tag template in URL format. Example: * projects/{project_id\}/locations/{location\}/tagTemplates/{tag_template_id\} Note that this TagTemplate and its child resources may not actually be stored in the location in this name. + * Identifier. The resource name of the tag template in URL format. Example: * projects/{project_id\}/locations/{location\}/tagTemplates/{tag_template_id\} Note that this TagTemplate and its child resources may not actually be stored in the location in this name. */ name?: string; /** diff --git a/src/apis/dataflow/v1b3.ts b/src/apis/dataflow/v1b3.ts index 6287877a20..2c68013eeb 100644 --- a/src/apis/dataflow/v1b3.ts +++ b/src/apis/dataflow/v1b3.ts @@ -869,7 +869,7 @@ export namespace dataflow_v1b3 { */ shuffleMode?: string | null; /** - * Optional. Specifies the Streaming Engine message processing guarantees. Reduces cost and latency but might result in duplicate messages committed to storage. Designed to run simple mapping streaming ETL jobs at the lowest cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use case. + * Optional. Specifies the Streaming Engine message processing guarantees. Reduces cost and latency but might result in duplicate messages committed to storage. Designed to run simple mapping streaming ETL jobs at the lowest cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use case. For more information, see [Set the pipeline streaming mode](https://cloud.google.com/dataflow/docs/guides/streaming-modes). */ streamingMode?: string | null; /** @@ -1063,7 +1063,7 @@ export namespace dataflow_v1b3 { */ stagingLocation?: string | null; /** - * Optional. Specifies the Streaming Engine message processing guarantees. Reduces cost and latency but might result in duplicate messages committed to storage. Designed to run simple mapping streaming ETL jobs at the lowest cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use case. + * Optional. Specifies the Streaming Engine message processing guarantees. Reduces cost and latency but might result in duplicate messages committed to storage. Designed to run simple mapping streaming ETL jobs at the lowest cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use case. For more information, see [Set the pipeline streaming mode](https://cloud.google.com/dataflow/docs/guides/streaming-modes). */ streamingMode?: string | null; /** @@ -2389,7 +2389,7 @@ export namespace dataflow_v1b3 { */ export interface Schema$ResourceUtilizationReportResponse {} /** - * The environment values to set at runtime. + * The environment values to set at runtime. LINT.IfChange */ export interface Schema$RuntimeEnvironment { /** @@ -2441,7 +2441,7 @@ export namespace dataflow_v1b3 { */ serviceAccountEmail?: string | null; /** - * Optional. Specifies the Streaming Engine message processing guarantees. Reduces cost and latency but might result in duplicate messages committed to storage. Designed to run simple mapping streaming ETL jobs at the lowest cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use case. + * Optional. Specifies the Streaming Engine message processing guarantees. Reduces cost and latency but might result in duplicate messages committed to storage. Designed to run simple mapping streaming ETL jobs at the lowest cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use case. For more information, see [Set the pipeline streaming mode](https://cloud.google.com/dataflow/docs/guides/streaming-modes). */ streamingMode?: string | null; /** @@ -2491,7 +2491,7 @@ export namespace dataflow_v1b3 { */ minNumWorkers?: number | null; /** - * Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. + * Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline). */ workerUtilizationHint?: number | null; } @@ -8250,7 +8250,7 @@ export namespace dataflow_v1b3 { export interface Params$Resource$Projects$Locations$Templates$Launch extends StandardParameters { /** - * Path to dynamic template spec file on Cloud Storage. The file must be a Json serialized DynamicTemplateFieSpec object. + * Path to the dynamic template specification file on Cloud Storage. The file must be a JSON serialized `DynamicTemplateFileSpec` object. */ 'dynamicTemplate.gcsPath'?: string; /** @@ -8258,7 +8258,7 @@ export namespace dataflow_v1b3 { */ 'dynamicTemplate.stagingLocation'?: string; /** - * A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'. + * A Cloud Storage path to the template to use to create the job. Must be valid Cloud Storage URL, beginning with `gs://`. */ gcsPath?: string; /** @@ -8805,7 +8805,7 @@ export namespace dataflow_v1b3 { export interface Params$Resource$Projects$Templates$Launch extends StandardParameters { /** - * Path to dynamic template spec file on Cloud Storage. The file must be a Json serialized DynamicTemplateFieSpec object. + * Path to the dynamic template specification file on Cloud Storage. The file must be a JSON serialized `DynamicTemplateFileSpec` object. */ 'dynamicTemplate.gcsPath'?: string; /** @@ -8813,7 +8813,7 @@ export namespace dataflow_v1b3 { */ 'dynamicTemplate.stagingLocation'?: string; /** - * A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'. + * A Cloud Storage path to the template to use to create the job. Must be valid Cloud Storage URL, beginning with `gs://`. */ gcsPath?: string; /** diff --git a/src/apis/datamigration/v1.ts b/src/apis/datamigration/v1.ts index 95c1c652ef..35a867950d 100644 --- a/src/apis/datamigration/v1.ts +++ b/src/apis/datamigration/v1.ts @@ -576,6 +576,10 @@ export namespace datamigration_v1 { * The database provider. */ provider?: string | null; + /** + * Connection profile for a SQL Server data source. + */ + sqlserver?: Schema$SqlServerConnectionProfile; /** * The current connection profile state (e.g. DRAFT, READY, or FAILED). */ @@ -1587,6 +1591,10 @@ export namespace datamigration_v1 { * The database engine type and provider of the source. */ sourceDatabase?: Schema$DatabaseType; + /** + * Optional. Configuration for SQL Server homogeneous migration. + */ + sqlserverHomogeneousMigrationJobConfig?: Schema$SqlServerHomogeneousMigrationJobConfig; /** * The current migration job state. */ @@ -2326,6 +2334,115 @@ export namespace datamigration_v1 { */ requireSsl?: boolean | null; } + /** + * Specifies the backup details in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server. + */ + export interface Schema$SqlServerBackups { + /** + * Required. The Cloud Storage bucket that stores backups for all replicated databases. + */ + gcsBucket?: string | null; + /** + * Optional. Cloud Storage path inside the bucket that stores backups. + */ + gcsPrefix?: string | null; + } + /** + * Specifies connection parameters required specifically for SQL Server databases. + */ + export interface Schema$SqlServerConnectionProfile { + /** + * The backup details in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server. + */ + backups?: Schema$SqlServerBackups; + /** + * If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source. + */ + cloudSqlId?: string | null; + /** + * Forward SSH tunnel connectivity. + */ + forwardSshConnectivity?: Schema$ForwardSshTunnelConnectivity; + /** + * Required. The IP or hostname of the source SQL Server database. + */ + host?: string | null; + /** + * Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service. + */ + password?: string | null; + /** + * Output only. Indicates whether a new password is included in the request. + */ + passwordSet?: boolean | null; + /** + * Required. The network port of the source SQL Server database. + */ + port?: number | null; + /** + * Private connectivity. + */ + privateConnectivity?: Schema$PrivateConnectivity; + /** + * Private Service Connect connectivity. + */ + privateServiceConnectConnectivity?: Schema$PrivateServiceConnectConnectivity; + /** + * SSL configuration for the destination to connect to the source database. + */ + ssl?: Schema$SslConfig; + /** + * Static IP connectivity data (default, no additional details needed). + */ + staticIpConnectivity?: Schema$StaticIpConnectivity; + /** + * Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. + */ + username?: string | null; + } + /** + * Specifies the backup details for a single database in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server. + */ + export interface Schema$SqlServerDatabaseBackup { + /** + * Required. Name of a SQL Server database for which to define backup configuration. + */ + database?: string | null; + /** + * Optional. Encryption settings for the database. Required if provided database backups are encrypted. Encryption settings include path to certificate, path to certificate private key, and key password. + */ + encryptionOptions?: Schema$SqlServerEncryptionOptions; + } + /** + * Encryption settings for the SQL Server database. + */ + export interface Schema$SqlServerEncryptionOptions { + /** + * Required. Path to certificate. + */ + certPath?: string | null; + /** + * Required. Input only. Private key password. + */ + pvkPassword?: string | null; + /** + * Required. Path to certificate private key. + */ + pvkPath?: string | null; + } + /** + * Configuration for homogeneous migration to Cloud SQL for SQL Server. + */ + export interface Schema$SqlServerHomogeneousMigrationJobConfig { + /** + * Required. Pattern that describes the default backup naming strategy. The specified pattern should ensure lexicographical order of backups. The pattern must define one of the following capture group sets: Capture group set #1 yy/yyyy - year, 2 or 4 digits mm - month number, 1-12 dd - day of month, 1-31 hh - hour of day, 00-23 mi - minutes, 00-59 ss - seconds, 00-59 Example: For backup file TestDB_20230802_155400.trn, use pattern: (?.*)_backup_(?\d{4\})(?\d{2\})(?\d{2\})_(?\d{2\})(?\d{2\})(?\d{2\}).trn Capture group set #2 timestamp - unix timestamp Example: For backup file TestDB.1691448254.trn, use pattern: (?.*)\.(?\d*).trn or (?.*)\.(?\d*).trn + */ + backupFilePattern?: string | null; + /** + * Required. Backup details per database in Cloud Storage. + */ + databaseBackups?: Schema$SqlServerDatabaseBackup[]; + } /** * Response message for 'GenerateSshScript' request. */ diff --git a/src/apis/dataplex/v1.ts b/src/apis/dataplex/v1.ts index 94a9adb5cc..4587ccd4cc 100644 --- a/src/apis/dataplex/v1.ts +++ b/src/apis/dataplex/v1.ts @@ -273,6 +273,207 @@ export namespace dataplex_v1 { * Action details for unauthorized resource issues raised to indicate that the service account associated with the lake instance is not authorized to access or manage the resource associated with an asset. */ export interface Schema$GoogleCloudDataplexV1ActionUnauthorizedResource {} + /** + * An aspect is a single piece of metadata describing an entry. + */ + export interface Schema$GoogleCloudDataplexV1Aspect { + aspectSource?: Schema$GoogleCloudDataplexV1AspectSource; + /** + * Output only. The resource name of the type used to create this Aspect. + */ + aspectType?: string | null; + /** + * Output only. The time when the Aspect was created. + */ + createTime?: string | null; + /** + * Required. The content of the aspect, according to its aspect type schema. This will replace content. The maximum size of the field is 120KB (encoded as UTF-8). + */ + data?: {[key: string]: any} | null; + /** + * Output only. The path in the entry under which the aspect is attached. + */ + path?: string | null; + /** + * Output only. The time when the Aspect was last updated. + */ + updateTime?: string | null; + } + /** + * AspectSource contains source system related information for the aspect. + */ + export interface Schema$GoogleCloudDataplexV1AspectSource { + /** + * The create time of the aspect in the source system. + */ + createTime?: string | null; + /** + * The update time of the aspect in the source system. + */ + updateTime?: string | null; + } + /** + * Aspect Type is a template for creating Aspects, and represents the JSON-schema for a given Entry, e.g., BigQuery Table Schema. + */ + export interface Schema$GoogleCloudDataplexV1AspectType { + /** + * Immutable. Authorization defined for this type. + */ + authorization?: Schema$GoogleCloudDataplexV1AspectTypeAuthorization; + /** + * Output only. The time when the AspectType was created. + */ + createTime?: string | null; + /** + * Optional. Description of the AspectType. + */ + description?: string | null; + /** + * Optional. User friendly display name. + */ + displayName?: string | null; + /** + * This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. + */ + etag?: string | null; + /** + * Optional. User-defined labels for the AspectType. + */ + labels?: {[key: string]: string} | null; + /** + * Required. MetadataTemplate of the aspect. + */ + metadataTemplate?: Schema$GoogleCloudDataplexV1AspectTypeMetadataTemplate; + /** + * Output only. The relative resource name of the AspectType, of the form: projects/{project_number\}/locations/{location_id\}/aspectTypes/{aspect_type_id\}. + */ + name?: string | null; + /** + * Output only. Denotes the transfer status of the Aspect Type. It is unspecified for Aspect Types created from Dataplex API. + */ + transferStatus?: string | null; + /** + * Output only. System generated globally unique ID for the AspectType. This ID will be different if the AspectType is deleted and re-created with the same name. + */ + uid?: string | null; + /** + * Output only. The time when the AspectType was last updated. + */ + updateTime?: string | null; + } + /** + * Autorization for an Aspect Type. + */ + export interface Schema$GoogleCloudDataplexV1AspectTypeAuthorization { + /** + * Immutable. The IAM permission grantable on the Entry Group to allow access to instantiate Aspects of Dataplex owned Aspect Types, only settable for Dataplex owned Types. + */ + alternateUsePermission?: string | null; + } + /** + * MetadataTemplate definition for AspectType + */ + export interface Schema$GoogleCloudDataplexV1AspectTypeMetadataTemplate { + /** + * Optional. Specifies annotations on this field. + */ + annotations?: Schema$GoogleCloudDataplexV1AspectTypeMetadataTemplateAnnotations; + /** + * Optional. array_items needs to be set if the type is array. array_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, just name and type needs to be set in the nested MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload. + */ + arrayItems?: Schema$GoogleCloudDataplexV1AspectTypeMetadataTemplate; + /** + * Optional. Specifies the constraints on this field. + */ + constraints?: Schema$GoogleCloudDataplexV1AspectTypeMetadataTemplateConstraints; + /** + * Optional. The list of values for an enum type. Needs to be defined if the type is enum. + */ + enumValues?: Schema$GoogleCloudDataplexV1AspectTypeMetadataTemplateEnumValue[]; + /** + * Optional. Index is used to encode Template messages. The value of index can range between 1 and 2,147,483,647. Index must be unique within all fields in a Template. (Nested Templates can reuse indexes). Once a Template is defined, the index cannot be changed, because it identifies the field in the actual storage format. Index is a mandatory field, but it is optional for top level fields, and map/array "values" definitions. + */ + index?: number | null; + /** + * Optional. map_items needs to be set if the type is map. map_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, just name and type needs to be set in the nested MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload. + */ + mapItems?: Schema$GoogleCloudDataplexV1AspectTypeMetadataTemplate; + /** + * Required. The name of the field. + */ + name?: string | null; + /** + * Optional. Field definition, needs to be specified if the type is record. Defines the nested fields. + */ + recordFields?: Schema$GoogleCloudDataplexV1AspectTypeMetadataTemplate[]; + /** + * Required. The datatype of this field. The following values are supported: Primitive types (string, integer, boolean, double, datetime); datetime must be of the format RFC3339 UTC "Zulu" (Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"). Complex types (enum, array, map, record). + */ + type?: string | null; + /** + * Optional. Id can be used if this definition of the field needs to be reused later. Id needs to be unique across the entire template. Id can only be specified if the field type is record. + */ + typeId?: string | null; + /** + * Optional. A reference to another field definition (instead of an inline definition). The value must be equal to the value of an id field defined elsewhere in the MetadataTemplate. Only fields with type as record can refer to other fields. + */ + typeRef?: string | null; + } + /** + * Definition of the annotations of a field + */ + export interface Schema$GoogleCloudDataplexV1AspectTypeMetadataTemplateAnnotations { + /** + * Optional. Marks a field as deprecated, a deprecation message can be included. + */ + deprecated?: string | null; + /** + * Optional. Specify a description for a field + */ + description?: string | null; + /** + * Optional. Specify a displayname for a field. + */ + displayName?: string | null; + /** + * Optional. Specify a display order for a field. Display order can be used to reorder where a field is rendered + */ + displayOrder?: number | null; + /** + * Optional. String Type annotations can be used to specify special meaning to string fields. The following values are supported: richText: The field must be interpreted as a rich text field. url: A fully qualified url link. resource: A service qualified resource reference. + */ + stringType?: string | null; + /** + * Optional. Suggested hints for string fields. These can be used to suggest values to users, through an UI for example. + */ + stringValues?: string[] | null; + } + /** + * Definition of the constraints of a field + */ + export interface Schema$GoogleCloudDataplexV1AspectTypeMetadataTemplateConstraints { + /** + * Optional. Marks this as an optional/required field. + */ + required?: boolean | null; + } + /** + * Definition of Enumvalue (to be used by enum fields) + */ + export interface Schema$GoogleCloudDataplexV1AspectTypeMetadataTemplateEnumValue { + /** + * Optional. Optional deprecation message to be set if an enum value needs to be deprecated. + */ + deprecated?: string | null; + /** + * Required. Index for the enum. Cannot be modified. + */ + index?: number | null; + /** + * Required. Name of the enumvalue. This is the actual value that the aspect will contain. + */ + name?: string | null; + } /** * An asset represents a cloud resource that is being managed within a lake as a member of a zone. */ @@ -1931,178 +2132,395 @@ export namespace dataplex_v1 { reason?: string | null; } /** - * Environment represents a user-visible compute infrastructure for analytics within a lake. + * An entry is a representation of a data asset which can be described by various metadata. */ - export interface Schema$GoogleCloudDataplexV1Environment { + export interface Schema$GoogleCloudDataplexV1Entry { /** - * Output only. Environment creation time. + * Optional. The Aspects attached to the Entry. The key is either the resource name of the aspect type (if the aspect is attached directly to the entry) or "aspectType@path" if the aspect is attached to an entry's path. + */ + aspects?: {[key: string]: Schema$GoogleCloudDataplexV1Aspect} | null; + /** + * Output only. The time when the Entry was created. */ createTime?: string | null; /** - * Optional. Description of the environment. + * Optional. Source system related information for an entry. */ - description?: string | null; + entrySource?: Schema$GoogleCloudDataplexV1EntrySource; /** - * Optional. User friendly display name. + * Required. Immutable. The resource name of the EntryType used to create this Entry. */ - displayName?: string | null; + entryType?: string | null; /** - * Output only. URI Endpoints to access sessions associated with the Environment. + * Optional. A name for the entry that can reference it in an external system. The maximum size of the field is 4000 characters. */ - endpoints?: Schema$GoogleCloudDataplexV1EnvironmentEndpoints; + fullyQualifiedName?: string | null; /** - * Required. Infrastructure specification for the Environment. + * Identifier. The relative resource name of the Entry, of the form: projects/{project\}/locations/{location\}/entryGroups/{entry_group\}/entries/{entry\}. */ - infrastructureSpec?: Schema$GoogleCloudDataplexV1EnvironmentInfrastructureSpec; + name?: string | null; /** - * Optional. User defined labels for the environment. + * Optional. Immutable. The resource name of the parent entry. */ - labels?: {[key: string]: string} | null; + parentEntry?: string | null; /** - * Output only. The relative resource name of the environment, of the form: projects/{project_id\}/locations/{location_id\}/lakes/{lake_id\}/environment/{environment_id\} + * Output only. The time when the Entry was last updated. */ - name?: string | null; + updateTime?: string | null; + } + /** + * An Entry Group represents a logical grouping of one or more Entries. + */ + export interface Schema$GoogleCloudDataplexV1EntryGroup { /** - * Optional. Configuration for sessions created for this environment. + * Output only. The time when the EntryGroup was created. */ - sessionSpec?: Schema$GoogleCloudDataplexV1EnvironmentSessionSpec; + createTime?: string | null; /** - * Output only. Status of sessions created for this environment. + * Optional. Description of the EntryGroup. */ - sessionStatus?: Schema$GoogleCloudDataplexV1EnvironmentSessionStatus; + description?: string | null; /** - * Output only. Current state of the environment. + * Optional. User friendly display name. */ - state?: string | null; + displayName?: string | null; /** - * Output only. System generated globally unique ID for the environment. This ID will be different if the environment is deleted and re-created with the same name. + * This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. */ - uid?: string | null; + etag?: string | null; /** - * Output only. The time when the environment was last updated. + * Optional. User-defined labels for the EntryGroup. */ - updateTime?: string | null; - } - /** - * URI Endpoints to access sessions associated with the Environment. - */ - export interface Schema$GoogleCloudDataplexV1EnvironmentEndpoints { + labels?: {[key: string]: string} | null; /** - * Output only. URI to serve notebook APIs + * Output only. The relative resource name of the EntryGroup, of the form: projects/{project_number\}/locations/{location_id\}/entryGroups/{entry_group_id\}. */ - notebooks?: string | null; + name?: string | null; /** - * Output only. URI to serve SQL APIs + * Output only. Denotes the transfer status of the Entry Group. It is unspecified for Entry Group created from Dataplex API. */ - sql?: string | null; - } - /** - * Configuration for the underlying infrastructure used to run workloads. - */ - export interface Schema$GoogleCloudDataplexV1EnvironmentInfrastructureSpec { + transferStatus?: string | null; /** - * Optional. Compute resources needed for analyze interactive workloads. + * Output only. System generated globally unique ID for the EntryGroup. This ID will be different if the EntryGroup is deleted and re-created with the same name. */ - compute?: Schema$GoogleCloudDataplexV1EnvironmentInfrastructureSpecComputeResources; + uid?: string | null; /** - * Required. Software Runtime Configuration for analyze interactive workloads. + * Output only. The time when the EntryGroup was last updated. */ - osImage?: Schema$GoogleCloudDataplexV1EnvironmentInfrastructureSpecOsImageRuntime; + updateTime?: string | null; } /** - * Compute resources associated with the analyze interactive workloads. + * EntrySource contains source system related information for the entry. */ - export interface Schema$GoogleCloudDataplexV1EnvironmentInfrastructureSpecComputeResources { + export interface Schema$GoogleCloudDataplexV1EntrySource { /** - * Optional. Size in GB of the disk. Default is 100 GB. + * Immutable. The ancestors of the Entry in the source system. */ - diskSizeGb?: number | null; + ancestors?: Schema$GoogleCloudDataplexV1EntrySourceAncestor[]; /** - * Optional. Max configurable nodes. If max_node_count \> node_count, then auto-scaling is enabled. + * The create time of the resource in the source system. */ - maxNodeCount?: number | null; + createTime?: string | null; /** - * Optional. Total number of nodes in the sessions created for this environment. + * Description of the Entry. The maximum size of the field is 2000 characters. */ - nodeCount?: number | null; - } - /** - * Software Runtime Configuration to run Analyze. - */ - export interface Schema$GoogleCloudDataplexV1EnvironmentInfrastructureSpecOsImageRuntime { + description?: string | null; /** - * Required. Dataplex Image version. + * User friendly display name. The maximum size of the field is 500 characters. */ - imageVersion?: string | null; + displayName?: string | null; /** - * Optional. List of Java jars to be included in the runtime environment. Valid input includes Cloud Storage URIs to Jar binaries. For example, gs://bucket-name/my/path/to/file.jar + * User-defined labels. The maximum size of keys and values is 128 characters each. */ - javaLibraries?: string[] | null; + labels?: {[key: string]: string} | null; /** - * Optional. Spark properties to provide configuration for use in sessions created for this environment. The properties to set on daemon config files. Property keys are specified in prefix:property format. The prefix must be "spark". + * The platform containing the source system. The maximum size of the field is 64 characters. */ - properties?: {[key: string]: string} | null; + platform?: string | null; /** - * Optional. A list of python packages to be installed. Valid formats include Cloud Storage URI to a PIP installable library. For example, gs://bucket-name/my/path/to/lib.tar.gz + * The name of the resource in the source system. The maximum size of the field is 4000 characters. */ - pythonPackages?: string[] | null; - } - /** - * Configuration for sessions created for this environment. - */ - export interface Schema$GoogleCloudDataplexV1EnvironmentSessionSpec { + resource?: string | null; /** - * Optional. If True, this causes sessions to be pre-created and available for faster startup to enable interactive exploration use-cases. This defaults to False to avoid additional billed charges. These can only be set to True for the environment with name set to "default", and with default configuration. + * The name of the source system. The maximum size of the field is 64 characters. */ - enableFastStartup?: boolean | null; + system?: string | null; /** - * Optional. The idle time configuration of the session. The session will be auto-terminated at the end of this period. + * The update time of the resource in the source system. */ - maxIdleDuration?: string | null; + updateTime?: string | null; } /** - * Status of sessions created for this environment. + * Ancestor contains information about individual items in the hierarchy of an Entry. */ - export interface Schema$GoogleCloudDataplexV1EnvironmentSessionStatus { + export interface Schema$GoogleCloudDataplexV1EntrySourceAncestor { /** - * Output only. Queries over sessions to mark whether the environment is currently active or not + * Optional. The name of the ancestor resource. */ - active?: boolean | null; + name?: string | null; + /** + * Optional. The type of the ancestor resource. + */ + type?: string | null; } /** - * Payload associated with Governance related log events. + * Entry Type is a template for creating Entries. */ - export interface Schema$GoogleCloudDataplexV1GovernanceEvent { + export interface Schema$GoogleCloudDataplexV1EntryType { /** - * Entity resource information if the log event is associated with a specific entity. + * Immutable. Authorization defined for this type. */ - entity?: Schema$GoogleCloudDataplexV1GovernanceEventEntity; + authorization?: Schema$GoogleCloudDataplexV1EntryTypeAuthorization; /** - * The type of the event. + * Output only. The time when the EntryType was created. */ - eventType?: string | null; + createTime?: string | null; /** - * The log message. + * Optional. Description of the EntryType. */ - message?: string | null; - } - /** - * Information about Entity resource that the log event is associated with. - */ - export interface Schema$GoogleCloudDataplexV1GovernanceEventEntity { + description?: string | null; /** - * The Entity resource the log event is associated with. Format: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}/entities/{entity_id\} + * Optional. User friendly display name. */ - entity?: string | null; + displayName?: string | null; /** - * Type of entity. + * Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. */ - entityType?: string | null; - } - /** - * A job represents an instance of a task. - */ - export interface Schema$GoogleCloudDataplexV1Job { + etag?: string | null; + /** + * Optional. User-defined labels for the EntryType. + */ + labels?: {[key: string]: string} | null; + /** + * Output only. The relative resource name of the EntryType, of the form: projects/{project_number\}/locations/{location_id\}/entryTypes/{entry_type_id\}. + */ + name?: string | null; + /** + * Optional. The platform that Entries of this type belongs to. + */ + platform?: string | null; + /** + * AspectInfo for the entry type. + */ + requiredAspects?: Schema$GoogleCloudDataplexV1EntryTypeAspectInfo[]; + /** + * Optional. The system that Entries of this type belongs to. Examples include CloudSQL, MariaDB etc + */ + system?: string | null; + /** + * Optional. Indicates the class this Entry Type belongs to, for example, TABLE, DATABASE, MODEL. + */ + typeAliases?: string[] | null; + /** + * Output only. System generated globally unique ID for the EntryType. This ID will be different if the EntryType is deleted and re-created with the same name. + */ + uid?: string | null; + /** + * Output only. The time when the EntryType was last updated. + */ + updateTime?: string | null; + } + export interface Schema$GoogleCloudDataplexV1EntryTypeAspectInfo { + /** + * Required aspect type for the entry type. + */ + type?: string | null; + } + /** + * Authorization for an Entry Type. + */ + export interface Schema$GoogleCloudDataplexV1EntryTypeAuthorization { + /** + * Immutable. The IAM permission grantable on the Entry Group to allow access to instantiate Entries of Dataplex owned Entry Types, only settable for Dataplex owned Types. + */ + alternateUsePermission?: string | null; + } + /** + * Environment represents a user-visible compute infrastructure for analytics within a lake. + */ + export interface Schema$GoogleCloudDataplexV1Environment { + /** + * Output only. Environment creation time. + */ + createTime?: string | null; + /** + * Optional. Description of the environment. + */ + description?: string | null; + /** + * Optional. User friendly display name. + */ + displayName?: string | null; + /** + * Output only. URI Endpoints to access sessions associated with the Environment. + */ + endpoints?: Schema$GoogleCloudDataplexV1EnvironmentEndpoints; + /** + * Required. Infrastructure specification for the Environment. + */ + infrastructureSpec?: Schema$GoogleCloudDataplexV1EnvironmentInfrastructureSpec; + /** + * Optional. User defined labels for the environment. + */ + labels?: {[key: string]: string} | null; + /** + * Output only. The relative resource name of the environment, of the form: projects/{project_id\}/locations/{location_id\}/lakes/{lake_id\}/environment/{environment_id\} + */ + name?: string | null; + /** + * Optional. Configuration for sessions created for this environment. + */ + sessionSpec?: Schema$GoogleCloudDataplexV1EnvironmentSessionSpec; + /** + * Output only. Status of sessions created for this environment. + */ + sessionStatus?: Schema$GoogleCloudDataplexV1EnvironmentSessionStatus; + /** + * Output only. Current state of the environment. + */ + state?: string | null; + /** + * Output only. System generated globally unique ID for the environment. This ID will be different if the environment is deleted and re-created with the same name. + */ + uid?: string | null; + /** + * Output only. The time when the environment was last updated. + */ + updateTime?: string | null; + } + /** + * URI Endpoints to access sessions associated with the Environment. + */ + export interface Schema$GoogleCloudDataplexV1EnvironmentEndpoints { + /** + * Output only. URI to serve notebook APIs + */ + notebooks?: string | null; + /** + * Output only. URI to serve SQL APIs + */ + sql?: string | null; + } + /** + * Configuration for the underlying infrastructure used to run workloads. + */ + export interface Schema$GoogleCloudDataplexV1EnvironmentInfrastructureSpec { + /** + * Optional. Compute resources needed for analyze interactive workloads. + */ + compute?: Schema$GoogleCloudDataplexV1EnvironmentInfrastructureSpecComputeResources; + /** + * Required. Software Runtime Configuration for analyze interactive workloads. + */ + osImage?: Schema$GoogleCloudDataplexV1EnvironmentInfrastructureSpecOsImageRuntime; + } + /** + * Compute resources associated with the analyze interactive workloads. + */ + export interface Schema$GoogleCloudDataplexV1EnvironmentInfrastructureSpecComputeResources { + /** + * Optional. Size in GB of the disk. Default is 100 GB. + */ + diskSizeGb?: number | null; + /** + * Optional. Max configurable nodes. If max_node_count \> node_count, then auto-scaling is enabled. + */ + maxNodeCount?: number | null; + /** + * Optional. Total number of nodes in the sessions created for this environment. + */ + nodeCount?: number | null; + } + /** + * Software Runtime Configuration to run Analyze. + */ + export interface Schema$GoogleCloudDataplexV1EnvironmentInfrastructureSpecOsImageRuntime { + /** + * Required. Dataplex Image version. + */ + imageVersion?: string | null; + /** + * Optional. List of Java jars to be included in the runtime environment. Valid input includes Cloud Storage URIs to Jar binaries. For example, gs://bucket-name/my/path/to/file.jar + */ + javaLibraries?: string[] | null; + /** + * Optional. Spark properties to provide configuration for use in sessions created for this environment. The properties to set on daemon config files. Property keys are specified in prefix:property format. The prefix must be "spark". + */ + properties?: {[key: string]: string} | null; + /** + * Optional. A list of python packages to be installed. Valid formats include Cloud Storage URI to a PIP installable library. For example, gs://bucket-name/my/path/to/lib.tar.gz + */ + pythonPackages?: string[] | null; + } + /** + * Configuration for sessions created for this environment. + */ + export interface Schema$GoogleCloudDataplexV1EnvironmentSessionSpec { + /** + * Optional. If True, this causes sessions to be pre-created and available for faster startup to enable interactive exploration use-cases. This defaults to False to avoid additional billed charges. These can only be set to True for the environment with name set to "default", and with default configuration. + */ + enableFastStartup?: boolean | null; + /** + * Optional. The idle time configuration of the session. The session will be auto-terminated at the end of this period. + */ + maxIdleDuration?: string | null; + } + /** + * Status of sessions created for this environment. + */ + export interface Schema$GoogleCloudDataplexV1EnvironmentSessionStatus { + /** + * Output only. Queries over sessions to mark whether the environment is currently active or not + */ + active?: boolean | null; + } + /** + * Generate recommended DataQualityRules request. + */ + export interface Schema$GoogleCloudDataplexV1GenerateDataQualityRulesRequest {} + /** + * Generate recommended DataQualityRules response. + */ + export interface Schema$GoogleCloudDataplexV1GenerateDataQualityRulesResponse { + /** + * Generated recommended {@link DataQualityRule\}s. + */ + rule?: Schema$GoogleCloudDataplexV1DataQualityRule[]; + } + /** + * Payload associated with Governance related log events. + */ + export interface Schema$GoogleCloudDataplexV1GovernanceEvent { + /** + * Entity resource information if the log event is associated with a specific entity. + */ + entity?: Schema$GoogleCloudDataplexV1GovernanceEventEntity; + /** + * The type of the event. + */ + eventType?: string | null; + /** + * The log message. + */ + message?: string | null; + } + /** + * Information about Entity resource that the log event is associated with. + */ + export interface Schema$GoogleCloudDataplexV1GovernanceEventEntity { + /** + * The Entity resource the log event is associated with. Format: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}/entities/{entity_id\} + */ + entity?: string | null; + /** + * Type of entity. + */ + entityType?: string | null; + } + /** + * A job represents an instance of a task. + */ + export interface Schema$GoogleCloudDataplexV1Job { /** * Output only. The time when the job ended. */ @@ -2293,6 +2711,23 @@ export namespace dataplex_v1 { */ nextPageToken?: string | null; } + /** + * List AspectTypes response + */ + export interface Schema$GoogleCloudDataplexV1ListAspectTypesResponse { + /** + * ListAspectTypes under the given parent location. + */ + aspectTypes?: Schema$GoogleCloudDataplexV1AspectType[]; + /** + * Token to retrieve the next page of results, or empty if there are no more results in the list. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachableLocations?: string[] | null; + } /** * List assets response. */ @@ -2413,6 +2848,50 @@ export namespace dataplex_v1 { */ nextPageToken?: string | null; } + export interface Schema$GoogleCloudDataplexV1ListEntriesResponse { + /** + * The list of entries. + */ + entries?: Schema$GoogleCloudDataplexV1Entry[]; + /** + * Pagination token. + */ + nextPageToken?: string | null; + } + /** + * List ListEntryGroups response. + */ + export interface Schema$GoogleCloudDataplexV1ListEntryGroupsResponse { + /** + * ListEntryGroups under the given parent location. + */ + entryGroups?: Schema$GoogleCloudDataplexV1EntryGroup[]; + /** + * Token to retrieve the next page of results, or empty if there are no more results in the list. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachableLocations?: string[] | null; + } + /** + * List EntryTypes response + */ + export interface Schema$GoogleCloudDataplexV1ListEntryTypesResponse { + /** + * ListEntryTypes under the given parent location. + */ + entryTypes?: Schema$GoogleCloudDataplexV1EntryType[]; + /** + * Token to retrieve the next page of results, or empty if there are no more results in the list. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachableLocations?: string[] | null; + } /** * List environments response. */ @@ -2697,6 +3176,78 @@ export namespace dataplex_v1 { */ type?: string | null; } + export interface Schema$GoogleCloudDataplexV1SearchEntriesResponse { + /** + * Pagination token. + */ + nextPageToken?: string | null; + /** + * The results matching the search query. + */ + results?: Schema$GoogleCloudDataplexV1SearchEntriesResult[]; + /** + * The estimated total number of matching entries. Not guaranteed to be accurate. + */ + totalSize?: number | null; + /** + * Unreachable locations. Search results don't include data from those locations. + */ + unreachable?: string[] | null; + } + /** + * A single result of a SearchEntries request. + */ + export interface Schema$GoogleCloudDataplexV1SearchEntriesResult { + /** + * Entry format of the result. + */ + dataplexEntry?: Schema$GoogleCloudDataplexV1Entry; + /** + * Entry description. + */ + description?: string | null; + /** + * Display name. + */ + displayName?: string | null; + /** + * Resource name of the entry. + */ + entry?: string | null; + /** + * The entry type. + */ + entryType?: string | null; + /** + * Fully qualified name. + */ + fullyQualifiedName?: string | null; + /** + * Linked resource name. + */ + linkedResource?: string | null; + /** + * The last modification timestamp. + */ + modifyTime?: string | null; + /** + * Relative resource name. + */ + relativeResource?: string | null; + /** + * Snippets. + */ + snippets?: Schema$GoogleCloudDataplexV1SearchEntriesResultSnippets; + } + /** + * Snippets for the entry, contains HTML-style highlighting for matched tokens, will be used in UI. + */ + export interface Schema$GoogleCloudDataplexV1SearchEntriesResultSnippets { + /** + * Entry + */ + dataplexEntry?: Schema$GoogleCloudDataplexV1Entry; + } /** * Represents an active analyze session running for a user. */ @@ -3704,99 +4255,66 @@ export namespace dataplex_v1 { ); } } - } - - 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 { - /** - * 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$Aspecttypes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Looks up a single entry. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy, + lookupEntry( + params: Params$Resource$Projects$Locations$Lookupentry, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy, + lookupEntry( + params?: Params$Resource$Projects$Locations$Lookupentry, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy, + ): GaxiosPromise; + lookupEntry( + params: Params$Resource$Projects$Locations$Lookupentry, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + lookupEntry( + params: Params$Resource$Projects$Locations$Lookupentry, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy, - callback: BodyResponseCallback + lookupEntry( + params: Params$Resource$Projects$Locations$Lookupentry, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + lookupEntry( + callback: BodyResponseCallback ): void; - getIamPolicy( + lookupEntry( paramsOrCallback?: - | Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lookupentry + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Lookupentry; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy; + params = {} as Params$Resource$Projects$Locations$Lookupentry; options = {}; } @@ -3809,7 +4327,7 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1/{+name}:lookupEntry').replace( /([^:]\/)\/+/g, '$1' ), @@ -3818,78 +4336,79 @@ export namespace dataplex_v1 { options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. + * Searches for entries matching given query and scope. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy, + searchEntries( + params: Params$Resource$Projects$Locations$Searchentries, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy, + searchEntries( + params?: Params$Resource$Projects$Locations$Searchentries, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy, + ): GaxiosPromise; + searchEntries( + params: Params$Resource$Projects$Locations$Searchentries, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + searchEntries( + params: Params$Resource$Projects$Locations$Searchentries, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy, - callback: BodyResponseCallback + searchEntries( + params: Params$Resource$Projects$Locations$Searchentries, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + searchEntries( + callback: BodyResponseCallback ): void; - setIamPolicy( + searchEntries( paramsOrCallback?: - | Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Searchentries + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Searchentries; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy; + params = {} as Params$Resource$Projects$Locations$Searchentries; options = {}; } @@ -3902,7 +4421,7 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+name}:searchEntries').replace( /([^:]\/)\/+/g, '$1' ), @@ -3911,80 +4430,165 @@ export namespace dataplex_v1 { options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Get + extends StandardParameters { /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$List + extends StandardParameters { + /** + * A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Lookupentry + extends StandardParameters { + /** + * Optional. Limits the aspects returned to the provided aspect types. Only works if the CUSTOM view is selected. + */ + aspectTypes?: string[]; + /** + * Required. The resource name of the Entry: projects/{project\}/locations/{location\}/entryGroups/{entry_group\}/entries/{entry\}. + */ + entry?: string; + /** + * Required. The project to which the request should be attributed in the following form: projects/{project\}/locations/{location\}. + */ + name?: string; + /** + * Optional. Limits the aspects returned to those associated with the provided paths within the Entry. Only works if the CUSTOM view is selected. + */ + paths?: string[]; + /** + * Optional. View for controlling which parts of an entry are to be returned. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Searchentries + extends StandardParameters { + /** + * Required. The project to which the request should be attributed in the following form: projects/{project\}/locations/{location\}. + */ + name?: string; + /** + * Optional. Ordering of the results. Supported options to be added later. + */ + orderBy?: string; + /** + * Optional. Pagination. + */ + pageSize?: number; + /** + * + */ + pageToken?: string; + /** + * Required. The query against which entries in scope should be matched. + */ + query?: string; + /** + * Optional. The scope under which the search should be operating. Should either be organizations/ or projects/. If left unspecified, it will default to the organization where the project provided in name is located. + */ + scope?: string; + } + + export class Resource$Projects$Locations$Aspecttypes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates an AspectType * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions, + create( + params: Params$Resource$Projects$Locations$Aspecttypes$Create, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions, + create( + params?: Params$Resource$Projects$Locations$Aspecttypes$Create, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Aspecttypes$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions, + create( + params: Params$Resource$Projects$Locations$Aspecttypes$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Aspecttypes$Create, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - testIamPermissions( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Aspecttypes$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Aspecttypes$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions; + params = {} as Params$Resource$Projects$Locations$Aspecttypes$Create; options = {}; } @@ -3997,147 +4601,7 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Dataattributebindings { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Create a DataAttributeBinding resource. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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$Dataattributebindings$Create, - options: StreamMethodOptions - ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Dataattributebindings$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Dataattributebindings$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Dataattributebindings$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Dataattributebindings$Create, - callback: BodyResponseCallback - ): void; - create( - callback: BodyResponseCallback - ): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Dataattributebindings$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Dataattributebindings$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Dataattributebindings$Create; - 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}/dataAttributeBindings').replace( + url: (rootUrl + '/v1/{+parent}/aspectTypes').replace( /([^:]\/)\/+/g, '$1' ), @@ -4161,7 +4625,7 @@ export namespace dataplex_v1 { } /** - * Deletes a DataAttributeBinding resource. All attributes within the DataAttributeBinding must be deleted before the DataAttributeBinding can be deleted. + * Deletes a AspectType resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4169,27 +4633,27 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Dataattributebindings$Delete, + params: Params$Resource$Projects$Locations$Aspecttypes$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Dataattributebindings$Delete, + params?: Params$Resource$Projects$Locations$Aspecttypes$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Dataattributebindings$Delete, + params: Params$Resource$Projects$Locations$Aspecttypes$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Dataattributebindings$Delete, + params: Params$Resource$Projects$Locations$Aspecttypes$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Dataattributebindings$Delete, + params: Params$Resource$Projects$Locations$Aspecttypes$Delete, callback: BodyResponseCallback ): void; delete( @@ -4197,7 +4661,7 @@ export namespace dataplex_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Dataattributebindings$Delete + | Params$Resource$Projects$Locations$Aspecttypes$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -4213,13 +4677,12 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Dataattributebindings$Delete; + {}) as Params$Resource$Projects$Locations$Aspecttypes$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Dataattributebindings$Delete; + params = {} as Params$Resource$Projects$Locations$Aspecttypes$Delete; options = {}; } @@ -4253,7 +4716,7 @@ export namespace dataplex_v1 { } /** - * Retrieves a DataAttributeBinding resource. + * Retrieves a AspectType resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4261,57 +4724,56 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Dataattributebindings$Get, + params: Params$Resource$Projects$Locations$Aspecttypes$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Dataattributebindings$Get, + params?: Params$Resource$Projects$Locations$Aspecttypes$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Dataattributebindings$Get, + params: Params$Resource$Projects$Locations$Aspecttypes$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Dataattributebindings$Get, + params: Params$Resource$Projects$Locations$Aspecttypes$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Dataattributebindings$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Aspecttypes$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Dataattributebindings$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Aspecttypes$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Dataattributebindings$Get; + {}) as Params$Resource$Projects$Locations$Aspecttypes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Dataattributebindings$Get; + params = {} as Params$Resource$Projects$Locations$Aspecttypes$Get; options = {}; } @@ -4335,12 +4797,12 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } @@ -4355,25 +4817,25 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ getIamPolicy( - params: Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy, + params: Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; getIamPolicy( - params?: Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy, + params?: Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy, options?: MethodOptions ): GaxiosPromise; getIamPolicy( - params: Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy, + params: Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; getIamPolicy( - params: Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy, + params: Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; getIamPolicy( - params: Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy, + params: Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy, callback: BodyResponseCallback ): void; getIamPolicy( @@ -4381,7 +4843,7 @@ export namespace dataplex_v1 { ): void; getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy + | Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -4397,13 +4859,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy; + {} as Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy; options = {}; } @@ -4440,7 +4902,7 @@ export namespace dataplex_v1 { } /** - * Lists DataAttributeBinding resources in a project and location. + * Lists AspectType resources in a project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4448,57 +4910,56 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Dataattributebindings$List, + params: Params$Resource$Projects$Locations$Aspecttypes$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Dataattributebindings$List, + params?: Params$Resource$Projects$Locations$Aspecttypes$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Dataattributebindings$List, + params: Params$Resource$Projects$Locations$Aspecttypes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Dataattributebindings$List, + params: Params$Resource$Projects$Locations$Aspecttypes$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Dataattributebindings$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Aspecttypes$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Dataattributebindings$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Aspecttypes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Dataattributebindings$List; + {}) as Params$Resource$Projects$Locations$Aspecttypes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Dataattributebindings$List; + params = {} as Params$Resource$Projects$Locations$Aspecttypes$List; options = {}; } @@ -4511,7 +4972,7 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/dataAttributeBindings').replace( + url: (rootUrl + '/v1/{+parent}/aspectTypes').replace( /([^:]\/)\/+/g, '$1' ), @@ -4525,19 +4986,19 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a DataAttributeBinding resource. + * Updates a AspectType resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4545,27 +5006,27 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Dataattributebindings$Patch, + params: Params$Resource$Projects$Locations$Aspecttypes$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Dataattributebindings$Patch, + params?: Params$Resource$Projects$Locations$Aspecttypes$Patch, options?: MethodOptions ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Dataattributebindings$Patch, + params: Params$Resource$Projects$Locations$Aspecttypes$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Dataattributebindings$Patch, + params: Params$Resource$Projects$Locations$Aspecttypes$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Dataattributebindings$Patch, + params: Params$Resource$Projects$Locations$Aspecttypes$Patch, callback: BodyResponseCallback ): void; patch( @@ -4573,7 +5034,7 @@ export namespace dataplex_v1 { ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Dataattributebindings$Patch + | Params$Resource$Projects$Locations$Aspecttypes$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -4589,13 +5050,12 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Dataattributebindings$Patch; + {}) as Params$Resource$Projects$Locations$Aspecttypes$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Dataattributebindings$Patch; + params = {} as Params$Resource$Projects$Locations$Aspecttypes$Patch; options = {}; } @@ -4637,25 +5097,25 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ setIamPolicy( - params: Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy, + params: Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; setIamPolicy( - params?: Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy, + params?: Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy, options?: MethodOptions ): GaxiosPromise; setIamPolicy( - params: Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy, + params: Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; setIamPolicy( - params: Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy, + params: Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; setIamPolicy( - params: Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy, + params: Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy, callback: BodyResponseCallback ): void; setIamPolicy( @@ -4663,7 +5123,7 @@ export namespace dataplex_v1 { ): void; setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy + | Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -4679,13 +5139,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy; + {} as Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy; options = {}; } @@ -4730,27 +5190,27 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ testIamPermissions( - params: Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions, + params: Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; testIamPermissions( - params?: Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions, + params?: Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions, options?: MethodOptions ): GaxiosPromise; testIamPermissions( - params: Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions, + params: Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions, + params: Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions, + params: Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions, callback: BodyResponseCallback ): void; testIamPermissions( @@ -4758,7 +5218,7 @@ export namespace dataplex_v1 { ): void; testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions + | Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -4774,13 +5234,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions; + {} as Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions; options = {}; } @@ -4819,14 +5279,14 @@ export namespace dataplex_v1 { } } - export interface Params$Resource$Projects$Locations$Dataattributebindings$Create + export interface Params$Resource$Projects$Locations$Aspecttypes$Create extends StandardParameters { /** - * Required. DataAttributeBinding 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 Location. + * Required. AspectType identifier. */ - dataAttributeBindingId?: string; + aspectTypeId?: string; /** - * Required. The resource name of the parent data taxonomy projects/{project_number\}/locations/{location_id\} + * Required. The resource name of the AspectType, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a GCP region. */ parent?: string; /** @@ -4837,27 +5297,27 @@ export namespace dataplex_v1 { /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDataplexV1DataAttributeBinding; + requestBody?: Schema$GoogleCloudDataplexV1AspectType; } - export interface Params$Resource$Projects$Locations$Dataattributebindings$Delete + export interface Params$Resource$Projects$Locations$Aspecttypes$Delete extends StandardParameters { /** - * Required. If the client provided etag value does not match the current etag value, the DeleteDataAttributeBindingRequest method returns an ABORTED error response. Etags must be used when calling the DeleteDataAttributeBinding. + * Optional. If the client provided etag value does not match the current etag value, the DeleteAspectTypeRequest method returns an ABORTED error response */ etag?: string; /** - * Required. The resource name of the DataAttributeBinding: projects/{project_number\}/locations/{location_id\}/dataAttributeBindings/{data_attribute_binding_id\} + * Required. The resource name of the AspectType: projects/{project_number\}/locations/{location_id\}/aspectTypes/{aspect_type_id\}. */ name?: string; } - export interface Params$Resource$Projects$Locations$Dataattributebindings$Get + export interface Params$Resource$Projects$Locations$Aspecttypes$Get extends StandardParameters { /** - * Required. The resource name of the DataAttributeBinding: projects/{project_number\}/locations/{location_id\}/dataAttributeBindings/{data_attribute_binding_id\} + * Required. The resource name of the AspectType: projects/{project_number\}/locations/{location_id\}/aspectTypes/{aspect_type_id\}. */ name?: string; } - export interface Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy + export interface Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy extends StandardParameters { /** * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). @@ -4868,33 +5328,33 @@ export namespace dataplex_v1 { */ resource?: string; } - export interface Params$Resource$Projects$Locations$Dataattributebindings$List + export interface Params$Resource$Projects$Locations$Aspecttypes$List extends StandardParameters { /** - * Optional. Filter request. Filter using resource: filter=resource:"resource-name" Filter using attribute: filter=attributes:"attribute-name" Filter using attribute in paths list: filter=paths.attributes:"attribute-name" + * Optional. Filter request. Filters are case-sensitive. The following formats are supported:labels.key1 = "value1" labels:key1 name = "value" These restrictions can be coinjoined with AND, OR and NOT conjunctions. */ filter?: string; /** - * Optional. Order by fields for the result. + * Optional. Order by fields (name or create_time) for the result. If not specified, the ordering is undefined. */ orderBy?: string; /** - * Optional. Maximum number of DataAttributeBindings to return. The service may return fewer than this value. If unspecified, at most 10 DataAttributeBindings will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of AspectTypes to return. The service may return fewer than this value. If unspecified, at most 10 AspectTypes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. */ pageSize?: number; /** - * Optional. Page token received from a previous ListDataAttributeBindings call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataAttributeBindings must match the call that provided the page token. + * Optional. Page token received from a previous ListAspectTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAspectTypes must match the call that provided the page token. */ pageToken?: string; /** - * Required. The resource name of the Location: projects/{project_number\}/locations/{location_id\} + * Required. The resource name of the AspectType location, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a GCP region. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Dataattributebindings$Patch + export interface Params$Resource$Projects$Locations$Aspecttypes$Patch extends StandardParameters { /** - * Output only. The relative resource name of the Data Attribute Binding, of the form: projects/{project_number\}/locations/{location\}/dataAttributeBindings/{data_attribute_binding_id\} + * Output only. The relative resource name of the AspectType, of the form: projects/{project_number\}/locations/{location_id\}/aspectTypes/{aspect_type_id\}. */ name?: string; /** @@ -4909,9 +5369,9 @@ export namespace dataplex_v1 { /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDataplexV1DataAttributeBinding; + requestBody?: Schema$GoogleCloudDataplexV1AspectType; } - export interface Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy + export interface Params$Resource$Projects$Locations$Aspecttypes$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. @@ -4923,7 +5383,7 @@ export namespace dataplex_v1 { */ requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions + export interface Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions extends StandardParameters { /** * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. @@ -4936,16 +5396,14 @@ export namespace dataplex_v1 { requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; } - export class Resource$Projects$Locations$Datascans { + export class Resource$Projects$Locations$Dataattributebindings { context: APIRequestContext; - jobs: Resource$Projects$Locations$Datascans$Jobs; constructor(context: APIRequestContext) { this.context = context; - this.jobs = new Resource$Projects$Locations$Datascans$Jobs(this.context); } /** - * Creates a DataScan resource. + * Create a DataAttributeBinding resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4953,27 +5411,27 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Datascans$Create, + params: Params$Resource$Projects$Locations$Dataattributebindings$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Datascans$Create, + params?: Params$Resource$Projects$Locations$Dataattributebindings$Create, options?: MethodOptions ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Datascans$Create, + params: Params$Resource$Projects$Locations$Dataattributebindings$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Datascans$Create, + params: Params$Resource$Projects$Locations$Dataattributebindings$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Datascans$Create, + params: Params$Resource$Projects$Locations$Dataattributebindings$Create, callback: BodyResponseCallback ): void; create( @@ -4981,7 +5439,7 @@ export namespace dataplex_v1 { ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datascans$Create + | Params$Resource$Projects$Locations$Dataattributebindings$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -4997,12 +5455,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datascans$Create; + {}) as Params$Resource$Projects$Locations$Dataattributebindings$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datascans$Create; + params = + {} as Params$Resource$Projects$Locations$Dataattributebindings$Create; options = {}; } @@ -5015,7 +5474,7 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/dataScans').replace( + url: (rootUrl + '/v1/{+parent}/dataAttributeBindings').replace( /([^:]\/)\/+/g, '$1' ), @@ -5039,7 +5498,7 @@ export namespace dataplex_v1 { } /** - * Deletes a DataScan resource. + * Deletes a DataAttributeBinding resource. All attributes within the DataAttributeBinding must be deleted before the DataAttributeBinding can be deleted. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5047,27 +5506,27 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Datascans$Delete, + params: Params$Resource$Projects$Locations$Dataattributebindings$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Datascans$Delete, + params?: Params$Resource$Projects$Locations$Dataattributebindings$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Datascans$Delete, + params: Params$Resource$Projects$Locations$Dataattributebindings$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datascans$Delete, + params: Params$Resource$Projects$Locations$Dataattributebindings$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datascans$Delete, + params: Params$Resource$Projects$Locations$Dataattributebindings$Delete, callback: BodyResponseCallback ): void; delete( @@ -5075,7 +5534,7 @@ export namespace dataplex_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datascans$Delete + | Params$Resource$Projects$Locations$Dataattributebindings$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5091,12 +5550,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datascans$Delete; + {}) as Params$Resource$Projects$Locations$Dataattributebindings$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datascans$Delete; + params = + {} as Params$Resource$Projects$Locations$Dataattributebindings$Delete; options = {}; } @@ -5130,7 +5590,7 @@ export namespace dataplex_v1 { } /** - * Gets a DataScan resource. + * Retrieves a DataAttributeBinding resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5138,56 +5598,57 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datascans$Get, + params: Params$Resource$Projects$Locations$Dataattributebindings$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Datascans$Get, + params?: Params$Resource$Projects$Locations$Dataattributebindings$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Datascans$Get, + params: Params$Resource$Projects$Locations$Dataattributebindings$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datascans$Get, + params: Params$Resource$Projects$Locations$Dataattributebindings$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datascans$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Dataattributebindings$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datascans$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Dataattributebindings$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datascans$Get; + {}) as Params$Resource$Projects$Locations$Dataattributebindings$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datascans$Get; + params = + {} as Params$Resource$Projects$Locations$Dataattributebindings$Get; options = {}; } @@ -5211,12 +5672,12 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } @@ -5231,25 +5692,25 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ getIamPolicy( - params: Params$Resource$Projects$Locations$Datascans$Getiampolicy, + params: Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; getIamPolicy( - params?: Params$Resource$Projects$Locations$Datascans$Getiampolicy, + params?: Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy, options?: MethodOptions ): GaxiosPromise; getIamPolicy( - params: Params$Resource$Projects$Locations$Datascans$Getiampolicy, + params: Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; getIamPolicy( - params: Params$Resource$Projects$Locations$Datascans$Getiampolicy, + params: Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; getIamPolicy( - params: Params$Resource$Projects$Locations$Datascans$Getiampolicy, + params: Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy, callback: BodyResponseCallback ): void; getIamPolicy( @@ -5257,7 +5718,7 @@ export namespace dataplex_v1 { ): void; getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datascans$Getiampolicy + | Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5273,13 +5734,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datascans$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datascans$Getiampolicy; + {} as Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy; options = {}; } @@ -5316,7 +5777,7 @@ export namespace dataplex_v1 { } /** - * Lists DataScans. + * Lists DataAttributeBinding resources in a project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5324,56 +5785,57 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datascans$List, + params: Params$Resource$Projects$Locations$Dataattributebindings$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Datascans$List, + params?: Params$Resource$Projects$Locations$Dataattributebindings$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Datascans$List, + params: Params$Resource$Projects$Locations$Dataattributebindings$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datascans$List, + params: Params$Resource$Projects$Locations$Dataattributebindings$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datascans$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Dataattributebindings$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datascans$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Dataattributebindings$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datascans$List; + {}) as Params$Resource$Projects$Locations$Dataattributebindings$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datascans$List; + params = + {} as Params$Resource$Projects$Locations$Dataattributebindings$List; options = {}; } @@ -5386,7 +5848,7 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/dataScans').replace( + url: (rootUrl + '/v1/{+parent}/dataAttributeBindings').replace( /([^:]\/)\/+/g, '$1' ), @@ -5400,19 +5862,19 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a DataScan resource. + * Updates a DataAttributeBinding resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5420,27 +5882,27 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Datascans$Patch, + params: Params$Resource$Projects$Locations$Dataattributebindings$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Datascans$Patch, + params?: Params$Resource$Projects$Locations$Dataattributebindings$Patch, options?: MethodOptions ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Datascans$Patch, + params: Params$Resource$Projects$Locations$Dataattributebindings$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Datascans$Patch, + params: Params$Resource$Projects$Locations$Dataattributebindings$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Datascans$Patch, + params: Params$Resource$Projects$Locations$Dataattributebindings$Patch, callback: BodyResponseCallback ): void; patch( @@ -5448,7 +5910,7 @@ export namespace dataplex_v1 { ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datascans$Patch + | Params$Resource$Projects$Locations$Dataattributebindings$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5464,12 +5926,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datascans$Patch; + {}) as Params$Resource$Projects$Locations$Dataattributebindings$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datascans$Patch; + params = + {} as Params$Resource$Projects$Locations$Dataattributebindings$Patch; options = {}; } @@ -5503,64 +5966,63 @@ export namespace dataplex_v1 { } /** - * Runs an on-demand execution of a DataScan + * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - run( - params: Params$Resource$Projects$Locations$Datascans$Run, + setIamPolicy( + params: Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; - run( - params?: Params$Resource$Projects$Locations$Datascans$Run, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy, options?: MethodOptions - ): GaxiosPromise; - run( - params: Params$Resource$Projects$Locations$Datascans$Run, + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - run( - params: Params$Resource$Projects$Locations$Datascans$Run, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - run( - params: Params$Resource$Projects$Locations$Datascans$Run, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy, + callback: BodyResponseCallback ): void; - run( - callback: BodyResponseCallback + setIamPolicy( + callback: BodyResponseCallback ): void; - run( + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datascans$Run - | BodyResponseCallback + | Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datascans$Run; + {}) as Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datascans$Run; + params = + {} as Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy; options = {}; } @@ -5573,123 +6035,31 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:run').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Datascans$Setiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Datascans$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datascans$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datascans$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datascans$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy( - callback: BodyResponseCallback - ): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datascans$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datascans$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datascans$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5697,27 +6067,27 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ testIamPermissions( - params: Params$Resource$Projects$Locations$Datascans$Testiampermissions, + params: Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; testIamPermissions( - params?: Params$Resource$Projects$Locations$Datascans$Testiampermissions, + params?: Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions, options?: MethodOptions ): GaxiosPromise; testIamPermissions( - params: Params$Resource$Projects$Locations$Datascans$Testiampermissions, + params: Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Projects$Locations$Datascans$Testiampermissions, + params: Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Projects$Locations$Datascans$Testiampermissions, + params: Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions, callback: BodyResponseCallback ): void; testIamPermissions( @@ -5725,7 +6095,7 @@ export namespace dataplex_v1 { ): void; testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datascans$Testiampermissions + | Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5741,13 +6111,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datascans$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datascans$Testiampermissions; + {} as Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions; options = {}; } @@ -5786,14 +6156,14 @@ export namespace dataplex_v1 { } } - export interface Params$Resource$Projects$Locations$Datascans$Create + export interface Params$Resource$Projects$Locations$Dataattributebindings$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. + * Required. DataAttributeBinding 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 Location. */ - dataScanId?: string; + dataAttributeBindingId?: string; /** - * 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 GCP region. + * Required. The resource name of the parent data taxonomy projects/{project_number\}/locations/{location_id\} */ parent?: string; /** @@ -5804,27 +6174,27 @@ export namespace dataplex_v1 { /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDataplexV1DataScan; + requestBody?: Schema$GoogleCloudDataplexV1DataAttributeBinding; } - export interface Params$Resource$Projects$Locations$Datascans$Delete + export interface Params$Resource$Projects$Locations$Dataattributebindings$Delete extends StandardParameters { /** - * Required. The resource name of the dataScan: projects/{project\}/locations/{location_id\}/dataScans/{data_scan_id\} where project refers to a project_id or project_number and location_id refers to a GCP region. + * Required. If the client provided etag value does not match the current etag value, the DeleteDataAttributeBindingRequest method returns an ABORTED error response. Etags must be used when calling the DeleteDataAttributeBinding. + */ + etag?: string; + /** + * Required. The resource name of the DataAttributeBinding: projects/{project_number\}/locations/{location_id\}/dataAttributeBindings/{data_attribute_binding_id\} */ name?: string; } - export interface Params$Resource$Projects$Locations$Datascans$Get + export interface Params$Resource$Projects$Locations$Dataattributebindings$Get extends StandardParameters { /** - * Required. The resource name of the dataScan: projects/{project\}/locations/{location_id\}/dataScans/{data_scan_id\} where project refers to a project_id or project_number and location_id refers to a GCP region. + * Required. The resource name of the DataAttributeBinding: projects/{project_number\}/locations/{location_id\}/dataAttributeBindings/{data_attribute_binding_id\} */ name?: string; - /** - * Optional. Select the DataScan view to return. Defaults to BASIC. - */ - view?: string; } - export interface Params$Resource$Projects$Locations$Datascans$Getiampolicy + export interface Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy extends StandardParameters { /** * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). @@ -5835,33 +6205,33 @@ export namespace dataplex_v1 { */ resource?: string; } - export interface Params$Resource$Projects$Locations$Datascans$List + export interface Params$Resource$Projects$Locations$Dataattributebindings$List extends StandardParameters { /** - * Optional. Filter request. + * Optional. Filter request. Filter using resource: filter=resource:"resource-name" Filter using attribute: filter=attributes:"attribute-name" Filter using attribute in paths list: filter=paths.attributes:"attribute-name" */ filter?: string; /** - * Optional. Order by fields (name or create_time) for the result. If not specified, the ordering is undefined. + * Optional. Order by fields for the result. */ orderBy?: string; /** - * Optional. Maximum number of dataScans to return. The service may return fewer than this value. If unspecified, at most 500 scans will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of DataAttributeBindings to return. The service may return fewer than this value. If unspecified, at most 10 DataAttributeBindings will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. */ pageSize?: number; /** - * Optional. Page token received from a previous ListDataScans call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataScans must match the call that provided the page token. + * Optional. Page token received from a previous ListDataAttributeBindings call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataAttributeBindings must match the call that provided the page token. */ pageToken?: string; /** - * 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 GCP region. + * Required. The resource name of the Location: projects/{project_number\}/locations/{location_id\} */ parent?: string; } - export interface Params$Resource$Projects$Locations$Datascans$Patch + export interface Params$Resource$Projects$Locations$Dataattributebindings$Patch extends StandardParameters { /** - * Output only. The relative resource name of the scan, of the form: projects/{project\}/locations/{location_id\}/dataScans/{datascan_id\}, where project refers to a project_id or project_number and location_id refers to a GCP region. + * Output only. The relative resource name of the Data Attribute Binding, of the form: projects/{project_number\}/locations/{location\}/dataAttributeBindings/{data_attribute_binding_id\} */ name?: string; /** @@ -5876,21 +6246,9 @@ export namespace dataplex_v1 { /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDataplexV1DataScan; - } - export interface Params$Resource$Projects$Locations$Datascans$Run - extends StandardParameters { - /** - * Required. The resource name of the DataScan: projects/{project\}/locations/{location_id\}/dataScans/{data_scan_id\}. where project refers to a project_id or project_number and location_id refers to a GCP region.Only OnDemand data scans are allowed. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDataplexV1RunDataScanRequest; + requestBody?: Schema$GoogleCloudDataplexV1DataAttributeBinding; } - export interface Params$Resource$Projects$Locations$Datascans$Setiampolicy + export interface Params$Resource$Projects$Locations$Dataattributebindings$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. @@ -5902,7 +6260,7 @@ export namespace dataplex_v1 { */ requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Datascans$Testiampermissions + export interface Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions extends StandardParameters { /** * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. @@ -5915,71 +6273,73 @@ export namespace dataplex_v1 { requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; } - export class Resource$Projects$Locations$Datascans$Jobs { + export class Resource$Projects$Locations$Datascans { context: APIRequestContext; + jobs: Resource$Projects$Locations$Datascans$Jobs; constructor(context: APIRequestContext) { this.context = context; + this.jobs = new Resource$Projects$Locations$Datascans$Jobs(this.context); } /** - * Gets a DataScanJob resource. + * Creates a DataScan resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Datascans$Jobs$Get, + create( + params: Params$Resource$Projects$Locations$Datascans$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datascans$Jobs$Get, + create( + params?: Params$Resource$Projects$Locations$Datascans$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datascans$Jobs$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datascans$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datascans$Jobs$Get, + create( + params: Params$Resource$Projects$Locations$Datascans$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datascans$Jobs$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datascans$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datascans$Jobs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datascans$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datascans$Jobs$Get; + {}) as Params$Resource$Projects$Locations$Datascans$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datascans$Jobs$Get; + params = {} as Params$Resource$Projects$Locations$Datascans$Create; options = {}; } @@ -5992,200 +6352,67 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/dataScans').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', }, 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 DataScanJobs under the given DataScan. + * Deletes a DataScan resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Datascans$Jobs$List, + delete( + params: Params$Resource$Projects$Locations$Datascans$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datascans$Jobs$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datascans$Jobs$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Datascans$Jobs$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Datascans$Jobs$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datascans$Jobs$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datascans$Jobs$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datascans$Jobs$List; - 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}/jobs').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - 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$Datascans$Jobs$Get - extends StandardParameters { - /** - * Required. The resource name of the DataScanJob: projects/{project\}/locations/{location_id\}/dataScans/{data_scan_id\}/jobs/{data_scan_job_id\} where project refers to a project_id or project_number and location_id refers to a GCP region. - */ - name?: string; - /** - * Optional. Select the DataScanJob view to return. Defaults to BASIC. - */ - view?: string; - } - export interface Params$Resource$Projects$Locations$Datascans$Jobs$List - extends StandardParameters { - /** - * Optional. An expression for filtering the results of the ListDataScanJobs request.If unspecified, all datascan jobs will be returned. Multiple filters can be applied (with AND, OR logical operators). Filters are case-sensitive.Allowed fields are: start_time end_timestart_time and end_time expect RFC-3339 formatted strings (e.g. 2018-10-08T18:30:00-07:00).For instance, 'start_time \> 2018-10-08T00:00:00.123456789Z AND end_time < 2018-10-09T00:00:00.123456789Z' limits results to DataScanJobs between specified start and end times. - */ - filter?: string; - /** - * Optional. Maximum number of DataScanJobs to return. The service may return fewer than this value. If unspecified, at most 10 DataScanJobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * Optional. Page token received from a previous ListDataScanJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataScanJobs must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The resource name of the parent environment: projects/{project\}/locations/{location_id\}/dataScans/{data_scan_id\} where project refers to a project_id or project_number and location_id refers to a GCP region. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Datataxonomies { - context: APIRequestContext; - attributes: Resource$Projects$Locations$Datataxonomies$Attributes; - constructor(context: APIRequestContext) { - this.context = context; - this.attributes = - new Resource$Projects$Locations$Datataxonomies$Attributes(this.context); - } - - /** - * Create a DataTaxonomy resource. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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$Datataxonomies$Create, - options: StreamMethodOptions - ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datataxonomies$Create, + delete( + params?: Params$Resource$Projects$Locations$Datascans$Delete, options?: MethodOptions ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datataxonomies$Create, + delete( + params: Params$Resource$Projects$Locations$Datascans$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datataxonomies$Create, + delete( + params: Params$Resource$Projects$Locations$Datascans$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datataxonomies$Create, + delete( + params: Params$Resource$Projects$Locations$Datascans$Delete, callback: BodyResponseCallback ): void; - create( + delete( callback: BodyResponseCallback ): void; - create( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datataxonomies$Create + | Params$Resource$Projects$Locations$Datascans$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -6201,12 +6428,12 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datataxonomies$Create; + {}) as Params$Resource$Projects$Locations$Datascans$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datataxonomies$Create; + params = {} as Params$Resource$Projects$Locations$Datascans$Delete; options = {}; } @@ -6219,17 +6446,14 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/dataTaxonomies').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -6243,64 +6467,65 @@ export namespace dataplex_v1 { } /** - * Deletes a DataTaxonomy resource. All attributes within the DataTaxonomy must be deleted before the DataTaxonomy can be deleted. + * Generates recommended DataQualityRule from a data profiling DataScan. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Datataxonomies$Delete, + generateDataQualityRules( + params: Params$Resource$Projects$Locations$Datascans$Generatedataqualityrules, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datataxonomies$Delete, + generateDataQualityRules( + params?: Params$Resource$Projects$Locations$Datascans$Generatedataqualityrules, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datataxonomies$Delete, + ): GaxiosPromise; + generateDataQualityRules( + params: Params$Resource$Projects$Locations$Datascans$Generatedataqualityrules, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datataxonomies$Delete, + generateDataQualityRules( + params: Params$Resource$Projects$Locations$Datascans$Generatedataqualityrules, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datataxonomies$Delete, - callback: BodyResponseCallback + generateDataQualityRules( + params: Params$Resource$Projects$Locations$Datascans$Generatedataqualityrules, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + generateDataQualityRules( + callback: BodyResponseCallback ): void; - delete( + generateDataQualityRules( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datataxonomies$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datascans$Generatedataqualityrules + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datataxonomies$Delete; + {}) as Params$Resource$Projects$Locations$Datascans$Generatedataqualityrules; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datataxonomies$Delete; + params = + {} as Params$Resource$Projects$Locations$Datascans$Generatedataqualityrules; options = {}; } @@ -6313,8 +6538,11 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:generateDataQualityRules').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', }, options ), @@ -6324,17 +6552,19 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Retrieves a DataTaxonomy resource. + * Gets a DataScan resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6342,56 +6572,56 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datataxonomies$Get, + params: Params$Resource$Projects$Locations$Datascans$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Datataxonomies$Get, + params?: Params$Resource$Projects$Locations$Datascans$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Datataxonomies$Get, + params: Params$Resource$Projects$Locations$Datascans$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datataxonomies$Get, + params: Params$Resource$Projects$Locations$Datascans$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datataxonomies$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datascans$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datataxonomies$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datascans$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datataxonomies$Get; + {}) as Params$Resource$Projects$Locations$Datascans$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datataxonomies$Get; + params = {} as Params$Resource$Projects$Locations$Datascans$Get; options = {}; } @@ -6415,12 +6645,12 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } @@ -6435,25 +6665,25 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ getIamPolicy( - params: Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy, + params: Params$Resource$Projects$Locations$Datascans$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; getIamPolicy( - params?: Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy, + params?: Params$Resource$Projects$Locations$Datascans$Getiampolicy, options?: MethodOptions ): GaxiosPromise; getIamPolicy( - params: Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy, + params: Params$Resource$Projects$Locations$Datascans$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; getIamPolicy( - params: Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy, + params: Params$Resource$Projects$Locations$Datascans$Getiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; getIamPolicy( - params: Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy, + params: Params$Resource$Projects$Locations$Datascans$Getiampolicy, callback: BodyResponseCallback ): void; getIamPolicy( @@ -6461,7 +6691,7 @@ export namespace dataplex_v1 { ): void; getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy + | Params$Resource$Projects$Locations$Datascans$Getiampolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -6477,13 +6707,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Datascans$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy; + {} as Params$Resource$Projects$Locations$Datascans$Getiampolicy; options = {}; } @@ -6520,7 +6750,7 @@ export namespace dataplex_v1 { } /** - * Lists DataTaxonomy resources in a project and location. + * Lists DataScans. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6528,56 +6758,56 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datataxonomies$List, + params: Params$Resource$Projects$Locations$Datascans$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Datataxonomies$List, + params?: Params$Resource$Projects$Locations$Datascans$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Datataxonomies$List, + params: Params$Resource$Projects$Locations$Datascans$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datataxonomies$List, + params: Params$Resource$Projects$Locations$Datascans$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datataxonomies$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datascans$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datataxonomies$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datascans$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datataxonomies$List; + {}) as Params$Resource$Projects$Locations$Datascans$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datataxonomies$List; + params = {} as Params$Resource$Projects$Locations$Datascans$List; options = {}; } @@ -6590,7 +6820,7 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/dataTaxonomies').replace( + url: (rootUrl + '/v1/{+parent}/dataScans').replace( /([^:]\/)\/+/g, '$1' ), @@ -6604,19 +6834,19 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a DataTaxonomy resource. + * Updates a DataScan resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6624,27 +6854,27 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Datataxonomies$Patch, + params: Params$Resource$Projects$Locations$Datascans$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Datataxonomies$Patch, + params?: Params$Resource$Projects$Locations$Datascans$Patch, options?: MethodOptions ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Datataxonomies$Patch, + params: Params$Resource$Projects$Locations$Datascans$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Datataxonomies$Patch, + params: Params$Resource$Projects$Locations$Datascans$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Datataxonomies$Patch, + params: Params$Resource$Projects$Locations$Datascans$Patch, callback: BodyResponseCallback ): void; patch( @@ -6652,7 +6882,7 @@ export namespace dataplex_v1 { ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datataxonomies$Patch + | Params$Resource$Projects$Locations$Datascans$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -6668,12 +6898,12 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datataxonomies$Patch; + {}) as Params$Resource$Projects$Locations$Datascans$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datataxonomies$Patch; + params = {} as Params$Resource$Projects$Locations$Datascans$Patch; options = {}; } @@ -6706,6 +6936,99 @@ export namespace dataplex_v1 { } } + /** + * Runs an on-demand execution of a DataScan + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + run( + params: Params$Resource$Projects$Locations$Datascans$Run, + options: StreamMethodOptions + ): GaxiosPromise; + run( + params?: Params$Resource$Projects$Locations$Datascans$Run, + options?: MethodOptions + ): GaxiosPromise; + run( + params: Params$Resource$Projects$Locations$Datascans$Run, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + run( + params: Params$Resource$Projects$Locations$Datascans$Run, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + run( + params: Params$Resource$Projects$Locations$Datascans$Run, + callback: BodyResponseCallback + ): void; + run( + callback: BodyResponseCallback + ): void; + run( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datascans$Run + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datascans$Run; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datascans$Run; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:run').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. * @@ -6715,25 +7038,25 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ setIamPolicy( - params: Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy, + params: Params$Resource$Projects$Locations$Datascans$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; setIamPolicy( - params?: Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy, + params?: Params$Resource$Projects$Locations$Datascans$Setiampolicy, options?: MethodOptions ): GaxiosPromise; setIamPolicy( - params: Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy, + params: Params$Resource$Projects$Locations$Datascans$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; setIamPolicy( - params: Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy, + params: Params$Resource$Projects$Locations$Datascans$Setiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; setIamPolicy( - params: Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy, + params: Params$Resource$Projects$Locations$Datascans$Setiampolicy, callback: BodyResponseCallback ): void; setIamPolicy( @@ -6741,7 +7064,7 @@ export namespace dataplex_v1 { ): void; setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy + | Params$Resource$Projects$Locations$Datascans$Setiampolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -6757,13 +7080,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Datascans$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy; + {} as Params$Resource$Projects$Locations$Datascans$Setiampolicy; options = {}; } @@ -6808,27 +7131,27 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ testIamPermissions( - params: Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions, + params: Params$Resource$Projects$Locations$Datascans$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; testIamPermissions( - params?: Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions, + params?: Params$Resource$Projects$Locations$Datascans$Testiampermissions, options?: MethodOptions ): GaxiosPromise; testIamPermissions( - params: Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions, + params: Params$Resource$Projects$Locations$Datascans$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions, + params: Params$Resource$Projects$Locations$Datascans$Testiampermissions, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions, + params: Params$Resource$Projects$Locations$Datascans$Testiampermissions, callback: BodyResponseCallback ): void; testIamPermissions( @@ -6836,7 +7159,7 @@ export namespace dataplex_v1 { ): void; testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions + | Params$Resource$Projects$Locations$Datascans$Testiampermissions | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -6852,13 +7175,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Datascans$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions; + {} as Params$Resource$Projects$Locations$Datascans$Testiampermissions; options = {}; } @@ -6897,14 +7220,14 @@ export namespace dataplex_v1 { } } - export interface Params$Resource$Projects$Locations$Datataxonomies$Create + export interface Params$Resource$Projects$Locations$Datascans$Create extends StandardParameters { /** - * Required. DataTaxonomy 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 Project. + * 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. */ - dataTaxonomyId?: string; + dataScanId?: string; /** - * Required. The resource name of the data taxonomy location, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a GCP region. + * 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 GCP region. */ parent?: string; /** @@ -6915,27 +7238,39 @@ export namespace dataplex_v1 { /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDataplexV1DataTaxonomy; + requestBody?: Schema$GoogleCloudDataplexV1DataScan; } - export interface Params$Resource$Projects$Locations$Datataxonomies$Delete + export interface Params$Resource$Projects$Locations$Datascans$Delete extends StandardParameters { /** - * Optional. If the client provided etag value does not match the current etag value,the DeleteDataTaxonomy method returns an ABORTED error. + * Required. The resource name of the dataScan: projects/{project\}/locations/{location_id\}/dataScans/{data_scan_id\} where project refers to a project_id or project_number and location_id refers to a GCP region. */ - etag?: string; + name?: string; + } + export interface Params$Resource$Projects$Locations$Datascans$Generatedataqualityrules + extends StandardParameters { /** - * Required. The resource name of the DataTaxonomy: projects/{project_number\}/locations/{location_id\}/dataTaxonomies/{data_taxonomy_id\} + * Required. The name should be either * the name of a datascan with at least one successful completed data profiling job, or * the name of a successful completed data profiling datascan job. */ name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1GenerateDataQualityRulesRequest; } - export interface Params$Resource$Projects$Locations$Datataxonomies$Get + export interface Params$Resource$Projects$Locations$Datascans$Get extends StandardParameters { /** - * Required. The resource name of the DataTaxonomy: projects/{project_number\}/locations/{location_id\}/dataTaxonomies/{data_taxonomy_id\} + * Required. The resource name of the dataScan: projects/{project\}/locations/{location_id\}/dataScans/{data_scan_id\} where project refers to a project_id or project_number and location_id refers to a GCP region. */ name?: string; + /** + * Optional. Select the DataScan view to return. Defaults to BASIC. + */ + view?: string; } - export interface Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy + export interface Params$Resource$Projects$Locations$Datascans$Getiampolicy extends StandardParameters { /** * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). @@ -6946,33 +7281,33 @@ export namespace dataplex_v1 { */ resource?: string; } - export interface Params$Resource$Projects$Locations$Datataxonomies$List + export interface Params$Resource$Projects$Locations$Datascans$List extends StandardParameters { /** * Optional. Filter request. */ filter?: string; /** - * Optional. Order by fields for the result. + * Optional. Order by fields (name or create_time) for the result. If not specified, the ordering is undefined. */ orderBy?: string; /** - * Optional. Maximum number of DataTaxonomies to return. The service may return fewer than this value. If unspecified, at most 10 DataTaxonomies will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of dataScans to return. The service may return fewer than this value. If unspecified, at most 500 scans will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. */ pageSize?: number; /** - * Optional. Page token received from a previous ListDataTaxonomies call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataTaxonomies must match the call that provided the page token. + * Optional. Page token received from a previous ListDataScans call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataScans must match the call that provided the page token. */ pageToken?: string; /** - * Required. The resource name of the DataTaxonomy location, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a GCP region. + * 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 GCP region. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Datataxonomies$Patch + export interface Params$Resource$Projects$Locations$Datascans$Patch extends StandardParameters { /** - * Output only. The relative resource name of the DataTaxonomy, of the form: projects/{project_number\}/locations/{location_id\}/dataTaxonomies/{data_taxonomy_id\}. + * Output only. The relative resource name of the scan, of the form: projects/{project\}/locations/{location_id\}/dataScans/{datascan_id\}, where project refers to a project_id or project_number and location_id refers to a GCP region. */ name?: string; /** @@ -6987,9 +7322,21 @@ export namespace dataplex_v1 { /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDataplexV1DataTaxonomy; + requestBody?: Schema$GoogleCloudDataplexV1DataScan; } - export interface Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy + export interface Params$Resource$Projects$Locations$Datascans$Run + extends StandardParameters { + /** + * Required. The resource name of the DataScan: projects/{project\}/locations/{location_id\}/dataScans/{data_scan_id\}. where project refers to a project_id or project_number and location_id refers to a GCP region.Only OnDemand data scans are allowed. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1RunDataScanRequest; + } + export interface Params$Resource$Projects$Locations$Datascans$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. @@ -7001,7 +7348,7 @@ export namespace dataplex_v1 { */ requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions + export interface Params$Resource$Projects$Locations$Datascans$Testiampermissions extends StandardParameters { /** * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. @@ -7014,72 +7361,72 @@ export namespace dataplex_v1 { requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; } - export class Resource$Projects$Locations$Datataxonomies$Attributes { + export class Resource$Projects$Locations$Datascans$Jobs { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Create a DataAttribute resource. + * Generates recommended DataQualityRule from a data profiling DataScan. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Datataxonomies$Attributes$Create, + generateDataQualityRules( + params: Params$Resource$Projects$Locations$Datascans$Jobs$Generatedataqualityrules, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create, + generateDataQualityRules( + params?: Params$Resource$Projects$Locations$Datascans$Jobs$Generatedataqualityrules, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create, + ): GaxiosPromise; + generateDataQualityRules( + params: Params$Resource$Projects$Locations$Datascans$Jobs$Generatedataqualityrules, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create, + generateDataQualityRules( + params: Params$Resource$Projects$Locations$Datascans$Jobs$Generatedataqualityrules, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create, - callback: BodyResponseCallback + generateDataQualityRules( + params: Params$Resource$Projects$Locations$Datascans$Jobs$Generatedataqualityrules, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + generateDataQualityRules( + callback: BodyResponseCallback ): void; - create( + generateDataQualityRules( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datascans$Jobs$Generatedataqualityrules + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create; + {}) as Params$Resource$Projects$Locations$Datascans$Jobs$Generatedataqualityrules; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create; + {} as Params$Resource$Projects$Locations$Datascans$Jobs$Generatedataqualityrules; options = {}; } @@ -7092,7 +7439,7 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/attributes').replace( + url: (rootUrl + '/v1/{+name}:generateDataQualityRules').replace( /([^:]\/)\/+/g, '$1' ), @@ -7101,80 +7448,81 @@ export namespace dataplex_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a Data Attribute resource. + * Gets a DataScanJob resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Datataxonomies$Attributes$Delete, + get( + params: Params$Resource$Projects$Locations$Datascans$Jobs$Get, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete, + get( + params?: Params$Resource$Projects$Locations$Datascans$Jobs$Get, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datascans$Jobs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete, + get( + params: Params$Resource$Projects$Locations$Datascans$Jobs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datascans$Jobs$Get, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datascans$Jobs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete; + {}) as Params$Resource$Projects$Locations$Datascans$Jobs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete; + params = {} as Params$Resource$Projects$Locations$Datascans$Jobs$Get; options = {}; } @@ -7188,7 +7536,7 @@ export namespace dataplex_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', }, options ), @@ -7198,75 +7546,76 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Retrieves a Data Attribute resource. + * Lists DataScanJobs under the given DataScan. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Datataxonomies$Attributes$Get, + list( + params: Params$Resource$Projects$Locations$Datascans$Jobs$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get, + list( + params?: Params$Resource$Projects$Locations$Datascans$Jobs$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datascans$Jobs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get, + list( + params: Params$Resource$Projects$Locations$Datascans$Jobs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datascans$Jobs$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datascans$Jobs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get; + {}) as Params$Resource$Projects$Locations$Datascans$Jobs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get; + params = {} as Params$Resource$Projects$Locations$Datascans$Jobs$List; options = {}; } @@ -7279,86 +7628,140 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/jobs').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Datascans$Jobs$Generatedataqualityrules + extends StandardParameters { /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Required. The name should be either * the name of a datascan with at least one successful completed data profiling job, or * the name of a successful completed data profiling datascan job. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1GenerateDataQualityRulesRequest; + } + export interface Params$Resource$Projects$Locations$Datascans$Jobs$Get + extends StandardParameters { + /** + * Required. The resource name of the DataScanJob: projects/{project\}/locations/{location_id\}/dataScans/{data_scan_id\}/jobs/{data_scan_job_id\} where project refers to a project_id or project_number and location_id refers to a GCP region. + */ + name?: string; + /** + * Optional. Select the DataScanJob view to return. Defaults to BASIC. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Datascans$Jobs$List + extends StandardParameters { + /** + * Optional. An expression for filtering the results of the ListDataScanJobs request.If unspecified, all datascan jobs will be returned. Multiple filters can be applied (with AND, OR logical operators). Filters are case-sensitive.Allowed fields are: start_time end_timestart_time and end_time expect RFC-3339 formatted strings (e.g. 2018-10-08T18:30:00-07:00).For instance, 'start_time \> 2018-10-08T00:00:00.123456789Z AND end_time < 2018-10-09T00:00:00.123456789Z' limits results to DataScanJobs between specified start and end times. + */ + filter?: string; + /** + * Optional. Maximum number of DataScanJobs to return. The service may return fewer than this value. If unspecified, at most 10 DataScanJobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous ListDataScanJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataScanJobs must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the parent environment: projects/{project\}/locations/{location_id\}/dataScans/{data_scan_id\} where project refers to a project_id or project_number and location_id refers to a GCP region. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Datataxonomies { + context: APIRequestContext; + attributes: Resource$Projects$Locations$Datataxonomies$Attributes; + constructor(context: APIRequestContext) { + this.context = context; + this.attributes = + new Resource$Projects$Locations$Datataxonomies$Attributes(this.context); + } + + /** + * Create a DataTaxonomy resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy, + create( + params: Params$Resource$Projects$Locations$Datataxonomies$Create, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy, + create( + params?: Params$Resource$Projects$Locations$Datataxonomies$Create, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datataxonomies$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datataxonomies$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datataxonomies$Create, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - getIamPolicy( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datataxonomies$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Datataxonomies$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy; + params = {} as Params$Resource$Projects$Locations$Datataxonomies$Create; options = {}; } @@ -7371,89 +7774,88 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/dataTaxonomies').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists Data Attribute resources in a DataTaxonomy. + * Deletes a DataTaxonomy resource. All attributes within the DataTaxonomy must be deleted before the DataTaxonomy can be deleted. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Datataxonomies$Attributes$List, + delete( + params: Params$Resource$Projects$Locations$Datataxonomies$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datataxonomies$Attributes$List, + delete( + params?: Params$Resource$Projects$Locations$Datataxonomies$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datataxonomies$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$List, + delete( + params: Params$Resource$Projects$Locations$Datataxonomies$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datataxonomies$Delete, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - list( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datataxonomies$Attributes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datataxonomies$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datataxonomies$Attributes$List; + {}) as Params$Resource$Projects$Locations$Datataxonomies$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datataxonomies$Attributes$List; + params = {} as Params$Resource$Projects$Locations$Datataxonomies$Delete; options = {}; } @@ -7466,91 +7868,85 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/attributes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a DataAttribute resource. + * Retrieves a DataTaxonomy resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Datataxonomies$Attributes$Patch, + get( + params: Params$Resource$Projects$Locations$Datataxonomies$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch, + get( + params?: Params$Resource$Projects$Locations$Datataxonomies$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datataxonomies$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch, + get( + params: Params$Resource$Projects$Locations$Datataxonomies$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datataxonomies$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datataxonomies$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch; + {}) as Params$Resource$Projects$Locations$Datataxonomies$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch; + params = {} as Params$Resource$Projects$Locations$Datataxonomies$Get; options = {}; } @@ -7564,7 +7960,7 @@ export namespace dataplex_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', }, options ), @@ -7574,51 +7970,53 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy, + getIamPolicy( + params: Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy, options?: MethodOptions ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy, + getIamPolicy( + params: Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy, + getIamPolicy( + params: Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy, + getIamPolicy( + params: Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy, callback: BodyResponseCallback ): void; - setIamPolicy( + getIamPolicy( callback: BodyResponseCallback ): void; - setIamPolicy( + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy + | Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -7634,13 +8032,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy; + {} as Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy; options = {}; } @@ -7653,11 +8051,11 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', }, options ), @@ -7677,65 +8075,64 @@ export namespace dataplex_v1 { } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Lists DataTaxonomy resources in a project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Datataxonomies$List, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions, + list( + params?: Params$Resource$Projects$Locations$Datataxonomies$List, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datataxonomies$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Datataxonomies$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datataxonomies$List, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - testIamPermissions( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datataxonomies$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Datataxonomies$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions; + params = {} as Params$Resource$Projects$Locations$Datataxonomies$List; options = {}; } @@ -7748,213 +8145,2998 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + url: (rootUrl + '/v1/{+parent}/dataTaxonomies').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create - extends StandardParameters { - /** - * Required. DataAttribute 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 DataTaxonomy. - */ - dataAttributeId?: string; - /** - * Required. The resource name of the parent data taxonomy projects/{project_number\}/locations/{location_id\}/dataTaxonomies/{data_taxonomy_id\} - */ - parent?: string; - /** - * Optional. Only validate the request, but do not perform mutations. The default is false. - */ - validateOnly?: boolean; /** - * Request body metadata + * Updates a DataTaxonomy resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Datataxonomies$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Datataxonomies$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datataxonomies$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Datataxonomies$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Datataxonomies$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datataxonomies$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datataxonomies$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datataxonomies$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Datataxonomies$Create + extends StandardParameters { + /** + * Required. DataTaxonomy 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 Project. + */ + dataTaxonomyId?: string; + /** + * Required. The resource name of the data taxonomy location, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a GCP region. + */ + parent?: string; + /** + * Optional. Only validate the request, but do not perform mutations. The default is false. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1DataTaxonomy; + } + export interface Params$Resource$Projects$Locations$Datataxonomies$Delete + extends StandardParameters { + /** + * Optional. If the client provided etag value does not match the current etag value,the DeleteDataTaxonomy method returns an ABORTED error. + */ + etag?: string; + /** + * Required. The resource name of the DataTaxonomy: projects/{project_number\}/locations/{location_id\}/dataTaxonomies/{data_taxonomy_id\} + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datataxonomies$Get + extends StandardParameters { + /** + * Required. The resource name of the DataTaxonomy: projects/{project_number\}/locations/{location_id\}/dataTaxonomies/{data_taxonomy_id\} + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Datataxonomies$List + extends StandardParameters { + /** + * Optional. Filter request. + */ + filter?: string; + /** + * Optional. Order by fields for the result. + */ + orderBy?: string; + /** + * Optional. Maximum number of DataTaxonomies to return. The service may return fewer than this value. If unspecified, at most 10 DataTaxonomies will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous ListDataTaxonomies call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataTaxonomies must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the DataTaxonomy location, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a GCP region. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datataxonomies$Patch + extends StandardParameters { + /** + * Output only. The relative resource name of the DataTaxonomy, of the form: projects/{project_number\}/locations/{location_id\}/dataTaxonomies/{data_taxonomy_id\}. + */ + name?: string; + /** + * Required. Mask of fields to update. + */ + updateMask?: string; + /** + * Optional. Only validate the request, but do not perform mutations. The default is false. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1DataTaxonomy; + } + export interface Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Datataxonomies$Attributes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Create a DataAttribute resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Datataxonomies$Attributes$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create; + 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}/attributes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a Data Attribute resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Datataxonomies$Attributes$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a Data Attribute resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Datataxonomies$Attributes$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists Data Attribute resources in a DataTaxonomy. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Datataxonomies$Attributes$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Datataxonomies$Attributes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datataxonomies$Attributes$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datataxonomies$Attributes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datataxonomies$Attributes$List; + 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}/attributes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates a DataAttribute resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Datataxonomies$Attributes$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create + extends StandardParameters { + /** + * Required. DataAttribute 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 DataTaxonomy. + */ + dataAttributeId?: string; + /** + * Required. The resource name of the parent data taxonomy projects/{project_number\}/locations/{location_id\}/dataTaxonomies/{data_taxonomy_id\} + */ + parent?: string; + /** + * Optional. Only validate the request, but do not perform mutations. The default is false. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1DataAttribute; + } + export interface Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete + extends StandardParameters { + /** + * Optional. If the client provided etag value does not match the current etag value, the DeleteDataAttribute method returns an ABORTED error response. + */ + etag?: string; + /** + * Required. The resource name of the DataAttribute: projects/{project_number\}/locations/{location_id\}/dataTaxonomies/{dataTaxonomy\}/attributes/{data_attribute_id\} + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get + extends StandardParameters { + /** + * Required. The resource name of the dataAttribute: projects/{project_number\}/locations/{location_id\}/dataTaxonomies/{dataTaxonomy\}/attributes/{data_attribute_id\} + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Datataxonomies$Attributes$List + extends StandardParameters { + /** + * Optional. Filter request. + */ + filter?: string; + /** + * Optional. Order by fields for the result. + */ + orderBy?: string; + /** + * Optional. Maximum number of DataAttributes to return. The service may return fewer than this value. If unspecified, at most 10 dataAttributes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous ListDataAttributes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataAttributes must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the DataTaxonomy: projects/{project_number\}/locations/{location_id\}/dataTaxonomies/{data_taxonomy_id\} + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch + extends StandardParameters { + /** + * Output only. The relative resource name of the dataAttribute, of the form: projects/{project_number\}/locations/{location_id\}/dataTaxonomies/{dataTaxonomy\}/attributes/{data_attribute_id\}. + */ + name?: string; + /** + * Required. Mask of fields to update. + */ + updateMask?: string; + /** + * Optional. Only validate the request, but do not perform mutations. The default is false. + */ + validateOnly?: boolean; + + /** + * Request body metadata */ requestBody?: Schema$GoogleCloudDataplexV1DataAttribute; } - export interface Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete + export interface Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Entrygroups { + context: APIRequestContext; + entries: Resource$Projects$Locations$Entrygroups$Entries; + constructor(context: APIRequestContext) { + this.context = context; + this.entries = new Resource$Projects$Locations$Entrygroups$Entries( + this.context + ); + } + + /** + * Creates an EntryGroup + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Entrygroups$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Entrygroups$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Entrygroups$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Entrygroups$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Entrygroups$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Entrygroups$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Entrygroups$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Entrygroups$Create; + 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}/entryGroups').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a EntryGroup resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Entrygroups$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Entrygroups$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Entrygroups$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Entrygroups$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Entrygroups$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Entrygroups$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Entrygroups$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Entrygroups$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a EntryGroup resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Entrygroups$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Entrygroups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Entrygroups$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Entrygroups$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Entrygroups$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Entrygroups$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Entrygroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Entrygroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Entrygroups$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Entrygroups$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Entrygroups$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Entrygroups$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Entrygroups$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Entrygroups$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Entrygroups$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Entrygroups$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists EntryGroup resources in a project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Entrygroups$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Entrygroups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Entrygroups$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Entrygroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Entrygroups$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Entrygroups$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Entrygroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Entrygroups$List; + 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}/entryGroups').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates a EntryGroup resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Entrygroups$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Entrygroups$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Entrygroups$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Entrygroups$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Entrygroups$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Entrygroups$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Entrygroups$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Entrygroups$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Entrygroups$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Entrygroups$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Entrygroups$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Entrygroups$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Entrygroups$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Entrygroups$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Entrygroups$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Entrygroups$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Entrygroups$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Entrygroups$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Entrygroups$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Entrygroups$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Entrygroups$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Entrygroups$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Entrygroups$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Entrygroups$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Entrygroups$Create + extends StandardParameters { + /** + * Required. EntryGroup identifier. + */ + entryGroupId?: string; + /** + * Required. The resource name of the entryGroup, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a GCP region. + */ + parent?: string; + /** + * Optional. Only validate the request, but do not perform mutations. The default is false. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1EntryGroup; + } + export interface Params$Resource$Projects$Locations$Entrygroups$Delete + extends StandardParameters { + /** + * Optional. If the client provided etag value does not match the current etag value, the DeleteEntryGroupRequest method returns an ABORTED error response + */ + etag?: string; + /** + * Required. The resource name of the EntryGroup: projects/{project_number\}/locations/{location_id\}/entryGroups/{entry_group_id\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Entrygroups$Get + extends StandardParameters { + /** + * Required. The resource name of the EntryGroup: projects/{project_number\}/locations/{location_id\}/entryGroups/{entry_group_id\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Entrygroups$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Entrygroups$List + extends StandardParameters { + /** + * Optional. Filter request. + */ + filter?: string; + /** + * Optional. Order by fields for the result. + */ + orderBy?: string; + /** + * Optional. Maximum number of EntryGroups to return. The service may return fewer than this value. If unspecified, at most 10 EntryGroups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous ListEntryGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEntryGroups must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the entryGroup location, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a GCP region. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Entrygroups$Patch + extends StandardParameters { + /** + * Output only. The relative resource name of the EntryGroup, of the form: projects/{project_number\}/locations/{location_id\}/entryGroups/{entry_group_id\}. + */ + name?: string; + /** + * Required. Mask of fields to update. + */ + updateMask?: string; + /** + * Optional. Only validate the request, but do not perform mutations. The default is false. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1EntryGroup; + } + export interface Params$Resource$Projects$Locations$Entrygroups$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Entrygroups$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Entrygroups$Entries { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates an Entry. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Entrygroups$Entries$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Entrygroups$Entries$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Entrygroups$Entries$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Entrygroups$Entries$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Entrygroups$Entries$Create; + 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}/entries').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes an Entry. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Entrygroups$Entries$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Entrygroups$Entries$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Entrygroups$Entries$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Entrygroups$Entries$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Entrygroups$Entries$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a single entry. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Entrygroups$Entries$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Entrygroups$Entries$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Entrygroups$Entries$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Entrygroups$Entries$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Entrygroups$Entries$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists entries within an entry group. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Entrygroups$Entries$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Entrygroups$Entries$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Entrygroups$Entries$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Entrygroups$Entries$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Entrygroups$Entries$List; + 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}/entries').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an Entry. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Entrygroups$Entries$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Entrygroups$Entries$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Entrygroups$Entries$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Entrygroups$Entries$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Entrygroups$Entries$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + 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$Entrygroups$Entries$Create extends StandardParameters { /** - * Optional. If the client provided etag value does not match the current etag value, the DeleteDataAttribute method returns an ABORTED error response. + * Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use 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 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 other providers or systems than Google Cloud.The maximum size of the field is 4000 characters. */ - etag?: string; + entryId?: string; + /** + * Required. The resource name of the parent Entry Group: projects/{project\}/locations/{location\}/entryGroups/{entry_group\}. + */ + parent?: string; + /** - * Required. The resource name of the DataAttribute: projects/{project_number\}/locations/{location_id\}/dataTaxonomies/{dataTaxonomy\}/attributes/{data_attribute_id\} + * Request body metadata */ - name?: string; + requestBody?: Schema$GoogleCloudDataplexV1Entry; } - export interface Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get + export interface Params$Resource$Projects$Locations$Entrygroups$Entries$Delete extends StandardParameters { /** - * Required. The resource name of the dataAttribute: projects/{project_number\}/locations/{location_id\}/dataTaxonomies/{dataTaxonomy\}/attributes/{data_attribute_id\} + * Required. The resource name of the Entry: projects/{project\}/locations/{location\}/entryGroups/{entry_group\}/entries/{entry\}. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy + export interface Params$Resource$Projects$Locations$Entrygroups$Entries$Get extends StandardParameters { /** - * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). + * Optional. Limits the aspects returned to the provided aspect types. Only works if the CUSTOM view is selected. */ - 'options.requestedPolicyVersion'?: number; + aspectTypes?: string[]; /** - * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * Required. The resource name of the Entry: projects/{project\}/locations/{location\}/entryGroups/{entry_group\}/entries/{entry\}. */ - resource?: string; + name?: string; + /** + * Optional. Limits the aspects returned to those associated with the provided paths within the Entry. Only works if the CUSTOM view is selected. + */ + paths?: string[]; + /** + * Optional. View for controlling which parts of an entry are to be returned. + */ + view?: string; } - export interface Params$Resource$Projects$Locations$Datataxonomies$Attributes$List + export interface Params$Resource$Projects$Locations$Entrygroups$Entries$List extends StandardParameters { /** - * Optional. Filter request. + * Optional. A filter on the entries to return. Filters are case-sensitive. The request can be filtered by the following fields: entry_type, display_name. The comparison operators are =, !=, <, \>, <=, \>= (strings are compared according to lexical order) The logical operators AND, OR, NOT can be used in the filter. Example filter expressions: "display_name=AnExampleDisplayName" "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type" "entry_type=projects/a* OR "entry_type=projects/k*" "NOT display_name=AnotherExampleDisplayName" */ filter?: string; /** - * Optional. Order by fields for the result. - */ - orderBy?: string; - /** - * Optional. Maximum number of DataAttributes to return. The service may return fewer than this value. If unspecified, at most 10 dataAttributes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * */ pageSize?: number; /** - * Optional. Page token received from a previous ListDataAttributes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataAttributes must match the call that provided the page token. + * Optional. The pagination token returned by a previous request. */ pageToken?: string; /** - * Required. The resource name of the DataTaxonomy: projects/{project_number\}/locations/{location_id\}/dataTaxonomies/{data_taxonomy_id\} + * Required. The resource name of the parent Entry Group: projects/{project\}/locations/{location\}/entryGroups/{entry_group\}. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch + export interface Params$Resource$Projects$Locations$Entrygroups$Entries$Patch extends StandardParameters { /** - * Output only. The relative resource name of the dataAttribute, of the form: projects/{project_number\}/locations/{location_id\}/dataTaxonomies/{dataTaxonomy\}/attributes/{data_attribute_id\}. + * Optional. If set to true and the entry does not exist, it will be created. */ - name?: string; + allowMissing?: boolean; /** - * Required. Mask of fields to update. + * Optional. The map keys of the Aspects which should be modified. Supports the following syntaxes: * - matches aspect on given type and empty path * @path - matches aspect on given type and specified path * * - matches aspects on given type for all paths * *@path - matches aspects of all types on the given pathExisting aspects matching the syntax will not be removed unless delete_missing_aspects is set to true.If this field is left empty, it will be treated as specifying exactly those Aspects present in the request. */ - updateMask?: string; + aspectKeys?: string[]; /** - * Optional. Only validate the request, but do not perform mutations. The default is false. + * Optional. If set to true and the aspect_keys specify aspect ranges, any existing aspects from that range not provided in the request will be deleted. */ - validateOnly?: boolean; - + deleteMissingAspects?: boolean; /** - * Request body metadata + * Identifier. The relative resource name of the Entry, of the form: projects/{project\}/locations/{location\}/entryGroups/{entry_group\}/entries/{entry\}. */ - requestBody?: Schema$GoogleCloudDataplexV1DataAttribute; - } - export interface Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy - extends StandardParameters { + name?: string; /** - * 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. + * Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".If the update_mask is empty, all modifiable fields present in the request will be updated. */ - resource?: string; + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + requestBody?: Schema$GoogleCloudDataplexV1Entry; } - export interface Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions - extends StandardParameters { + + export class Resource$Projects$Locations$Entrytypes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + /** - * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * Creates an EntryType + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - resource?: string; + create( + params: Params$Resource$Projects$Locations$Entrytypes$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Entrytypes$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Entrytypes$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Entrytypes$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Entrytypes$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Entrytypes$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Entrytypes$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Entrytypes$Create; + 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}/entryTypes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } /** - * Request body metadata + * Deletes a EntryType resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; - } + delete( + params: Params$Resource$Projects$Locations$Entrytypes$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Entrytypes$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Entrytypes$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Entrytypes$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Entrytypes$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Entrytypes$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Entrytypes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; - export class Resource$Projects$Locations$Entrygroups { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Entrytypes$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Retrieves a EntryType resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Entrygroups$Getiampolicy, + get( + params: Params$Resource$Projects$Locations$Entrytypes$Get, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Entrygroups$Getiampolicy, + get( + params?: Params$Resource$Projects$Locations$Entrytypes$Get, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Entrygroups$Getiampolicy, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Entrytypes$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Entrygroups$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Entrytypes$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Entrygroups$Getiampolicy, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Entrytypes$Get, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - getIamPolicy( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Entrygroups$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Entrytypes$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Entrygroups$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Entrytypes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Entrygroups$Getiampolicy; + params = {} as Params$Resource$Projects$Locations$Entrytypes$Get; options = {}; } @@ -7967,65 +11149,64 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Entrygroups$Setiampolicy, + getIamPolicy( + params: Params$Resource$Projects$Locations$Entrytypes$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Entrygroups$Setiampolicy, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Entrytypes$Getiampolicy, options?: MethodOptions ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Entrygroups$Setiampolicy, + getIamPolicy( + params: Params$Resource$Projects$Locations$Entrytypes$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Entrygroups$Setiampolicy, + getIamPolicy( + params: Params$Resource$Projects$Locations$Entrytypes$Getiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Entrygroups$Setiampolicy, + getIamPolicy( + params: Params$Resource$Projects$Locations$Entrytypes$Getiampolicy, callback: BodyResponseCallback ): void; - setIamPolicy( + getIamPolicy( callback: BodyResponseCallback ): void; - setIamPolicy( + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Entrygroups$Setiampolicy + | Params$Resource$Projects$Locations$Entrytypes$Getiampolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -8041,13 +11222,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Entrygroups$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Entrytypes$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Entrygroups$Setiampolicy; + {} as Params$Resource$Projects$Locations$Entrytypes$Getiampolicy; options = {}; } @@ -8060,11 +11241,11 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', }, options ), @@ -8084,65 +11265,64 @@ export namespace dataplex_v1 { } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Lists EntryType resources in a project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Entrygroups$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Entrytypes$List, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Entrygroups$Testiampermissions, + list( + params?: Params$Resource$Projects$Locations$Entrytypes$List, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Entrygroups$Testiampermissions, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Entrytypes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Entrygroups$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Entrytypes$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Entrygroups$Testiampermissions, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Entrytypes$List, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - testIamPermissions( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Entrygroups$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Entrytypes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Entrygroups$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Entrytypes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Entrygroups$Testiampermissions; + params = {} as Params$Resource$Projects$Locations$Entrytypes$List; options = {}; } @@ -8155,132 +11335,90 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + url: (rootUrl + '/v1/{+parent}/entryTypes').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Entrygroups$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Entrygroups$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Entrygroups$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Entrytypes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Updates a EntryType resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Entrytypes$Getiampolicy, + patch( + params: Params$Resource$Projects$Locations$Entrytypes$Patch, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Entrytypes$Getiampolicy, + patch( + params?: Params$Resource$Projects$Locations$Entrytypes$Patch, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Entrytypes$Getiampolicy, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Entrytypes$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Entrytypes$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Entrytypes$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Entrytypes$Getiampolicy, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Entrytypes$Patch, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - getIamPolicy( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Entrytypes$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Entrytypes$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Entrytypes$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Entrytypes$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Entrytypes$Getiampolicy; + params = {} as Params$Resource$Projects$Locations$Entrytypes$Patch; options = {}; } @@ -8293,26 +11431,23 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } @@ -8507,6 +11642,44 @@ export namespace dataplex_v1 { } } + export interface Params$Resource$Projects$Locations$Entrytypes$Create + extends StandardParameters { + /** + * Required. EntryType identifier. + */ + entryTypeId?: string; + /** + * Required. The resource name of the EntryType, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a GCP region. + */ + parent?: string; + /** + * Optional. Only validate the request, but do not perform mutations. The default is false. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1EntryType; + } + export interface Params$Resource$Projects$Locations$Entrytypes$Delete + extends StandardParameters { + /** + * Optional. If the client provided etag value does not match the current etag value, the DeleteEntryTypeRequest method returns an ABORTED error response + */ + etag?: string; + /** + * Required. The resource name of the EntryType: projects/{project_number\}/locations/{location_id\}/entryTypes/{entry_type_id\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Entrytypes$Get + extends StandardParameters { + /** + * Required. The resource name of the EntryType: projects/{project_number\}/locations/{location_id\}/entryTypes/{entry_type_id\}. + */ + name?: string; + } export interface Params$Resource$Projects$Locations$Entrytypes$Getiampolicy extends StandardParameters { /** @@ -8518,6 +11691,49 @@ export namespace dataplex_v1 { */ resource?: string; } + export interface Params$Resource$Projects$Locations$Entrytypes$List + extends StandardParameters { + /** + * Optional. Filter request. Filters are case-sensitive. The following formats are supported:labels.key1 = "value1" labels:key1 name = "value" These restrictions can be coinjoined with AND, OR and NOT conjunctions. + */ + filter?: string; + /** + * Optional. Order by fields (name or create_time) for the result. If not specified, the ordering is undefined. + */ + orderBy?: string; + /** + * Optional. Maximum number of EntryTypes to return. The service may return fewer than this value. If unspecified, at most 10 EntryTypes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous ListEntryTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEntryTypes must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the EntryType location, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a GCP region. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Entrytypes$Patch + extends StandardParameters { + /** + * Output only. The relative resource name of the EntryType, of the form: projects/{project_number\}/locations/{location_id\}/entryTypes/{entry_type_id\}. + */ + name?: string; + /** + * Required. Mask of fields to update. + */ + updateMask?: string; + /** + * Optional. Only validate the request, but do not perform mutations. The default is false. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1EntryType; + } export interface Params$Resource$Projects$Locations$Entrytypes$Setiampolicy extends StandardParameters { /** diff --git a/src/apis/dataproc/v1.ts b/src/apis/dataproc/v1.ts index f845d41348..7f220b9043 100644 --- a/src/apis/dataproc/v1.ts +++ b/src/apis/dataproc/v1.ts @@ -137,6 +137,15 @@ export namespace dataproc_v1 { */ acceleratorTypeUri?: string | null; } + /** + * A request to analyze a batch workload. + */ + export interface Schema$AnalyzeBatchRequest { + /** + * Optional. A unique ID used to identify the request. If the service receives two AnalyzeBatchRequest (http://cloud/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.AnalyzeBatchRequest)s with the same request_id, the second request is ignored and the Operation that corresponds to the first request created and stored in the backend is returned.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. + */ + requestId?: string | null; + } /** * Metadata describing the Analyze operation. */ @@ -4046,6 +4055,93 @@ export namespace dataproc_v1 { this.context = context; } + /** + * Analyze a Batch for possible recommendations and insights. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + analyze( + params: Params$Resource$Projects$Locations$Batches$Analyze, + options: StreamMethodOptions + ): GaxiosPromise; + analyze( + params?: Params$Resource$Projects$Locations$Batches$Analyze, + options?: MethodOptions + ): GaxiosPromise; + analyze( + params: Params$Resource$Projects$Locations$Batches$Analyze, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + analyze( + params: Params$Resource$Projects$Locations$Batches$Analyze, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + analyze( + params: Params$Resource$Projects$Locations$Batches$Analyze, + callback: BodyResponseCallback + ): void; + analyze(callback: BodyResponseCallback): void; + analyze( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Batches$Analyze + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Batches$Analyze; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Batches$Analyze; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:analyze').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Creates a batch workload that executes asynchronously. * @@ -4392,6 +4488,18 @@ export namespace dataproc_v1 { } } + export interface Params$Resource$Projects$Locations$Batches$Analyze + extends StandardParameters { + /** + * Required. The fully qualified name of the batch to analyze in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID" + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AnalyzeBatchRequest; + } export interface Params$Resource$Projects$Locations$Batches$Create extends StandardParameters { /** diff --git a/src/apis/datastore/v1.ts b/src/apis/datastore/v1.ts index f6ef2f4d09..d4c82ee885 100644 --- a/src/apis/datastore/v1.ts +++ b/src/apis/datastore/v1.ts @@ -352,6 +352,49 @@ export namespace datastore_v1 { */ version?: string | null; } + /** + * Execution statistics for the query. + */ + export interface Schema$ExecutionStats { + /** + * Debugging statistics from the execution of the query. Note that the debugging stats are subject to change as Firestore evolves. It could include: { "indexes_entries_scanned": "1000", "documents_scanned": "20", "billing_details" : { "documents_billable": "20", "index_entries_billable": "1000", "min_query_cost": "0" \} \} + */ + debugStats?: {[key: string]: any} | null; + /** + * Total time to execute the query in the backend. + */ + executionDuration?: string | null; + /** + * Total billable read operations. + */ + readOperations?: string | null; + /** + * Total number of results returned, including documents, projections, aggregation results, keys. + */ + resultsReturned?: string | null; + } + /** + * Explain metrics for the query. + */ + export interface Schema$ExplainMetrics { + /** + * Aggregated stats from the execution of the query. Only present when ExplainOptions.analyze is set to true. + */ + executionStats?: Schema$ExecutionStats; + /** + * Planning phase information for the query. + */ + planSummary?: Schema$PlanSummary; + } + /** + * Explain options for the query. + */ + export interface Schema$ExplainOptions { + /** + * Optional. Whether to execute this query. When false (the default), the query will be planned, returning only metrics from the planning stages. When true, the query will be planned and executed, returning the full query results along with both planning and execution stage metrics. + */ + analyze?: boolean | null; + } /** * A holder for any type of filter. */ @@ -867,6 +910,10 @@ export namespace datastore_v1 { * Required. Keys of entities to look up. */ keys?: Schema$Key[]; + /** + * The properties to return. Defaults to returning all properties. If this field is set and an entity has a property not referenced in the mask, it will be absent from LookupResponse.found.entity.properties. The entity's key is always returned. + */ + propertyMask?: Schema$PropertyMask; /** * The options for this lookup request. */ @@ -913,6 +960,10 @@ export namespace datastore_v1 { * The entity to insert. The entity must not already exist. The entity key's final path element may be incomplete. */ insert?: Schema$Entity; + /** + * The properties to write in this mutation. None of the properties in the mask may have a reserved name, except for `__key__`. This field is ignored for `delete`. If the entity already exists, only properties referenced in the mask are updated, others are left untouched. Properties referenced in the mask but not in the entity are deleted. + */ + propertyMask?: Schema$PropertyMask; /** * The entity to update. The entity must already exist. Must have a complete key path. */ @@ -985,6 +1036,15 @@ export namespace datastore_v1 { */ name?: string | null; } + /** + * Planning phase information for the query. + */ + export interface Schema$PlanSummary { + /** + * The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, __name__ ASC)"\}, {"query_scope": "Collection", "properties": "(bar ASC, __name__ ASC)"\} ] + */ + indexesUsed?: Array<{[key: string]: any}> | null; + } /** * A representation of a property in a projection. */ @@ -1011,6 +1071,15 @@ export namespace datastore_v1 { */ value?: Schema$Value; } + /** + * The set of arbitrarily nested property paths used to restrict an operation to only a subset of properties in an entity. + */ + export interface Schema$PropertyMask { + /** + * The paths to the properties covered by this mask. A path is a list of property names separated by dots (`.`), for example `foo.bar` means the property `bar` inside the entity property `foo` inside the entity associated with this path. If a property name contains a dot `.` or a backslash `\`, then that name must be escaped. A path must not be empty, and may not reference a value inside an array value. + */ + paths?: string[] | null; + } /** * The desired order for a specific property. */ @@ -1196,6 +1265,10 @@ export namespace datastore_v1 { * The ID of the database against which to make the request. '(default)' is not allowed; please use empty string '' to refer the default database. */ databaseId?: string | null; + /** + * Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned. + */ + explainOptions?: Schema$ExplainOptions; /** * The GQL query to run. This query must be an aggregation query. */ @@ -1217,6 +1290,10 @@ export namespace datastore_v1 { * A batch of aggregation results. Always present. */ batch?: Schema$AggregationResultBatch; + /** + * Query explain metrics. This is only present when the RunAggregationQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream. + */ + explainMetrics?: Schema$ExplainMetrics; /** * The parsed form of the `GqlQuery` from the request, if it was set. */ @@ -1234,6 +1311,10 @@ export namespace datastore_v1 { * The ID of the database against which to make the request. '(default)' is not allowed; please use empty string '' to refer the default database. */ databaseId?: string | null; + /** + * Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned. + */ + explainOptions?: Schema$ExplainOptions; /** * The GQL query to run. This query must be a non-aggregation query. */ @@ -1242,6 +1323,10 @@ export namespace datastore_v1 { * Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID. */ partitionId?: Schema$PartitionId; + /** + * The properties to return. This field must not be set for a projection query. See LookupRequest.property_mask. + */ + propertyMask?: Schema$PropertyMask; /** * The query to run. */ @@ -1259,6 +1344,10 @@ export namespace datastore_v1 { * A batch of query results (always present). */ batch?: Schema$QueryResultBatch; + /** + * Query explain metrics. This is only present when the RunQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream. + */ + explainMetrics?: Schema$ExplainMetrics; /** * The parsed form of the `GqlQuery` from the request, if it was set. */ diff --git a/src/apis/datastore/v1beta3.ts b/src/apis/datastore/v1beta3.ts index 5d17bf3e5a..cef58b390b 100644 --- a/src/apis/datastore/v1beta3.ts +++ b/src/apis/datastore/v1beta3.ts @@ -332,6 +332,49 @@ export namespace datastore_v1beta3 { */ version?: string | null; } + /** + * Execution statistics for the query. + */ + export interface Schema$ExecutionStats { + /** + * Debugging statistics from the execution of the query. Note that the debugging stats are subject to change as Firestore evolves. It could include: { "indexes_entries_scanned": "1000", "documents_scanned": "20", "billing_details" : { "documents_billable": "20", "index_entries_billable": "1000", "min_query_cost": "0" \} \} + */ + debugStats?: {[key: string]: any} | null; + /** + * Total time to execute the query in the backend. + */ + executionDuration?: string | null; + /** + * Total billable read operations. + */ + readOperations?: string | null; + /** + * Total number of results returned, including documents, projections, aggregation results, keys. + */ + resultsReturned?: string | null; + } + /** + * Explain metrics for the query. + */ + export interface Schema$ExplainMetrics { + /** + * Aggregated stats from the execution of the query. Only present when ExplainOptions.analyze is set to true. + */ + executionStats?: Schema$ExecutionStats; + /** + * Planning phase information for the query. + */ + planSummary?: Schema$PlanSummary; + } + /** + * Explain options for the query. + */ + export interface Schema$ExplainOptions { + /** + * Optional. Whether to execute this query. When false (the default), the query will be planned, returning only metrics from the planning stages. When true, the query will be planned and executed, returning the full query results along with both planning and execution stage metrics. + */ + analyze?: boolean | null; + } /** * A holder for any type of filter. */ @@ -716,6 +759,10 @@ export namespace datastore_v1beta3 { * Required. Keys of entities to look up. */ keys?: Schema$Key[]; + /** + * The properties to return. Defaults to returning all properties. If this field is set and an entity has a property not referenced in the mask, it will be absent from LookupResponse.found.entity.properties. The entity's key is always returned. + */ + propertyMask?: Schema$PropertyMask; /** * The options for this lookup request. */ @@ -758,6 +805,10 @@ export namespace datastore_v1beta3 { * The entity to insert. The entity must not already exist. The entity key's final path element may be incomplete. */ insert?: Schema$Entity; + /** + * The properties to write in this mutation. None of the properties in the mask may have a reserved name, except for `__key__`. This field is ignored for `delete`. If the entity already exists, only properties referenced in the mask are updated, others are left untouched. Properties referenced in the mask but not in the entity are deleted. + */ + propertyMask?: Schema$PropertyMask; /** * The entity to update. The entity must already exist. Must have a complete key path. */ @@ -826,6 +877,15 @@ export namespace datastore_v1beta3 { */ name?: string | null; } + /** + * Planning phase information for the query. + */ + export interface Schema$PlanSummary { + /** + * The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, __name__ ASC)"\}, {"query_scope": "Collection", "properties": "(bar ASC, __name__ ASC)"\} ] + */ + indexesUsed?: Array<{[key: string]: any}> | null; + } /** * A representation of a property in a projection. */ @@ -852,6 +912,15 @@ export namespace datastore_v1beta3 { */ value?: Schema$Value; } + /** + * The set of arbitrarily nested property paths used to restrict an operation to only a subset of properties in an entity. + */ + export interface Schema$PropertyMask { + /** + * The paths to the properties covered by this mask. A path is a list of property names separated by dots (`.`), for example `foo.bar` means the property `bar` inside the entity property `foo` inside the entity associated with this path. If a property name contains a dot `.` or a backslash `\`, then that name must be escaped. A path must not be empty, and may not reference a value inside an array value. + */ + paths?: string[] | null; + } /** * The desired order for a specific property. */ @@ -1025,6 +1094,10 @@ export namespace datastore_v1beta3 { * The query to run. */ aggregationQuery?: Schema$AggregationQuery; + /** + * Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned. + */ + explainOptions?: Schema$ExplainOptions; /** * The GQL query to run. This query must be an aggregation query. */ @@ -1046,6 +1119,10 @@ export namespace datastore_v1beta3 { * A batch of aggregation results. Always present. */ batch?: Schema$AggregationResultBatch; + /** + * Query explain metrics. This is only present when the RunAggregationQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream. + */ + explainMetrics?: Schema$ExplainMetrics; /** * The parsed form of the `GqlQuery` from the request, if it was set. */ @@ -1055,6 +1132,10 @@ export namespace datastore_v1beta3 { * The request for Datastore.RunQuery. */ export interface Schema$RunQueryRequest { + /** + * Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned. + */ + explainOptions?: Schema$ExplainOptions; /** * The GQL query to run. This query must be a non-aggregation query. */ @@ -1063,6 +1144,10 @@ export namespace datastore_v1beta3 { * Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID. */ partitionId?: Schema$PartitionId; + /** + * The properties to return. This field must not be set for a projection query. See LookupRequest.property_mask. + */ + propertyMask?: Schema$PropertyMask; /** * The query to run. */ @@ -1080,6 +1165,10 @@ export namespace datastore_v1beta3 { * A batch of query results (always present). */ batch?: Schema$QueryResultBatch; + /** + * Query explain metrics. This is only present when the RunQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream. + */ + explainMetrics?: Schema$ExplainMetrics; /** * The parsed form of the `GqlQuery` from the request, if it was set. */ diff --git a/src/apis/discoveryengine/v1alpha.ts b/src/apis/discoveryengine/v1alpha.ts index b2100c7552..7cb58c4f8e 100644 --- a/src/apis/discoveryengine/v1alpha.ts +++ b/src/apis/discoveryengine/v1alpha.ts @@ -1785,6 +1785,19 @@ export namespace discoveryengine_v1alpha { */ userId?: string | null; } + /** + * Document captures all raw metadata information of items to be recommended or searched. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaProcessedDocument { + /** + * Required. Full resource name of the referenced document, in the format `projects/x/locations/x/collections/x/dataStores/x/branches/x/documents/x`. + */ + document?: string | null; + /** + * The JSON string representation of the processed document. + */ + jsonData?: string | null; + } /** * Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -2269,7 +2282,7 @@ export namespace discoveryengine_v1alpha { */ export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec { /** - * Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. + * Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied. */ boost?: number | null; /** @@ -2372,6 +2385,10 @@ export namespace discoveryengine_v1alpha { * The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results can be used to generate a summary. */ summaryResultCount?: number | null; + /** + * If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Please note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list. + */ + useSemanticChunks?: boolean | null; } /** * Specification of the prompt to use with the model. @@ -7467,6 +7484,104 @@ export namespace discoveryengine_v1alpha { } } + /** + * Gets the parsed layout information for a Document. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getProcessedDocument( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, + options: StreamMethodOptions + ): GaxiosPromise; + getProcessedDocument( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, + options?: MethodOptions + ): GaxiosPromise; + getProcessedDocument( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getProcessedDocument( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getProcessedDocument( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, + callback: BodyResponseCallback + ): void; + getProcessedDocument( + callback: BodyResponseCallback + ): void; + getProcessedDocument( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:getProcessedDocument').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated. * @@ -7883,6 +7998,21 @@ export namespace discoveryengine_v1alpha { */ name?: string; } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument + extends StandardParameters { + /** + * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + /** + * What format output should be. If unspecified, defaults to JSON. + */ + processedDocumentFormat?: string; + /** + * Required. What type of processing to return. + */ + processedDocumentType?: string; + } export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import extends StandardParameters { /** @@ -17050,6 +17180,104 @@ export namespace discoveryengine_v1alpha { } } + /** + * Gets the parsed layout information for a Document. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getProcessedDocument( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, + options: StreamMethodOptions + ): GaxiosPromise; + getProcessedDocument( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, + options?: MethodOptions + ): GaxiosPromise; + getProcessedDocument( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getProcessedDocument( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getProcessedDocument( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, + callback: BodyResponseCallback + ): void; + getProcessedDocument( + callback: BodyResponseCallback + ): void; + getProcessedDocument( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:getProcessedDocument').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated. * @@ -17466,6 +17694,21 @@ export namespace discoveryengine_v1alpha { */ name?: string; } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument + extends StandardParameters { + /** + * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + /** + * What format output should be. If unspecified, defaults to JSON. + */ + processedDocumentFormat?: string; + /** + * Required. What type of processing to return. + */ + processedDocumentType?: string; + } export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import extends StandardParameters { /** diff --git a/src/apis/discoveryengine/v1beta.ts b/src/apis/discoveryengine/v1beta.ts index bdcb96db77..840291e4bd 100644 --- a/src/apis/discoveryengine/v1beta.ts +++ b/src/apis/discoveryengine/v1beta.ts @@ -2726,7 +2726,7 @@ export namespace discoveryengine_v1beta { */ export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec { /** - * Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. + * Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied. */ boost?: number | null; /** @@ -2825,6 +2825,10 @@ export namespace discoveryengine_v1beta { * The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results can be used to generate a summary. */ summaryResultCount?: number | null; + /** + * If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Please note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list. + */ + useSemanticChunks?: boolean | null; } /** * Specification of the prompt to use with the model. diff --git a/src/apis/displayvideo/v2.ts b/src/apis/displayvideo/v2.ts index c77443580c..ceebb347b9 100644 --- a/src/apis/displayvideo/v2.ts +++ b/src/apis/displayvideo/v2.ts @@ -24329,7 +24329,7 @@ export namespace displayvideo_v2 { } export interface Params$Resource$Users$List extends StandardParameters { /** - * Allows filtering by user fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * The `budget.budget_segments.date_range.end_date` field must use the `LESS THAN (<)` operator. * The `displayName and `email` field must use the `HAS (:)` operator. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `assignedUserRole.advertiserId` * `assignedUserRole.entityType` * This is synthetic field of `AssignedUserRole` used for filtering. Identifies the type of entity to which the user role is assigned. Valid values are `Partner` and `Advertiser`. * `assignedUserRole.parentPartnerId` * This is a synthetic field of `AssignedUserRole` used for filtering. Identifies the parent partner of the entity to which the user role is assigned. * `assignedUserRole.partnerId` * `assignedUserRole.userRole` * `displayName` * `email` Examples: * The user with `displayName` containing "foo": `displayName:"foo"` * The user with `email` containing "bar": `email:"bar"` * All users with standard user roles: `assignedUserRole.userRole="STANDARD"` * All users with user roles for partner 123: `assignedUserRole.partnerId="123"` * All users with user roles for advertiser 123: `assignedUserRole.advertiserId="123"` * All users with partner level user roles: `entityType="PARTNER"` * All users with user roles for partner 123 and advertisers under partner 123: `parentPartnerId="123"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + * Allows filtering by user fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * The `displayName` and `email` fields must use the `HAS (:)` operator. * The `lastLoginTime` field must use either the `LESS THAN OR EQUAL TO (<=)` or `GREATER THAN OR EQUAL TO (\>=)` operator. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `assignedUserRole.advertiserId` * `assignedUserRole.entityType`: This is synthetic field of `AssignedUserRole` used for filtering. Identifies the type of entity to which the user role is assigned. Valid values are `Partner` and `Advertiser`. * `assignedUserRole.parentPartnerId`: This is a synthetic field of `AssignedUserRole` used for filtering. Identifies the parent partner of the entity to which the user role is assigned. * `assignedUserRole.partnerId` * `assignedUserRole.userRole` * `displayName` * `email` * `lastLoginTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * The user with `displayName` containing "foo": `displayName:"foo"` * The user with `email` containing "bar": `email:"bar"` * All users with standard user roles: `assignedUserRole.userRole="STANDARD"` * All users with user roles for partner 123: `assignedUserRole.partnerId="123"` * All users with user roles for advertiser 123: `assignedUserRole.advertiserId="123"` * All users with partner level user roles: `entityType="PARTNER"` * All users with user roles for partner 123 and advertisers under partner 123: `parentPartnerId="123"` * All users that last logged in on or after 2023-01-01T00:00:00Z (format of ISO 8601): `lastLoginTime\>="2023-01-01T00:00:00Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. */ filter?: string; /** diff --git a/src/apis/displayvideo/v3.ts b/src/apis/displayvideo/v3.ts index f6d47955e2..c1911740d6 100644 --- a/src/apis/displayvideo/v3.ts +++ b/src/apis/displayvideo/v3.ts @@ -24353,7 +24353,7 @@ export namespace displayvideo_v3 { } export interface Params$Resource$Users$List extends StandardParameters { /** - * Allows filtering by user fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * The `budget.budget_segments.date_range.end_date` field must use the `LESS THAN (<)` operator. * The `displayName and `email` field must use the `HAS (:)` operator. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `assignedUserRole.advertiserId` * `assignedUserRole.entityType` * This is synthetic field of `AssignedUserRole` used for filtering. Identifies the type of entity to which the user role is assigned. Valid values are `Partner` and `Advertiser`. * `assignedUserRole.parentPartnerId` * This is a synthetic field of `AssignedUserRole` used for filtering. Identifies the parent partner of the entity to which the user role is assigned. * `assignedUserRole.partnerId` * `assignedUserRole.userRole` * `displayName` * `email` Examples: * The user with `displayName` containing "foo": `displayName:"foo"` * The user with `email` containing "bar": `email:"bar"` * All users with standard user roles: `assignedUserRole.userRole="STANDARD"` * All users with user roles for partner 123: `assignedUserRole.partnerId="123"` * All users with user roles for advertiser 123: `assignedUserRole.advertiserId="123"` * All users with partner level user roles: `entityType="PARTNER"` * All users with user roles for partner 123 and advertisers under partner 123: `parentPartnerId="123"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + * Allows filtering by user fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * The `displayName` and `email` fields must use the `HAS (:)` operator. * The `lastLoginTime` field must use either the `LESS THAN OR EQUAL TO (<=)` or `GREATER THAN OR EQUAL TO (\>=)` operator. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `assignedUserRole.advertiserId` * `assignedUserRole.entityType`: This is synthetic field of `AssignedUserRole` used for filtering. Identifies the type of entity to which the user role is assigned. Valid values are `Partner` and `Advertiser`. * `assignedUserRole.parentPartnerId`: This is a synthetic field of `AssignedUserRole` used for filtering. Identifies the parent partner of the entity to which the user role is assigned. * `assignedUserRole.partnerId` * `assignedUserRole.userRole` * `displayName` * `email` * `lastLoginTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * The user with `displayName` containing "foo": `displayName:"foo"` * The user with `email` containing "bar": `email:"bar"` * All users with standard user roles: `assignedUserRole.userRole="STANDARD"` * All users with user roles for partner 123: `assignedUserRole.partnerId="123"` * All users with user roles for advertiser 123: `assignedUserRole.advertiserId="123"` * All users with partner level user roles: `entityType="PARTNER"` * All users with user roles for partner 123 and advertisers under partner 123: `parentPartnerId="123"` * All users that last logged in on or after 2023-01-01T00:00:00Z (format of ISO 8601): `lastLoginTime\>="2023-01-01T00:00:00Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. */ filter?: string; /** diff --git a/src/apis/dlp/v2.ts b/src/apis/dlp/v2.ts index 60ab4b30f7..2d57715ac6 100644 --- a/src/apis/dlp/v2.ts +++ b/src/apis/dlp/v2.ts @@ -5788,7 +5788,7 @@ export namespace dlp_v2 { } /** - * Lists data profiles for an organization. + * Lists column data profiles for an organization. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5911,7 +5911,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or projects/project-id/locations/asia. + * Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`. */ parent?: string; } @@ -8310,7 +8310,7 @@ export namespace dlp_v2 { } /** - * Lists data profiles for an organization. + * Lists project data profiles for an organization. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8417,11 +8417,11 @@ export namespace dlp_v2 { export interface Params$Resource$Organizations$Locations$Projectdataprofiles$List extends StandardParameters { /** - * Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * Supported fields/values: - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * project_id = 12345 AND status_code = 1 * project_id = 12345 AND sensitivity_level = HIGH The length of this field should be no more than 500 characters. + * Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * Supported fields/values: - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` The length of this field should be no more than 500 characters. */ filter?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id` * `sensitivity_level desc` Supported fields are: - `project_id`: GCP project ID - `sensitivity_level`: How sensitive the data in a project is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id` * `sensitivity_level desc` Supported fields are: - `project_id`: Google Cloud project ID - `sensitivity_level`: How sensitive the data in a project is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. */ orderBy?: string; /** @@ -9078,7 +9078,7 @@ export namespace dlp_v2 { } /** - * Lists data profiles for an organization. + * Lists table data profiles for an organization. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9185,11 +9185,11 @@ export namespace dlp_v2 { export interface Params$Resource$Organizations$Locations$Tabledataprofiles$List extends StandardParameters { /** - * Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * Supported fields/values: - `project_id` - The GCP project ID. - `dataset_id` - The BigQuery dataset ID. - `table_id` - The ID of the BigQuery table. - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * project_id = 12345 AND status_code = 1 * project_id = 12345 AND sensitivity_level = HIGH * project_id = 12345 AND resource_visibility = PUBLIC The length of this field should be no more than 500 characters. + * Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `dataset_id` - The BigQuery dataset ID. - `table_id` - The ID of the BigQuery table. - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` The length of this field should be no more than 500 characters. */ filter?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The GCP project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `row_count`: Number of rows in this resource. + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `row_count`: Number of rows in this resource. */ orderBy?: string; /** @@ -12605,7 +12605,7 @@ export namespace dlp_v2 { } /** - * Lists data profiles for an organization. + * Lists column data profiles for an organization. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12728,7 +12728,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or projects/project-id/locations/asia. + * Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`. */ parent?: string; } @@ -16385,7 +16385,7 @@ export namespace dlp_v2 { } /** - * Lists data profiles for an organization. + * Lists project data profiles for an organization. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -16492,11 +16492,11 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Locations$Projectdataprofiles$List extends StandardParameters { /** - * Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * Supported fields/values: - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * project_id = 12345 AND status_code = 1 * project_id = 12345 AND sensitivity_level = HIGH The length of this field should be no more than 500 characters. + * Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * Supported fields/values: - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` The length of this field should be no more than 500 characters. */ filter?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id` * `sensitivity_level desc` Supported fields are: - `project_id`: GCP project ID - `sensitivity_level`: How sensitive the data in a project is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id` * `sensitivity_level desc` Supported fields are: - `project_id`: Google Cloud project ID - `sensitivity_level`: How sensitive the data in a project is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. */ orderBy?: string; /** @@ -17149,7 +17149,7 @@ export namespace dlp_v2 { } /** - * Lists data profiles for an organization. + * Lists table data profiles for an organization. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17256,11 +17256,11 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Locations$Tabledataprofiles$List extends StandardParameters { /** - * Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * Supported fields/values: - `project_id` - The GCP project ID. - `dataset_id` - The BigQuery dataset ID. - `table_id` - The ID of the BigQuery table. - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * project_id = 12345 AND status_code = 1 * project_id = 12345 AND sensitivity_level = HIGH * project_id = 12345 AND resource_visibility = PUBLIC The length of this field should be no more than 500 characters. + * Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `dataset_id` - The BigQuery dataset ID. - `table_id` - The ID of the BigQuery table. - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` The length of this field should be no more than 500 characters. */ filter?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The GCP project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `row_count`: Number of rows in this resource. + * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `row_count`: Number of rows in this resource. */ orderBy?: string; /** diff --git a/src/apis/documentai/v1.ts b/src/apis/documentai/v1.ts index c0b1bbf5c6..fd5aa79ee4 100644 --- a/src/apis/documentai/v1.ts +++ b/src/apis/documentai/v1.ts @@ -5283,6 +5283,10 @@ export namespace documentai_v1 { * Optional. The schema the processor version will be trained with. */ documentSchema?: Schema$GoogleCloudDocumentaiV1DocumentSchema; + /** + * Options to control foundation model tuning of a processor. + */ + foundationModelTuningOptions?: Schema$GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions; /** * Optional. The input data used to train the ProcessorVersion. */ @@ -5301,6 +5305,19 @@ export namespace documentai_v1 { */ trainingMethod?: string | null; } + /** + * Options to control foundation model tuning of the processor. + */ + export interface Schema$GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions { + /** + * Optional. The multiplier to apply to the recommended learning rate. Valid values are between 0.1 and 10. If not provided, recommended learning rate will be used. + */ + learningRateMultiplier?: number | null; + /** + * Optional. The number of steps to run for model tuning. Valid values are between 1 and 400. If not provided, recommended steps will be used. + */ + trainSteps?: number | null; + } /** * The input data used to train a new ProcessorVersion. */ diff --git a/src/apis/documentai/v1beta3.ts b/src/apis/documentai/v1beta3.ts index 398a35ceba..0a1aa30449 100644 --- a/src/apis/documentai/v1beta3.ts +++ b/src/apis/documentai/v1beta3.ts @@ -4660,7 +4660,7 @@ export namespace documentai_v1beta3 { */ externalProcessorVersionSource?: Schema$GoogleCloudDocumentaiV1beta3ImportProcessorVersionRequestExternalProcessorVersionSource; /** - * The source processor version to import from. The source processor version and destination processor need to be in the same environment and region. + * The source processor version to import from. The source processor version and destination processor need to be in the same environment and region. Note that ProcessorVersions with `model_type` `MODEL_TYPE_LLM` are not supported. */ processorVersionSource?: string | null; } diff --git a/src/apis/file/v1.ts b/src/apis/file/v1.ts index e64e1aa2ed..28dd16ff08 100644 --- a/src/apis/file/v1.ts +++ b/src/apis/file/v1.ts @@ -626,7 +626,7 @@ export namespace file_v1 { name?: string | null; } /** - * LINT.IfChange Defines policies to service maintenance events. + * Defines policies to service maintenance events. */ export interface Schema$MaintenancePolicy { /** diff --git a/src/apis/firebasehosting/v1.ts b/src/apis/firebasehosting/v1.ts index f9c879a188..f0021a4902 100644 --- a/src/apis/firebasehosting/v1.ts +++ b/src/apis/firebasehosting/v1.ts @@ -168,7 +168,7 @@ export namespace firebasehosting_v1 { */ ownershipState?: string | null; /** - * A set of DNS record updates that allow Hosting to serve secure content on your domain name. The record type determines the update's purpose: - `A` and `AAAA`: Updates your domain name's IP addresses so that they direct traffic to Hosting servers. - `TXT`: Updates ownership permissions on your domain name, letting Hosting know that your custom domain's project has permission to perfrom actions for that domain name. - `CAA`: Updates your domain name's list of authorized Certificate Authorities (CAs). Only present if you have existing `CAA` records that prohibit Hosting's CA from minting certs for your domain name. These updates include all DNS changes you'll need to get started with Hosting, but, if made all at once, can result in a brief period of downtime for your domain name--while Hosting creates and uploads an SSL cert, for example. If you'd like to add your domain name to Hosting without downtime, complete the `liveMigrationSteps` first, before making the remaining updates in this field. + * A set of DNS record updates that allow Hosting to serve secure content on your domain name. The record type determines the update's purpose: - `A` and `AAAA`: Updates your domain name's IP addresses so that they direct traffic to Hosting servers. - `TXT`: Updates ownership permissions on your domain name, letting Hosting know that your custom domain's project has permission to perform actions for that domain name. - `CAA`: Updates your domain name's list of authorized Certificate Authorities (CAs). Only present if you have existing `CAA` records that prohibit Hosting's CA from minting certs for your domain name. These updates include all DNS changes you'll need to get started with Hosting, but, if made all at once, can result in a brief period of downtime for your domain name--while Hosting creates and uploads an SSL cert, for example. If you'd like to add your domain name to Hosting without downtime, complete the `liveMigrationSteps` first, before making the remaining updates in this field. */ quickSetupUpdates?: Schema$DnsUpdates; } diff --git a/src/apis/firebasehosting/v1beta1.ts b/src/apis/firebasehosting/v1beta1.ts index 7531247597..95a7abf179 100644 --- a/src/apis/firebasehosting/v1beta1.ts +++ b/src/apis/firebasehosting/v1beta1.ts @@ -377,7 +377,7 @@ export namespace firebasehosting_v1beta1 { */ ownershipState?: string | null; /** - * A set of DNS record updates that allow Hosting to serve secure content on your domain name. The record type determines the update's purpose: - `A` and `AAAA`: Updates your domain name's IP addresses so that they direct traffic to Hosting servers. - `TXT`: Updates ownership permissions on your domain name, letting Hosting know that your custom domain's project has permission to perfrom actions for that domain name. - `CAA`: Updates your domain name's list of authorized Certificate Authorities (CAs). Only present if you have existing `CAA` records that prohibit Hosting's CA from minting certs for your domain name. These updates include all DNS changes you'll need to get started with Hosting, but, if made all at once, can result in a brief period of downtime for your domain name--while Hosting creates and uploads an SSL cert, for example. If you'd like to add your domain name to Hosting without downtime, complete the `liveMigrationSteps` first, before making the remaining updates in this field. + * A set of DNS record updates that allow Hosting to serve secure content on your domain name. The record type determines the update's purpose: - `A` and `AAAA`: Updates your domain name's IP addresses so that they direct traffic to Hosting servers. - `TXT`: Updates ownership permissions on your domain name, letting Hosting know that your custom domain's project has permission to perform actions for that domain name. - `CAA`: Updates your domain name's list of authorized Certificate Authorities (CAs). Only present if you have existing `CAA` records that prohibit Hosting's CA from minting certs for your domain name. These updates include all DNS changes you'll need to get started with Hosting, but, if made all at once, can result in a brief period of downtime for your domain name--while Hosting creates and uploads an SSL cert, for example. If you'd like to add your domain name to Hosting without downtime, complete the `liveMigrationSteps` first, before making the remaining updates in this field. */ quickSetupUpdates?: Schema$DnsUpdates; } diff --git a/src/apis/firestore/v1.ts b/src/apis/firestore/v1.ts index e87db33e63..9b025a10cd 100644 --- a/src/apis/firestore/v1.ts +++ b/src/apis/firestore/v1.ts @@ -469,6 +469,27 @@ export namespace firestore_v1 { * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} */ export interface Schema$Empty {} + /** + * Execution statistics for the query. + */ + export interface Schema$ExecutionStats { + /** + * Debugging statistics from the execution of the query. Note that the debugging stats are subject to change as Firestore evolves. It could include: { "indexes_entries_scanned": "1000", "documents_scanned": "20", "billing_details" : { "documents_billable": "20", "index_entries_billable": "1000", "min_query_cost": "0" \} \} + */ + debugStats?: {[key: string]: any} | null; + /** + * Total time to execute the query in the backend. + */ + executionDuration?: string | null; + /** + * Total billable read operations. + */ + readOperations?: string | null; + /** + * Total number of results returned, including documents, projections, aggregation results, keys. + */ + resultsReturned?: string | null; + } /** * A digest of all the documents that match a given target. */ @@ -486,6 +507,28 @@ export namespace firestore_v1 { */ unchangedNames?: Schema$BloomFilter; } + /** + * Explain metrics for the query. + */ + export interface Schema$ExplainMetrics { + /** + * Aggregated stats from the execution of the query. Only present when ExplainOptions.analyze is set to true. + */ + executionStats?: Schema$ExecutionStats; + /** + * Planning phase information for the query. + */ + planSummary?: Schema$PlanSummary; + } + /** + * Explain options for the query. + */ + export interface Schema$ExplainOptions { + /** + * Optional. Whether to execute this query. When false (the default), the query will be planned, returning only metrics from the planning stages. When true, the query will be planned and executed, returning the full query results along with both planning and execution stage metrics. + */ + analyze?: boolean | null; + } /** * A filter on a specific field. */ @@ -642,7 +685,7 @@ export namespace firestore_v1 { */ export interface Schema$GoogleFirestoreAdminV1CreateDatabaseMetadata {} /** - * Represent a recurring schedule that runs at a specific time every day. The time zone is UTC. + * Represents a recurring schedule that runs at a specific time every day. The time zone is UTC. */ export interface Schema$GoogleFirestoreAdminV1DailyRecurrence {} /** @@ -1442,6 +1485,15 @@ export namespace firestore_v1 { */ partitions?: Schema$Cursor[]; } + /** + * Planning phase information for the query. + */ + export interface Schema$PlanSummary { + /** + * The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, __name__ ASC)"\}, {"query_scope": "Collection", "properties": "(bar ASC, __name__ ASC)"\} ] + */ + indexesUsed?: Array<{[key: string]: any}> | null; + } /** * A precondition on a document, used for conditional operations. */ @@ -1508,6 +1560,10 @@ export namespace firestore_v1 { * The request for Firestore.RunAggregationQuery. */ export interface Schema$RunAggregationQueryRequest { + /** + * Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned. + */ + explainOptions?: Schema$ExplainOptions; /** * Starts a new transaction as part of the query, defaulting to read-only. The new transaction ID will be returned as the first response in the stream. */ @@ -1529,6 +1585,10 @@ export namespace firestore_v1 { * The response for Firestore.RunAggregationQuery. */ export interface Schema$RunAggregationQueryResponse { + /** + * Query explain metrics. This is only present when the RunAggregationQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream. + */ + explainMetrics?: Schema$ExplainMetrics; /** * The time at which the aggregate result was computed. This is always monotonically increasing; in this case, the previous AggregationResult in the result stream are guaranteed not to have changed between their `read_time` and this one. If the query returns no results, a response with `read_time` and no `result` will be sent, and this represents the time at which the query was run. */ @@ -1546,6 +1606,10 @@ export namespace firestore_v1 { * The request for Firestore.RunQuery. */ export interface Schema$RunQueryRequest { + /** + * Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned. + */ + explainOptions?: Schema$ExplainOptions; /** * Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream. */ @@ -1575,6 +1639,10 @@ export namespace firestore_v1 { * If present, Firestore has completely finished the request and no more documents will be returned. */ done?: boolean | null; + /** + * Query explain metrics. This is only present when the RunQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream. + */ + explainMetrics?: Schema$ExplainMetrics; /** * The time at which the document was read. This may be monotonically increasing; in this case, the previous documents in the result stream are guaranteed not to have changed between their `read_time` and this one. If the query returns no results, a response with `read_time` and no `document` will be sent, and this represents the time at which the query was run. */ @@ -3241,7 +3309,7 @@ export namespace firestore_v1 { export interface Params$Resource$Projects$Databases$Backupschedules$Delete extends StandardParameters { /** - * Required. The name of backup schedule. Format `projects/{project\}/databases/{database\}/backupSchedules/{backup_schedule\}` + * Required. The name of the backup schedule. Format `projects/{project\}/databases/{database\}/backupSchedules/{backup_schedule\}` */ name?: string; } diff --git a/src/apis/firestore/v1beta1.ts b/src/apis/firestore/v1beta1.ts index ae17210517..3071969f87 100644 --- a/src/apis/firestore/v1beta1.ts +++ b/src/apis/firestore/v1beta1.ts @@ -469,6 +469,27 @@ export namespace firestore_v1beta1 { * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} */ export interface Schema$Empty {} + /** + * Execution statistics for the query. + */ + export interface Schema$ExecutionStats { + /** + * Debugging statistics from the execution of the query. Note that the debugging stats are subject to change as Firestore evolves. It could include: { "indexes_entries_scanned": "1000", "documents_scanned": "20", "billing_details" : { "documents_billable": "20", "index_entries_billable": "1000", "min_query_cost": "0" \} \} + */ + debugStats?: {[key: string]: any} | null; + /** + * Total time to execute the query in the backend. + */ + executionDuration?: string | null; + /** + * Total billable read operations. + */ + readOperations?: string | null; + /** + * Total number of results returned, including documents, projections, aggregation results, keys. + */ + resultsReturned?: string | null; + } /** * A digest of all the documents that match a given target. */ @@ -486,6 +507,28 @@ export namespace firestore_v1beta1 { */ unchangedNames?: Schema$BloomFilter; } + /** + * Explain metrics for the query. + */ + export interface Schema$ExplainMetrics { + /** + * Aggregated stats from the execution of the query. Only present when ExplainOptions.analyze is set to true. + */ + executionStats?: Schema$ExecutionStats; + /** + * Planning phase information for the query. + */ + planSummary?: Schema$PlanSummary; + } + /** + * Explain options for the query. + */ + export interface Schema$ExplainOptions { + /** + * Optional. Whether to execute this query. When false (the default), the query will be planned, returning only metrics from the planning stages. When true, the query will be planned and executed, returning the full query results along with both planning and execution stage metrics. + */ + analyze?: boolean | null; + } /** * A filter on a specific field. */ @@ -993,6 +1036,15 @@ export namespace firestore_v1beta1 { */ partitions?: Schema$Cursor[]; } + /** + * Planning phase information for the query. + */ + export interface Schema$PlanSummary { + /** + * The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, __name__ ASC)"\}, {"query_scope": "Collection", "properties": "(bar ASC, __name__ ASC)"\} ] + */ + indexesUsed?: Array<{[key: string]: any}> | null; + } /** * A precondition on a document, used for conditional operations. */ @@ -1059,6 +1111,10 @@ export namespace firestore_v1beta1 { * The request for Firestore.RunAggregationQuery. */ export interface Schema$RunAggregationQueryRequest { + /** + * Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned. + */ + explainOptions?: Schema$ExplainOptions; /** * Starts a new transaction as part of the query, defaulting to read-only. The new transaction ID will be returned as the first response in the stream. */ @@ -1080,6 +1136,10 @@ export namespace firestore_v1beta1 { * The response for Firestore.RunAggregationQuery. */ export interface Schema$RunAggregationQueryResponse { + /** + * Query explain metrics. This is only present when the RunAggregationQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream. + */ + explainMetrics?: Schema$ExplainMetrics; /** * The time at which the aggregate result was computed. This is always monotonically increasing; in this case, the previous AggregationResult in the result stream are guaranteed not to have changed between their `read_time` and this one. If the query returns no results, a response with `read_time` and no `result` will be sent, and this represents the time at which the query was run. */ @@ -1097,6 +1157,10 @@ export namespace firestore_v1beta1 { * The request for Firestore.RunQuery. */ export interface Schema$RunQueryRequest { + /** + * Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned. + */ + explainOptions?: Schema$ExplainOptions; /** * Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream. */ @@ -1126,6 +1190,10 @@ export namespace firestore_v1beta1 { * If present, Firestore has completely finished the request and no more documents will be returned. */ done?: boolean | null; + /** + * Query explain metrics. This is only present when the RunQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream. + */ + explainMetrics?: Schema$ExplainMetrics; /** * The time at which the document was read. This may be monotonically increasing; in this case, the previous documents in the result stream are guaranteed not to have changed between their `read_time` and this one. If the query returns no results, a response with `read_time` and no `document` will be sent, and this represents the time at which the query was run. */ diff --git a/src/apis/gkebackup/v1.ts b/src/apis/gkebackup/v1.ts index a501c0935e..0e3bfebd71 100644 --- a/src/apis/gkebackup/v1.ts +++ b/src/apis/gkebackup/v1.ts @@ -151,7 +151,7 @@ export namespace gkebackup_v1 { logType?: string | null; } /** - * Represents a request to perform a single point-in-time capture of some portion of the state of a GKE cluster, the record of the backup operation itself, and an anchor for the underlying artifacts that comprise the Backup (the config backup and VolumeBackups). Next id: 29 + * Represents a request to perform a single point-in-time capture of some portion of the state of a GKE cluster, the record of the backup operation itself, and an anchor for the underlying artifacts that comprise the Backup (the config backup and VolumeBackups). */ export interface Schema$Backup { /** @@ -757,7 +757,7 @@ export namespace gkebackup_v1 { namespaces?: string[] | null; } /** - * Represents both a request to Restore some portion of a Backup into a target GKE cluster and a record of the restore operation itself. Next id: 20 + * Represents both a request to Restore some portion of a Backup into a target GKE cluster and a record of the restore operation itself. */ export interface Schema$Restore { /** @@ -830,7 +830,7 @@ export namespace gkebackup_v1 { volumesRestoredCount?: number | null; } /** - * Configuration of a restore. Next id: 14 + * Configuration of a restore. */ export interface Schema$RestoreConfig { /** @@ -879,7 +879,7 @@ export namespace gkebackup_v1 { volumeDataRestorePolicy?: string | null; } /** - * The configuration of a potential series of Restore operations to be performed against Backups belong to a particular BackupPlan. Next id: 13 + * The configuration of a potential series of Restore operations to be performed against Backups belong to a particular BackupPlan. */ export interface Schema$RestorePlan { /** @@ -1056,7 +1056,7 @@ export namespace gkebackup_v1 { value?: string | null; } /** - * Represents the backup of a specific persistent volume as a component of a Backup - both the record of the operation and a pointer to the underlying storage-specific artifacts. Next id: 14 + * Represents the backup of a specific persistent volume as a component of a Backup - both the record of the operation and a pointer to the underlying storage-specific artifacts. */ export interface Schema$VolumeBackup { /** @@ -1113,7 +1113,7 @@ export namespace gkebackup_v1 { volumeBackupHandle?: string | null; } /** - * Represents the operation of restoring a volume from a VolumeBackup. Next id: 13 + * Represents the operation of restoring a volume from a VolumeBackup. */ export interface Schema$VolumeRestore { /** diff --git a/src/apis/gkehub/v1.ts b/src/apis/gkehub/v1.ts index 749341384f..fd6ed5e8dc 100644 --- a/src/apis/gkehub/v1.ts +++ b/src/apis/gkehub/v1.ts @@ -1362,6 +1362,10 @@ export namespace gkehub_v1 { * GoogleConfig specific configuration. */ googleConfig?: Schema$IdentityServiceGoogleConfig; + /** + * LDAP specific configuration. + */ + ldapConfig?: Schema$IdentityServiceLdapConfig; /** * Identifier for auth config. */ @@ -1421,6 +1425,44 @@ export namespace gkehub_v1 { */ disable?: boolean | null; } + /** + * Contains the properties for locating and authenticating groups in the directory. + */ + export interface Schema$IdentityServiceGroupConfig { + /** + * Required. The location of the subtree in the LDAP directory to search for group entries. + */ + baseDn?: string | null; + /** + * Optional. Optional filter to be used when searching for groups a user belongs to. This can be used to explicitly match only certain groups in order to reduce the amount of groups returned for each user. This defaults to "(objectClass=Group)". + */ + filter?: string | null; + /** + * Optional. The identifying name of each group a user belongs to. For example, if this is set to "distinguishedName" then RBACs and other group expectations should be written as full DNs. This defaults to "distinguishedName". + */ + idAttribute?: string | null; + } + /** + * Configuration for the LDAP Auth flow. + */ + export interface Schema$IdentityServiceLdapConfig { + /** + * Optional. Contains the properties for locating and authenticating groups in the directory. + */ + group?: Schema$IdentityServiceGroupConfig; + /** + * Required. Server settings for the external LDAP server. + */ + server?: Schema$IdentityServiceServerConfig; + /** + * Required. Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate. + */ + serviceAccount?: Schema$IdentityServiceServiceAccountConfig; + /** + * Required. Defines where users exist in the LDAP directory. + */ + user?: Schema$IdentityServiceUserConfig; + } /** * **Anthos Identity Service**: Configuration for a single Membership. */ @@ -1549,6 +1591,70 @@ export namespace gkehub_v1 { */ userPrefix?: string | null; } + /** + * Server settings for the external LDAP server. + */ + export interface Schema$IdentityServiceServerConfig { + /** + * Optional. Contains a Base64 encoded, PEM formatted certificate authority certificate for the LDAP server. This must be provided for the "ldaps" and "startTLS" connections. + */ + certificateAuthorityData?: string | null; + /** + * Optional. Defines the connection type to communicate with the LDAP server. If `starttls` or `ldaps` is specified, the certificate_authority_data should not be empty. + */ + connectionType?: string | null; + /** + * Required. Defines the hostname or IP of the LDAP server. Port is optional and will default to 389, if unspecified. For example, "ldap.server.example" or "10.10.10.10:389". + */ + host?: string | null; + } + /** + * Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate. + */ + export interface Schema$IdentityServiceServiceAccountConfig { + /** + * Credentials for basic auth. + */ + simpleBindCredentials?: Schema$IdentityServiceSimpleBindCredentials; + } + /** + * The structure holds the LDAP simple binding credential. + */ + export interface Schema$IdentityServiceSimpleBindCredentials { + /** + * Required. The distinguished name(DN) of the service account object/user. + */ + dn?: string | null; + /** + * Output only. The encrypted password of the service account object/user. + */ + encryptedPassword?: string | null; + /** + * Required. Input only. The password of the service account object/user. + */ + password?: string | null; + } + /** + * Defines where users exist in the LDAP directory. + */ + export interface Schema$IdentityServiceUserConfig { + /** + * Required. The location of the subtree in the LDAP directory to search for user entries. + */ + baseDn?: string | null; + /** + * Optional. Filter to apply when searching for the user. This can be used to further restrict the user accounts which are allowed to login. This defaults to "(objectClass=User)". + */ + filter?: string | null; + /** + * Optional. Determines which attribute to use as the user's identity after they are authenticated. This is distinct from the loginAttribute field to allow users to login with a username, but then have their actual identifier be an email address or full Distinguished Name (DN). For example, setting loginAttribute to "sAMAccountName" and identifierAttribute to "userPrincipalName" would allow a user to login as "bsmith", but actual RBAC policies for the user would be written as "bsmith@example.com". Using "userPrincipalName" is recommended since this will be unique for each user. This defaults to "userPrincipalName". + */ + idAttribute?: string | null; + /** + * Optional. The name of the attribute which matches against the input username. This is used to find the user in the LDAP database e.g. "(=)" and is combined with the optional filter field. This defaults to "userPrincipalName". + */ + loginAttribute?: string | null; + } /** * KubernetesMetadata provides informational metadata for Memberships representing Kubernetes clusters. */ @@ -1599,6 +1705,23 @@ export namespace gkehub_v1 { */ resourceOptions?: Schema$ResourceOptions; } + /** + * List of Memberships bound to a Scope. + */ + export interface Schema$ListBoundMembershipsResponse { + /** + * The list of Memberships bound to the given Scope. + */ + memberships?: Schema$Membership[]; + /** + * A token to request the next page of resources from the `ListBoundMemberships` method. The value of an empty string means that there are no more resources to return. + */ + nextPageToken?: string | null; + /** + * List of locations that could not be reached while fetching this list. + */ + unreachable?: string[] | null; + } /** * Response message for the `GkeHub.ListFeatures` method. */ @@ -1681,6 +1804,19 @@ export namespace gkehub_v1 { */ operations?: Schema$Operation[]; } + /** + * List of permitted Scopes. + */ + export interface Schema$ListPermittedScopesResponse { + /** + * A token to request the next page of resources from the `ListPermittedScopes` method. The value of an empty string means that there are no more resources to return. + */ + nextPageToken?: string | null; + /** + * The list of permitted Scopes + */ + scopes?: Schema$Scope[]; + } /** * List of fleet namespaces. */ @@ -6692,6 +6828,197 @@ export namespace gkehub_v1 { } } + /** + * Lists Memberships bound to a Scope. The response includes relevant Memberships from all regions. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listMemberships( + params: Params$Resource$Projects$Locations$Scopes$Listmemberships, + options: StreamMethodOptions + ): GaxiosPromise; + listMemberships( + params?: Params$Resource$Projects$Locations$Scopes$Listmemberships, + options?: MethodOptions + ): GaxiosPromise; + listMemberships( + params: Params$Resource$Projects$Locations$Scopes$Listmemberships, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listMemberships( + params: Params$Resource$Projects$Locations$Scopes$Listmemberships, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listMemberships( + params: Params$Resource$Projects$Locations$Scopes$Listmemberships, + callback: BodyResponseCallback + ): void; + listMemberships( + callback: BodyResponseCallback + ): void; + listMemberships( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Scopes$Listmemberships + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Scopes$Listmemberships; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Scopes$Listmemberships; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkehub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+scopeName}:listMemberships').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['scopeName'], + pathParams: ['scopeName'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists permitted Scopes. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listPermitted( + params: Params$Resource$Projects$Locations$Scopes$Listpermitted, + options: StreamMethodOptions + ): GaxiosPromise; + listPermitted( + params?: Params$Resource$Projects$Locations$Scopes$Listpermitted, + options?: MethodOptions + ): GaxiosPromise; + listPermitted( + params: Params$Resource$Projects$Locations$Scopes$Listpermitted, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listPermitted( + params: Params$Resource$Projects$Locations$Scopes$Listpermitted, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listPermitted( + params: Params$Resource$Projects$Locations$Scopes$Listpermitted, + callback: BodyResponseCallback + ): void; + listPermitted( + callback: BodyResponseCallback + ): void; + listPermitted( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Scopes$Listpermitted + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Scopes$Listpermitted; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Scopes$Listpermitted; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkehub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/scopes:listPermitted').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Updates a scopes. * @@ -7015,6 +7342,40 @@ export namespace gkehub_v1 { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Scopes$Listmemberships + extends StandardParameters { + /** + * Optional. Lists Memberships that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Currently, filtering can be done only based on Memberships's `name`, `labels`, `create_time`, `update_time`, and `unique_id`. + */ + filter?: string; + /** + * Optional. When requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned. Pagination is currently not supported; therefore, setting this field does not have any impact for now. + */ + pageSize?: number; + /** + * Optional. Token returned by previous call to `ListBoundMemberships` which specifies the position in the list from where to continue listing the resources. + */ + pageToken?: string; + /** + * Required. Name of the Scope, in the format `projects/x/locations/global/scopes/x`, to which the Memberships are bound. + */ + scopeName?: string; + } + export interface Params$Resource$Projects$Locations$Scopes$Listpermitted + extends StandardParameters { + /** + * Optional. When requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned. + */ + pageSize?: number; + /** + * Optional. Token returned by previous call to `ListPermittedScopes` which specifies the position in the list from where to continue listing the resources. + */ + pageToken?: string; + /** + * Required. The parent (project and location) where the Scope will be listed. Specified in the format `projects/x/locations/x`. + */ + parent?: string; + } export interface Params$Resource$Projects$Locations$Scopes$Patch extends StandardParameters { /** diff --git a/src/apis/gkehub/v1alpha.ts b/src/apis/gkehub/v1alpha.ts index 04d90d5d88..c039190167 100644 --- a/src/apis/gkehub/v1alpha.ts +++ b/src/apis/gkehub/v1alpha.ts @@ -1533,6 +1533,10 @@ export namespace gkehub_v1alpha { * GoogleConfig specific configuration. */ googleConfig?: Schema$IdentityServiceGoogleConfig; + /** + * LDAP specific configuration. + */ + ldapConfig?: Schema$IdentityServiceLdapConfig; /** * Identifier for auth config. */ @@ -1592,6 +1596,44 @@ export namespace gkehub_v1alpha { */ disable?: boolean | null; } + /** + * Contains the properties for locating and authenticating groups in the directory. + */ + export interface Schema$IdentityServiceGroupConfig { + /** + * Required. The location of the subtree in the LDAP directory to search for group entries. + */ + baseDn?: string | null; + /** + * Optional. Optional filter to be used when searching for groups a user belongs to. This can be used to explicitly match only certain groups in order to reduce the amount of groups returned for each user. This defaults to "(objectClass=Group)". + */ + filter?: string | null; + /** + * Optional. The identifying name of each group a user belongs to. For example, if this is set to "distinguishedName" then RBACs and other group expectations should be written as full DNs. This defaults to "distinguishedName". + */ + idAttribute?: string | null; + } + /** + * Configuration for the LDAP Auth flow. + */ + export interface Schema$IdentityServiceLdapConfig { + /** + * Optional. Contains the properties for locating and authenticating groups in the directory. + */ + group?: Schema$IdentityServiceGroupConfig; + /** + * Required. Server settings for the external LDAP server. + */ + server?: Schema$IdentityServiceServerConfig; + /** + * Required. Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate. + */ + serviceAccount?: Schema$IdentityServiceServiceAccountConfig; + /** + * Required. Defines where users exist in the LDAP directory. + */ + user?: Schema$IdentityServiceUserConfig; + } /** * **Anthos Identity Service**: Configuration for a single Membership. */ @@ -1720,6 +1762,70 @@ export namespace gkehub_v1alpha { */ userPrefix?: string | null; } + /** + * Server settings for the external LDAP server. + */ + export interface Schema$IdentityServiceServerConfig { + /** + * Optional. Contains a Base64 encoded, PEM formatted certificate authority certificate for the LDAP server. This must be provided for the "ldaps" and "startTLS" connections. + */ + certificateAuthorityData?: string | null; + /** + * Optional. Defines the connection type to communicate with the LDAP server. If `starttls` or `ldaps` is specified, the certificate_authority_data should not be empty. + */ + connectionType?: string | null; + /** + * Required. Defines the hostname or IP of the LDAP server. Port is optional and will default to 389, if unspecified. For example, "ldap.server.example" or "10.10.10.10:389". + */ + host?: string | null; + } + /** + * Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate. + */ + export interface Schema$IdentityServiceServiceAccountConfig { + /** + * Credentials for basic auth. + */ + simpleBindCredentials?: Schema$IdentityServiceSimpleBindCredentials; + } + /** + * The structure holds the LDAP simple binding credential. + */ + export interface Schema$IdentityServiceSimpleBindCredentials { + /** + * Required. The distinguished name(DN) of the service account object/user. + */ + dn?: string | null; + /** + * Output only. The encrypted password of the service account object/user. + */ + encryptedPassword?: string | null; + /** + * Required. Input only. The password of the service account object/user. + */ + password?: string | null; + } + /** + * Defines where users exist in the LDAP directory. + */ + export interface Schema$IdentityServiceUserConfig { + /** + * Required. The location of the subtree in the LDAP directory to search for user entries. + */ + baseDn?: string | null; + /** + * Optional. Filter to apply when searching for the user. This can be used to further restrict the user accounts which are allowed to login. This defaults to "(objectClass=User)". + */ + filter?: string | null; + /** + * Optional. Determines which attribute to use as the user's identity after they are authenticated. This is distinct from the loginAttribute field to allow users to login with a username, but then have their actual identifier be an email address or full Distinguished Name (DN). For example, setting loginAttribute to "sAMAccountName" and identifierAttribute to "userPrincipalName" would allow a user to login as "bsmith", but actual RBAC policies for the user would be written as "bsmith@example.com". Using "userPrincipalName" is recommended since this will be unique for each user. This defaults to "userPrincipalName". + */ + idAttribute?: string | null; + /** + * Optional. The name of the attribute which matches against the input username. This is used to find the user in the LDAP database e.g. "(=)" and is combined with the optional filter field. This defaults to "userPrincipalName". + */ + loginAttribute?: string | null; + } /** * KubernetesMetadata provides informational metadata for Memberships representing Kubernetes clusters. */ diff --git a/src/apis/gkehub/v1beta.ts b/src/apis/gkehub/v1beta.ts index 85326491c9..d7f6bb6091 100644 --- a/src/apis/gkehub/v1beta.ts +++ b/src/apis/gkehub/v1beta.ts @@ -1440,6 +1440,10 @@ export namespace gkehub_v1beta { * GoogleConfig specific configuration. */ googleConfig?: Schema$IdentityServiceGoogleConfig; + /** + * LDAP specific configuration. + */ + ldapConfig?: Schema$IdentityServiceLdapConfig; /** * Identifier for auth config. */ @@ -1499,6 +1503,44 @@ export namespace gkehub_v1beta { */ disable?: boolean | null; } + /** + * Contains the properties for locating and authenticating groups in the directory. + */ + export interface Schema$IdentityServiceGroupConfig { + /** + * Required. The location of the subtree in the LDAP directory to search for group entries. + */ + baseDn?: string | null; + /** + * Optional. Optional filter to be used when searching for groups a user belongs to. This can be used to explicitly match only certain groups in order to reduce the amount of groups returned for each user. This defaults to "(objectClass=Group)". + */ + filter?: string | null; + /** + * Optional. The identifying name of each group a user belongs to. For example, if this is set to "distinguishedName" then RBACs and other group expectations should be written as full DNs. This defaults to "distinguishedName". + */ + idAttribute?: string | null; + } + /** + * Configuration for the LDAP Auth flow. + */ + export interface Schema$IdentityServiceLdapConfig { + /** + * Optional. Contains the properties for locating and authenticating groups in the directory. + */ + group?: Schema$IdentityServiceGroupConfig; + /** + * Required. Server settings for the external LDAP server. + */ + server?: Schema$IdentityServiceServerConfig; + /** + * Required. Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate. + */ + serviceAccount?: Schema$IdentityServiceServiceAccountConfig; + /** + * Required. Defines where users exist in the LDAP directory. + */ + user?: Schema$IdentityServiceUserConfig; + } /** * **Anthos Identity Service**: Configuration for a single Membership. */ @@ -1627,6 +1669,70 @@ export namespace gkehub_v1beta { */ userPrefix?: string | null; } + /** + * Server settings for the external LDAP server. + */ + export interface Schema$IdentityServiceServerConfig { + /** + * Optional. Contains a Base64 encoded, PEM formatted certificate authority certificate for the LDAP server. This must be provided for the "ldaps" and "startTLS" connections. + */ + certificateAuthorityData?: string | null; + /** + * Optional. Defines the connection type to communicate with the LDAP server. If `starttls` or `ldaps` is specified, the certificate_authority_data should not be empty. + */ + connectionType?: string | null; + /** + * Required. Defines the hostname or IP of the LDAP server. Port is optional and will default to 389, if unspecified. For example, "ldap.server.example" or "10.10.10.10:389". + */ + host?: string | null; + } + /** + * Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate. + */ + export interface Schema$IdentityServiceServiceAccountConfig { + /** + * Credentials for basic auth. + */ + simpleBindCredentials?: Schema$IdentityServiceSimpleBindCredentials; + } + /** + * The structure holds the LDAP simple binding credential. + */ + export interface Schema$IdentityServiceSimpleBindCredentials { + /** + * Required. The distinguished name(DN) of the service account object/user. + */ + dn?: string | null; + /** + * Output only. The encrypted password of the service account object/user. + */ + encryptedPassword?: string | null; + /** + * Required. Input only. The password of the service account object/user. + */ + password?: string | null; + } + /** + * Defines where users exist in the LDAP directory. + */ + export interface Schema$IdentityServiceUserConfig { + /** + * Required. The location of the subtree in the LDAP directory to search for user entries. + */ + baseDn?: string | null; + /** + * Optional. Filter to apply when searching for the user. This can be used to further restrict the user accounts which are allowed to login. This defaults to "(objectClass=User)". + */ + filter?: string | null; + /** + * Optional. Determines which attribute to use as the user's identity after they are authenticated. This is distinct from the loginAttribute field to allow users to login with a username, but then have their actual identifier be an email address or full Distinguished Name (DN). For example, setting loginAttribute to "sAMAccountName" and identifierAttribute to "userPrincipalName" would allow a user to login as "bsmith", but actual RBAC policies for the user would be written as "bsmith@example.com". Using "userPrincipalName" is recommended since this will be unique for each user. This defaults to "userPrincipalName". + */ + idAttribute?: string | null; + /** + * Optional. The name of the attribute which matches against the input username. This is used to find the user in the LDAP database e.g. "(=)" and is combined with the optional filter field. This defaults to "userPrincipalName". + */ + loginAttribute?: string | null; + } /** * KubernetesMetadata provides informational metadata for Memberships representing Kubernetes clusters. */ @@ -1677,6 +1783,23 @@ export namespace gkehub_v1beta { */ resourceOptions?: Schema$ResourceOptions; } + /** + * List of Memberships bound to a Scope. + */ + export interface Schema$ListBoundMembershipsResponse { + /** + * The list of Memberships bound to the given Scope. + */ + memberships?: Schema$Membership[]; + /** + * A token to request the next page of resources from the `ListBoundMemberships` method. The value of an empty string means that there are no more resources to return. + */ + nextPageToken?: string | null; + /** + * List of locations that could not be reached while fetching this list. + */ + unreachable?: string[] | null; + } /** * Response message for the `GkeHub.ListFeatures` method. */ @@ -1772,6 +1895,19 @@ export namespace gkehub_v1beta { */ operations?: Schema$Operation[]; } + /** + * List of permitted Scopes. + */ + export interface Schema$ListPermittedScopesResponse { + /** + * A token to request the next page of resources from the `ListPermittedScopes` method. The value of an empty string means that there are no more resources to return. + */ + nextPageToken?: string | null; + /** + * The list of permitted Scopes + */ + scopes?: Schema$Scope[]; + } /** * List of fleet namespaces. */ @@ -7455,6 +7591,197 @@ export namespace gkehub_v1beta { } } + /** + * Lists Memberships bound to a Scope. The response includes relevant Memberships from all regions. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listMemberships( + params: Params$Resource$Projects$Locations$Scopes$Listmemberships, + options: StreamMethodOptions + ): GaxiosPromise; + listMemberships( + params?: Params$Resource$Projects$Locations$Scopes$Listmemberships, + options?: MethodOptions + ): GaxiosPromise; + listMemberships( + params: Params$Resource$Projects$Locations$Scopes$Listmemberships, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listMemberships( + params: Params$Resource$Projects$Locations$Scopes$Listmemberships, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listMemberships( + params: Params$Resource$Projects$Locations$Scopes$Listmemberships, + callback: BodyResponseCallback + ): void; + listMemberships( + callback: BodyResponseCallback + ): void; + listMemberships( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Scopes$Listmemberships + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Scopes$Listmemberships; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Scopes$Listmemberships; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkehub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+scopeName}:listMemberships').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['scopeName'], + pathParams: ['scopeName'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists permitted Scopes. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listPermitted( + params: Params$Resource$Projects$Locations$Scopes$Listpermitted, + options: StreamMethodOptions + ): GaxiosPromise; + listPermitted( + params?: Params$Resource$Projects$Locations$Scopes$Listpermitted, + options?: MethodOptions + ): GaxiosPromise; + listPermitted( + params: Params$Resource$Projects$Locations$Scopes$Listpermitted, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listPermitted( + params: Params$Resource$Projects$Locations$Scopes$Listpermitted, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listPermitted( + params: Params$Resource$Projects$Locations$Scopes$Listpermitted, + callback: BodyResponseCallback + ): void; + listPermitted( + callback: BodyResponseCallback + ): void; + listPermitted( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Scopes$Listpermitted + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Scopes$Listpermitted; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Scopes$Listpermitted; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkehub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/scopes:listPermitted').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Updates a scopes. * @@ -7778,6 +8105,40 @@ export namespace gkehub_v1beta { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Scopes$Listmemberships + extends StandardParameters { + /** + * Optional. Lists Memberships that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Currently, filtering can be done only based on Memberships's `name`, `labels`, `create_time`, `update_time`, and `unique_id`. + */ + filter?: string; + /** + * Optional. When requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned. Pagination is currently not supported; therefore, setting this field does not have any impact for now. + */ + pageSize?: number; + /** + * Optional. Token returned by previous call to `ListBoundMemberships` which specifies the position in the list from where to continue listing the resources. + */ + pageToken?: string; + /** + * Required. Name of the Scope, in the format `projects/x/locations/global/scopes/x`, to which the Memberships are bound. + */ + scopeName?: string; + } + export interface Params$Resource$Projects$Locations$Scopes$Listpermitted + extends StandardParameters { + /** + * Optional. When requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned. + */ + pageSize?: number; + /** + * Optional. Token returned by previous call to `ListPermittedScopes` which specifies the position in the list from where to continue listing the resources. + */ + pageToken?: string; + /** + * Required. The parent (project and location) where the Scope will be listed. Specified in the format `projects/x/locations/x`. + */ + parent?: string; + } export interface Params$Resource$Projects$Locations$Scopes$Patch extends StandardParameters { /** diff --git a/src/apis/healthcare/v1.ts b/src/apis/healthcare/v1.ts index 3ae5650188..a08606382d 100644 --- a/src/apis/healthcare/v1.ts +++ b/src/apis/healthcare/v1.ts @@ -1933,7 +1933,7 @@ export namespace healthcare_v1 { */ force?: boolean | null; /** - * Optional. GCS object containing list of {resourceType\}/{resourceId\} lines, identifying resources to be reverted + * Optional. Cloud Storage object containing list of {resourceType\}/{resourceId\} lines, identifying resources to be reverted */ inputGcsObject?: string | null; /** diff --git a/src/apis/healthcare/v1beta1.ts b/src/apis/healthcare/v1beta1.ts index 40b71d43f8..7a150b9ed6 100644 --- a/src/apis/healthcare/v1beta1.ts +++ b/src/apis/healthcare/v1beta1.ts @@ -650,11 +650,11 @@ export namespace healthcare_v1beta1 { */ actor?: string | null; /** - * An abstract identifier that describes the environment or conditions under which the accessor is acting. Can be “*” if it applies to all environments. + * An abstract identifier that describes the environment or conditions under which the accessor is acting. Can be "*" if it applies to all environments. */ environment?: string | null; /** - * The intent of data use. Can be “*” if it applies to all purposes. + * The intent of data use. Can be "*" if it applies to all purposes. */ purpose?: string | null; } @@ -1222,7 +1222,7 @@ export namespace healthcare_v1beta1 { */ cascadeOrigins?: string[] | null; /** - * The resource name of this consent resource. Format: `projects/{projectId\}/datasets/{datasetId\}/fhirStores/{fhirStoreId\}/fhir/{resourceType\}/{id\}`. + * The resource name of this consent resource. Format: `projects/{projectId\}/locations/{locationId\}/datasets/{datasetId\}/fhirStores/{fhirStoreId\}/fhir/{resourceType\}/{id\}`. */ consentResource?: string | null; /** @@ -2971,7 +2971,7 @@ export namespace healthcare_v1beta1 { */ blobStorageSettings?: Schema$BlobStorageSettings; /** - * Optional. A filter configuration. If `filter_config` is specified, set the value of `resource` to the resource name of a DICOM store in the format `projects/{projectID\}/datasets/{datasetID\}/dicomStores/{dicomStoreID\}`. + * Optional. A filter configuration. If `filter_config` is specified, set the value of `resource` to the resource name of a DICOM store in the format `projects/{projectID\}/locations/{locationID\}/datasets/{datasetID\}/dicomStores/{dicomStoreID\}`. */ filterConfig?: Schema$DicomFilterConfig; } @@ -3039,7 +3039,7 @@ export namespace healthcare_v1beta1 { */ blobStorageInfo?: Schema$BlobStorageInfo; /** - * The resource whose storage info is returned. For example, to specify the resource path of a DICOM Instance: `projects/{projectid\}/datasets/{datasetid\}/dicomStores/{dicom_store_id\}/dicomWeb/studi/{study_uid\}/series/{series_uid\}/instances/{instance_uid\}` + * The resource whose storage info is returned. For example, to specify the resource path of a DICOM Instance: `projects/{projectID\}/locations/{locationID\}/datasets/{datasetID\}/dicomStores/{dicom_store_id\}/dicomWeb/studi/{study_uid\}/series/{series_uid\}/instances/{instance_uid\}` */ referencedResource?: string | null; /** @@ -11771,7 +11771,7 @@ export namespace healthcare_v1beta1 { export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Setblobstoragesettings extends StandardParameters { /** - * Required. The path of the resource to update the blob storage settings in the format of `projects/{projectID\}/datasets/{datasetID\}/dicomStores/{dicomStoreID\}/dicomWeb/studies/{studyUID\}`, `projects/{projectID\}/datasets/{datasetID\}/dicomStores/{dicomStoreID\}/dicomWeb/studies/{studyUID\}/series/{seriesUID\}/`, or `projects/{projectID\}/datasets/{datasetID\}/dicomStores/{dicomStoreID\}/dicomWeb/studies/{studyUID\}/series/{seriesUID\}/instances/{instanceUID\}`. If `filter_config` is specified, set the value of `resource` to the resource name of a DICOM store in the format `projects/{projectID\}/datasets/{datasetID\}/dicomStores/{dicomStoreID\}`. + * Required. The path of the resource to update the blob storage settings in the format of `projects/{projectID\}/locations/{locationID\}/datasets/{datasetID\}/dicomStores/{dicomStoreID\}/dicomWeb/studies/{studyUID\}`, `projects/{projectID\}/locations/{locationID\}/datasets/{datasetID\}/dicomStores/{dicomStoreID\}/dicomWeb/studies/{studyUID\}/series/{seriesUID\}/`, or `projects/{projectID\}/locations/{locationID\}/datasets/{datasetID\}/dicomStores/{dicomStoreID\}/dicomWeb/studies/{studyUID\}/series/{seriesUID\}/instances/{instanceUID\}`. If `filter_config` is specified, set the value of `resource` to the resource name of a DICOM store in the format `projects/{projectID\}/locations/{locationID\}/datasets/{datasetID\}/dicomStores/{dicomStoreID\}`. */ resource?: string; @@ -12032,7 +12032,7 @@ export namespace healthcare_v1beta1 { export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Setblobstoragesettings extends StandardParameters { /** - * Required. The path of the resource to update the blob storage settings in the format of `projects/{projectID\}/datasets/{datasetID\}/dicomStores/{dicomStoreID\}/dicomWeb/studies/{studyUID\}`, `projects/{projectID\}/datasets/{datasetID\}/dicomStores/{dicomStoreID\}/dicomWeb/studies/{studyUID\}/series/{seriesUID\}/`, or `projects/{projectID\}/datasets/{datasetID\}/dicomStores/{dicomStoreID\}/dicomWeb/studies/{studyUID\}/series/{seriesUID\}/instances/{instanceUID\}`. If `filter_config` is specified, set the value of `resource` to the resource name of a DICOM store in the format `projects/{projectID\}/datasets/{datasetID\}/dicomStores/{dicomStoreID\}`. + * Required. The path of the resource to update the blob storage settings in the format of `projects/{projectID\}/locations/{locationID\}/datasets/{datasetID\}/dicomStores/{dicomStoreID\}/dicomWeb/studies/{studyUID\}`, `projects/{projectID\}/locations/{locationID\}/datasets/{datasetID\}/dicomStores/{dicomStoreID\}/dicomWeb/studies/{studyUID\}/series/{seriesUID\}/`, or `projects/{projectID\}/locations/{locationID\}/datasets/{datasetID\}/dicomStores/{dicomStoreID\}/dicomWeb/studies/{studyUID\}/series/{seriesUID\}/instances/{instanceUID\}`. If `filter_config` is specified, set the value of `resource` to the resource name of a DICOM store in the format `projects/{projectID\}/locations/{locationID\}/datasets/{datasetID\}/dicomStores/{dicomStoreID\}`. */ resource?: string; @@ -12250,7 +12250,7 @@ export namespace healthcare_v1beta1 { export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Instances$Getstorageinfo extends StandardParameters { /** - * Required. The path of the resource for which the storage info is requested (for exaxmple for a DICOM Instance: `projects/{projectid\}/datasets/{datasetid\}/dicomStores/{dicomStoreId\}/dicomWeb/studies/{study_uid\}/series/{series_uid\}/instances/{instance_uid\}`) + * Required. The path of the resource for which the storage info is requested (for exaxmple for a DICOM Instance: `projects/{projectID\}/locations/{locationID\}/datasets/{datasetID\}/dicomStores/{dicomStoreId\}/dicomWeb/studies/{study_uid\}/series/{series_uid\}/instances/{instance_uid\}`) */ resource?: string; } diff --git a/src/apis/iam/v1.ts b/src/apis/iam/v1.ts index 449089e67e..ad2ecf1349 100644 --- a/src/apis/iam/v1.ts +++ b/src/apis/iam/v1.ts @@ -102,7 +102,7 @@ export namespace iam_v1 { /** * Identity and Access Management (IAM) API * - * Manages identity and access control for Google Cloud Platform resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls. + * Manages identity and access control for Google Cloud resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls. Enabling this API also enables the IAM Service Account Credentials API (iamcredentials.googleapis.com). However, disabling this API doesn't disable the IAM Service Account Credentials API. * * @example * ```js @@ -845,6 +845,19 @@ export namespace iam_v1 { */ permissions?: Schema$Permission[]; } + /** + * Operation metadata returned by the CLH during resource state reconciliation. + */ + export interface Schema$ReconciliationOperationMetadata { + /** + * DEPRECATED. Use exclusive_action instead. + */ + deleteResource?: boolean | null; + /** + * Excluisive action returned by the CLH. + */ + exclusiveAction?: string | null; + } /** * A role in the Identity and Access Management API. */ @@ -866,7 +879,7 @@ export namespace iam_v1 { */ includedPermissions?: string[] | null; /** - * The name of the role. When `Role` is used in `CreateRole`, the role name must not be set. When `Role` is used in output and other input such as `UpdateRole`, the role name is the complete path. For example, `roles/logging.viewer` for predefined roles, `organizations/{ORGANIZATION_ID\}/roles/my-role` for organization-level custom roles, and `projects/{PROJECT_ID\}/roles/my-role` for project-level custom roles. + * The name of the role. When `Role` is used in `CreateRole`, the role name must not be set. When `Role` is used in output and other input such as `UpdateRole`, the role name is the complete path. For example, `roles/logging.viewer` for predefined roles, `organizations/{ORGANIZATION_ID\}/roles/myRole` for organization-level custom roles, and `projects/{PROJECT_ID\}/roles/myRole` for project-level custom roles. */ name?: string | null; /** @@ -883,7 +896,7 @@ export namespace iam_v1 { */ export interface Schema$Saml { /** - * Required. SAML Identity provider configuration metadata xml doc. The xml document should comply with [SAML 2.0 specification](https://www.oasis-open.org/committees/download.php/56785/sstc-saml-metadata-errata-2.0-wd-05.pdf). The max size of the acceptable xml document will be bounded to 128k characters. The metadata xml document should satisfy the following constraints: 1) Must contain an Identity Provider Entity ID. 2) Must contain at least one non-expired signing key certificate. 3) For each signing key: a) Valid from should be no more than 7 days from now. b) Valid to should be no more than 15 years in the future. 4) Upto 3 IdP signing keys are allowed in the metadata xml. When updating the provider's metadata xml, at lease one non-expired signing key must overlap with the existing metadata. This requirement is skipped if there are no non-expired signing keys present in the existing metadata + * Required. SAML identity provider (IdP) configuration metadata XML doc. The XML document must comply with the [SAML 2.0 specification](https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf). The maximum size of an acceptable XML document is 128K characters. The SAML metadata XML document must satisfy the following constraints: * Must contain an IdP Entity ID. * Must contain at least one non-expired signing certificate. * For each signing certificate, the expiration must be: * From no more than 7 days in the future. * To no more than 15 years in the future. * Up to three IdP signing keys are allowed. When updating the provider's metadata XML, at least one non-expired signing key must overlap with the existing metadata. This requirement is skipped if there are no non-expired signing keys present in the existing metadata. */ idpMetadataXml?: string | null; } @@ -1180,7 +1193,7 @@ export namespace iam_v1 { */ attributeCondition?: string | null; /** - * Required. Maps attributes from the authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.groups`: Groups the authenticating user belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. * `google.display_name`: The name of the authenticated user. This is an optional field and the mapped display name cannot exceed 100 bytes. If not set, `google.subject` will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.profile_photo`: The URL that specifies the authenticated user's thumbnail photo. This is an optional field. When set, the image will be visible as the user's profile picture. If not set, a generic user icon will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.posix_username`: The linux username used by OS login. This is an optional field and the mapped posix username cannot exceed 32 characters, The key must match the regex "^a-zA-Z0-9._{0,31\}$". This attribute cannot be referenced in IAM bindings. You can also provide custom attributes by specifying `attribute.{custom_attribute\}`, where {custom_attribute\} is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workforce pool to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/locations/global/workforcePools/{pool\}/subject/{value\}` * `google.groups`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool\}/group/{value\}` * `attribute.{custom_attribute\}`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool\}/attribute.{custom_attribute\}/{value\}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 4KB. For OIDC providers, you must supply a custom mapping that includes the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {"google.subject": "assertion.sub"\} ``` + * Required. Maps attributes from the authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.groups`: Groups the authenticating user belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. * `google.display_name`: The name of the authenticated user. This is an optional field and the mapped display name cannot exceed 100 bytes. If not set, `google.subject` will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.profile_photo`: The URL that specifies the authenticated user's thumbnail photo. This is an optional field. When set, the image will be visible as the user's profile picture. If not set, a generic user icon will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.posix_username`: The Linux username used by OS Login. This is an optional field and the mapped POSIX username cannot exceed 32 characters, The key must match the regex "^a-zA-Z0-9._{0,31\}$". This attribute cannot be referenced in IAM bindings. You can also provide custom attributes by specifying `attribute.{custom_attribute\}`, where {custom_attribute\} is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workforce pool to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/locations/global/workforcePools/{pool\}/subject/{value\}` * `google.groups`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool\}/group/{value\}` * `attribute.{custom_attribute\}`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool\}/attribute.{custom_attribute\}/{value\}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 4KB. For OIDC providers, you must supply a custom mapping that includes the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {"google.subject": "assertion.sub"\} ``` */ attributeMapping?: {[key: string]: string} | null; /** @@ -1322,6 +1335,10 @@ export namespace iam_v1 { * Output only. The state of the provider. */ state?: string | null; + /** + * An X.509-type identity provider. + */ + x509?: Schema$X509; } /** * Represents a public key configuration for your workload identity pool provider. The key can be configured in your identity provider to encrypt the SAML assertions. Google holds the corresponding private key which it uses to decrypt encrypted tokens. @@ -1348,6 +1365,10 @@ export namespace iam_v1 { */ use?: string | null; } + /** + * An X.509-type identity provider represents a CA. It is trusted to assert a client identity if the client has a certificate that chains up to this CA. + */ + export interface Schema$X509 {} export class Resource$Iampolicies { context: APIRequestContext; diff --git a/src/apis/iam/v2.ts b/src/apis/iam/v2.ts index 083f8bc7b0..dfdaeb32eb 100644 --- a/src/apis/iam/v2.ts +++ b/src/apis/iam/v2.ts @@ -102,7 +102,7 @@ export namespace iam_v2 { /** * Identity and Access Management (IAM) API * - * Manages identity and access control for Google Cloud Platform resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls. + * Manages identity and access control for Google Cloud resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls. Enabling this API also enables the IAM Service Account Credentials API (iamcredentials.googleapis.com). However, disabling this API doesn't disable the IAM Service Account Credentials API. * * @example * ```js @@ -124,6 +124,19 @@ export namespace iam_v2 { } } + /** + * Operation metadata returned by the CLH during resource state reconciliation. + */ + export interface Schema$CloudControl2SharedOperationsReconciliationOperationMetadata { + /** + * DEPRECATED. Use exclusive_action instead. + */ + deleteResource?: boolean | null; + /** + * Excluisive action returned by the CLH. + */ + exclusiveAction?: string | null; + } /** * Represents the metadata of the long-running operation. */ diff --git a/src/apis/iam/v2beta.ts b/src/apis/iam/v2beta.ts index 73b2d7fd3d..9b6aacbd3a 100644 --- a/src/apis/iam/v2beta.ts +++ b/src/apis/iam/v2beta.ts @@ -102,7 +102,7 @@ export namespace iam_v2beta { /** * Identity and Access Management (IAM) API * - * Manages identity and access control for Google Cloud Platform resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls. + * Manages identity and access control for Google Cloud resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls. Enabling this API also enables the IAM Service Account Credentials API (iamcredentials.googleapis.com). However, disabling this API doesn't disable the IAM Service Account Credentials API. * * @example * ```js @@ -124,6 +124,19 @@ export namespace iam_v2beta { } } + /** + * Operation metadata returned by the CLH during resource state reconciliation. + */ + export interface Schema$CloudControl2SharedOperationsReconciliationOperationMetadata { + /** + * DEPRECATED. Use exclusive_action instead. + */ + deleteResource?: boolean | null; + /** + * Excluisive action returned by the CLH. + */ + exclusiveAction?: string | null; + } /** * Represents the metadata of the long-running operation. */ diff --git a/src/apis/iap/v1.ts b/src/apis/iap/v1.ts index 3f56889e44..bd26b07db2 100644 --- a/src/apis/iap/v1.ts +++ b/src/apis/iap/v1.ts @@ -2372,7 +2372,7 @@ export namespace iap_v1 { } /** - * Validates a given CEL expression conforms to IAP restrictions. + * Validates that a given CEL expression conforms to IAP restrictions. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2528,7 +2528,7 @@ export namespace iap_v1 { export interface Params$Resource$V1$Validateattributeexpression extends StandardParameters { /** - * Required. User input string expression. Should be of the form 'attributes.saml_attributes.filter(attribute, attribute.name in ['{attribute_name\}', '{attribute_name\}'])' + * Required. User input string expression. Should be of the form `attributes.saml_attributes.filter(attribute, attribute.name in ['{attribute_name\}', '{attribute_name\}'])` */ expression?: string; /** diff --git a/src/apis/identitytoolkit/v2.ts b/src/apis/identitytoolkit/v2.ts index 5681fa4416..8e1bba8c3a 100644 --- a/src/apis/identitytoolkit/v2.ts +++ b/src/apis/identitytoolkit/v2.ts @@ -836,7 +836,7 @@ export namespace identitytoolkit_v2 { */ managedRules?: Schema$GoogleCloudIdentitytoolkitAdminV2RecaptchaManagedRule[]; /** - * Output only. The reCAPTCHA keys. + * The reCAPTCHA keys. */ recaptchaKeys?: Schema$GoogleCloudIdentitytoolkitAdminV2RecaptchaKey[]; /** diff --git a/src/apis/logging/v2.ts b/src/apis/logging/v2.ts index a945f7aa9c..b3fbf0aa4c 100644 --- a/src/apis/logging/v2.ts +++ b/src/apis/logging/v2.ts @@ -1138,6 +1138,10 @@ export namespace logging_v2 { * Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink's parent resource are available for export. If the field is true, then log entries from all the projects, folders, and billing accounts contained in the sink's parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink's filter expression.For example, if this field is true, then the filter resource.type=gce_instance would export all Compute Engine VM instance log entries from all projects in the sink's parent.To only export entries from certain child projects, filter on the project part of the log name:logName:("projects/test-project1/" OR "projects/test-project2/") AND resource.type=gce_instance */ includeChildren?: boolean | null; + /** + * Optional. This field applies only to sinks owned by organizations and folders.When the value of 'intercept_children' is true, the following restrictions apply: The sink must have the include_children flag set to true. The sink destination must be a Cloud project.Also, the following behaviors apply: Any logs matched by the sink won't be included by non-_Required sinks owned by child resources. The sink appears in the results of a ListSinks call from a child resource if the value of the filter field in its request is either 'in_scope("ALL")' or 'in_scope("ANCESTOR")'. + */ + interceptChildren?: boolean | null; /** * Output only. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub".Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, periods.First character has to be alphanumeric. */ @@ -1146,6 +1150,10 @@ export namespace logging_v2 { * Deprecated. This field is unused. */ outputVersionFormat?: string | null; + /** + * Output only. The resource name of the sink. "projects/[PROJECT_ID]/sinks/[SINK_NAME] "organizations/[ORGANIZATION_ID]/sinks/[SINK_NAME] "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_NAME] "folders/[FOLDER_ID]/sinks/[SINK_NAME] For example: projects/my_project/sinks/SINK_NAME + */ + resourceName?: string | null; /** * Output only. The last update timestamp of the sink.This field may not be present for older sinks. */ @@ -5995,6 +6003,10 @@ export namespace logging_v2 { } export interface Params$Resource$Billingaccounts$Sinks$List extends StandardParameters { + /** + * Optional. A filter expression to constrain the sinks returned. Today, this only supports the following strings: '' 'in_scope("ALL")', 'in_scope("ANCESTOR")', 'in_scope("DEFAULT")'.Description of scopes below. ALL: Includes all of the sinks which can be returned in any other scope. ANCESTOR: Includes intercepting sinks owned by ancestor resources. DEFAULT: Includes sinks owned by parent.When the empty string is provided, then the filter 'in_scope("DEFAULT")' is applied. + */ + filter?: string; /** * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ @@ -11260,6 +11272,10 @@ export namespace logging_v2 { } export interface Params$Resource$Folders$Sinks$List extends StandardParameters { + /** + * Optional. A filter expression to constrain the sinks returned. Today, this only supports the following strings: '' 'in_scope("ALL")', 'in_scope("ANCESTOR")', 'in_scope("DEFAULT")'.Description of scopes below. ALL: Includes all of the sinks which can be returned in any other scope. ANCESTOR: Includes intercepting sinks owned by ancestor resources. DEFAULT: Includes sinks owned by parent.When the empty string is provided, then the filter 'in_scope("DEFAULT")' is applied. + */ + filter?: string; /** * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ @@ -18315,6 +18331,10 @@ export namespace logging_v2 { } export interface Params$Resource$Organizations$Sinks$List extends StandardParameters { + /** + * Optional. A filter expression to constrain the sinks returned. Today, this only supports the following strings: '' 'in_scope("ALL")', 'in_scope("ANCESTOR")', 'in_scope("DEFAULT")'.Description of scopes below. ALL: Includes all of the sinks which can be returned in any other scope. ANCESTOR: Includes intercepting sinks owned by ancestor resources. DEFAULT: Includes sinks owned by parent.When the empty string is provided, then the filter 'in_scope("DEFAULT")' is applied. + */ + filter?: string; /** * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ @@ -23104,6 +23124,10 @@ export namespace logging_v2 { } export interface Params$Resource$Projects$Sinks$List extends StandardParameters { + /** + * Optional. A filter expression to constrain the sinks returned. Today, this only supports the following strings: '' 'in_scope("ALL")', 'in_scope("ANCESTOR")', 'in_scope("DEFAULT")'.Description of scopes below. ALL: Includes all of the sinks which can be returned in any other scope. ANCESTOR: Includes intercepting sinks owned by ancestor resources. DEFAULT: Includes sinks owned by parent.When the empty string is provided, then the filter 'in_scope("DEFAULT")' is applied. + */ + filter?: string; /** * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ @@ -23629,6 +23653,10 @@ export namespace logging_v2 { sinkName?: string; } export interface Params$Resource$Sinks$List extends StandardParameters { + /** + * Optional. A filter expression to constrain the sinks returned. Today, this only supports the following strings: '' 'in_scope("ALL")', 'in_scope("ANCESTOR")', 'in_scope("DEFAULT")'.Description of scopes below. ALL: Includes all of the sinks which can be returned in any other scope. ANCESTOR: Includes intercepting sinks owned by ancestor resources. DEFAULT: Includes sinks owned by parent.When the empty string is provided, then the filter 'in_scope("DEFAULT")' is applied. + */ + filter?: string; /** * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ diff --git a/src/apis/marketingplatformadmin/README.md b/src/apis/marketingplatformadmin/README.md index 49afcda767..5d622ec85f 100644 --- a/src/apis/marketingplatformadmin/README.md +++ b/src/apis/marketingplatformadmin/README.md @@ -2,7 +2,7 @@ # marketingplatformadmin -> marketingplatformadmin.googleapis.com API. +> The Google Marketing Platform Admin API allows for programmatic access to the Google Marketing Platform configuration data. You can use the Google Marketing Platform Admin API to manage links between your Google Marketing Platform organization and Google Analytics accounts, set the service level of your GA4 properties. ## Installation diff --git a/src/apis/memcache/v1.ts b/src/apis/memcache/v1.ts index eb4a26069e..d34abf7a21 100644 --- a/src/apis/memcache/v1.ts +++ b/src/apis/memcache/v1.ts @@ -641,7 +641,7 @@ export namespace memcache_v1 { availableZones?: {[key: string]: Schema$ZoneMetadata} | null; } /** - * LINT.IfChange Defines policies to service maintenance events. + * Defines policies to service maintenance events. */ export interface Schema$MaintenancePolicy { /** diff --git a/src/apis/memcache/v1beta2.ts b/src/apis/memcache/v1beta2.ts index bdb4c42282..630fde14d0 100644 --- a/src/apis/memcache/v1beta2.ts +++ b/src/apis/memcache/v1beta2.ts @@ -658,7 +658,7 @@ export namespace memcache_v1beta2 { availableZones?: {[key: string]: Schema$ZoneMetadata} | null; } /** - * LINT.IfChange Defines policies to service maintenance events. + * Defines policies to service maintenance events. */ export interface Schema$MaintenancePolicy { /** diff --git a/src/apis/metastore/v1.ts b/src/apis/metastore/v1.ts index a399dc76fd..f6d066b589 100644 --- a/src/apis/metastore/v1.ts +++ b/src/apis/metastore/v1.ts @@ -2573,7 +2573,6 @@ export namespace metastore_v1 { context: APIRequestContext; backups: Resource$Projects$Locations$Services$Backups; metadataImports: Resource$Projects$Locations$Services$Metadataimports; - migrationExecutions: Resource$Projects$Locations$Services$Migrationexecutions; constructor(context: APIRequestContext) { this.context = context; this.backups = new Resource$Projects$Locations$Services$Backups( @@ -2581,10 +2580,6 @@ export namespace metastore_v1 { ); this.metadataImports = new Resource$Projects$Locations$Services$Metadataimports(this.context); - this.migrationExecutions = - new Resource$Projects$Locations$Services$Migrationexecutions( - this.context - ); } /** @@ -5051,108 +5046,4 @@ export namespace metastore_v1 { */ requestBody?: Schema$MetadataImport; } - - export class Resource$Projects$Locations$Services$Migrationexecutions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Deletes a single migration execution. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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$Services$Migrationexecutions$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Services$Migrationexecutions$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Services$Migrationexecutions$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Services$Migrationexecutions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Services$Migrationexecutions$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Services$Migrationexecutions$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Services$Migrationexecutions$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Services$Migrationexecutions$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://metastore.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - 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$Services$Migrationexecutions$Delete - extends StandardParameters { - /** - * Required. The relative resource name of the migrationExecution to delete, in the following form:projects/{project_number\}/locations/{location_id\}/services/{service_id\}/migrationExecutions/{migration_execution_id\}. - */ - name?: string; - /** - * Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. - */ - requestId?: string; - } } diff --git a/src/apis/metastore/v1alpha.ts b/src/apis/metastore/v1alpha.ts index 9ddd3f1f71..7d01a2a482 100644 --- a/src/apis/metastore/v1alpha.ts +++ b/src/apis/metastore/v1alpha.ts @@ -2621,7 +2621,6 @@ export namespace metastore_v1alpha { backups: Resource$Projects$Locations$Services$Backups; databases: Resource$Projects$Locations$Services$Databases; metadataImports: Resource$Projects$Locations$Services$Metadataimports; - migrationExecutions: Resource$Projects$Locations$Services$Migrationexecutions; constructor(context: APIRequestContext) { this.context = context; this.backups = new Resource$Projects$Locations$Services$Backups( @@ -2632,10 +2631,6 @@ export namespace metastore_v1alpha { ); this.metadataImports = new Resource$Projects$Locations$Services$Metadataimports(this.context); - this.migrationExecutions = - new Resource$Projects$Locations$Services$Migrationexecutions( - this.context - ); } /** @@ -5948,108 +5943,4 @@ export namespace metastore_v1alpha { */ requestBody?: Schema$MetadataImport; } - - export class Resource$Projects$Locations$Services$Migrationexecutions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Deletes a single migration execution. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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$Services$Migrationexecutions$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Services$Migrationexecutions$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Services$Migrationexecutions$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Services$Migrationexecutions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Services$Migrationexecutions$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Services$Migrationexecutions$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Services$Migrationexecutions$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Services$Migrationexecutions$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://metastore.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - 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$Services$Migrationexecutions$Delete - extends StandardParameters { - /** - * Required. The relative resource name of the migrationExecution to delete, in the following form:projects/{project_number\}/locations/{location_id\}/services/{service_id\}/migrationExecutions/{migration_execution_id\}. - */ - name?: string; - /** - * Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. - */ - requestId?: string; - } } diff --git a/src/apis/metastore/v1beta.ts b/src/apis/metastore/v1beta.ts index e7ba2d3bf4..1233acf221 100644 --- a/src/apis/metastore/v1beta.ts +++ b/src/apis/metastore/v1beta.ts @@ -2621,7 +2621,6 @@ export namespace metastore_v1beta { backups: Resource$Projects$Locations$Services$Backups; databases: Resource$Projects$Locations$Services$Databases; metadataImports: Resource$Projects$Locations$Services$Metadataimports; - migrationExecutions: Resource$Projects$Locations$Services$Migrationexecutions; constructor(context: APIRequestContext) { this.context = context; this.backups = new Resource$Projects$Locations$Services$Backups( @@ -2632,10 +2631,6 @@ export namespace metastore_v1beta { ); this.metadataImports = new Resource$Projects$Locations$Services$Metadataimports(this.context); - this.migrationExecutions = - new Resource$Projects$Locations$Services$Migrationexecutions( - this.context - ); } /** @@ -5948,108 +5943,4 @@ export namespace metastore_v1beta { */ requestBody?: Schema$MetadataImport; } - - export class Resource$Projects$Locations$Services$Migrationexecutions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Deletes a single migration execution. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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$Services$Migrationexecutions$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Services$Migrationexecutions$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Services$Migrationexecutions$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Services$Migrationexecutions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Services$Migrationexecutions$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Services$Migrationexecutions$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Services$Migrationexecutions$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Services$Migrationexecutions$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://metastore.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - 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$Services$Migrationexecutions$Delete - extends StandardParameters { - /** - * Required. The relative resource name of the migrationExecution to delete, in the following form:projects/{project_number\}/locations/{location_id\}/services/{service_id\}/migrationExecutions/{migration_execution_id\}. - */ - name?: string; - /** - * Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. - */ - requestId?: string; - } } diff --git a/src/apis/networkmanagement/v1.ts b/src/apis/networkmanagement/v1.ts index d8c46f55d3..ad55e91837 100644 --- a/src/apis/networkmanagement/v1.ts +++ b/src/apis/networkmanagement/v1.ts @@ -315,6 +315,10 @@ export namespace networkmanagement_v1 { * A Connectivity Test for a network reachability analysis. */ export interface Schema$ConnectivityTest { + /** + * Whether the test should skip firewall checking. If not provided, we assume false. + */ + bypassFirewallChecks?: boolean | null; /** * Output only. The time the test was created. */ diff --git a/src/apis/networkmanagement/v1beta1.ts b/src/apis/networkmanagement/v1beta1.ts index 6e14c74c52..b15056a4f2 100644 --- a/src/apis/networkmanagement/v1beta1.ts +++ b/src/apis/networkmanagement/v1beta1.ts @@ -319,6 +319,10 @@ export namespace networkmanagement_v1beta1 { * A Connectivity Test for a network reachability analysis. */ export interface Schema$ConnectivityTest { + /** + * Whether the test should skip firewall checking. If not provided, we assume false. + */ + bypassFirewallChecks?: boolean | null; /** * Output only. The time the test was created. */ diff --git a/src/apis/networkservices/v1.ts b/src/apis/networkservices/v1.ts index 021120c81c..6dcdf99f87 100644 --- a/src/apis/networkservices/v1.ts +++ b/src/apis/networkservices/v1.ts @@ -335,7 +335,7 @@ export namespace networkservices_v1 { */ export interface Schema$ExtensionChainMatchCondition { /** - * Required. A Common Expression Language (CEL) expression that is used to match requests for which the extension chain is executed. For more information, see [CEL matcher language reference](/service-extensions/docs/cel-matcher-language-reference). + * Required. A Common Expression Language (CEL) expression that is used to match requests for which the extension chain is executed. For more information, see [CEL matcher language reference](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference). */ celExpression?: string | null; } @@ -1076,7 +1076,7 @@ export namespace networkservices_v1 { */ forwardingRules?: string[] | null; /** - * Optional. Set of labels associated with the `LbRouteExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources. + * Optional. Set of labels associated with the `LbRouteExtension` resource. The format must comply with [the requirements for labels](https://cloud.google.com/compute/docs/labeling-resources#requirements) for Google Cloud resources. */ labels?: {[key: string]: string} | null; /** @@ -1113,7 +1113,7 @@ export namespace networkservices_v1 { */ forwardingRules?: string[] | null; /** - * Optional. Set of labels associated with the `LbTrafficExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources. + * Optional. Set of labels associated with the `LbTrafficExtension` resource. The format must comply with [the requirements for labels](https://cloud.google.com/compute/docs/labeling-resources#requirements) for Google Cloud resources. */ labels?: {[key: string]: string} | null; /** diff --git a/src/apis/networkservices/v1beta1.ts b/src/apis/networkservices/v1beta1.ts index 882b396de8..67e58ae9f9 100644 --- a/src/apis/networkservices/v1beta1.ts +++ b/src/apis/networkservices/v1beta1.ts @@ -309,7 +309,7 @@ export namespace networkservices_v1beta1 { */ export interface Schema$ExtensionChainMatchCondition { /** - * Required. A Common Expression Language (CEL) expression that is used to match requests for which the extension chain is executed. For more information, see [CEL matcher language reference](/service-extensions/docs/cel-matcher-language-reference). + * Required. A Common Expression Language (CEL) expression that is used to match requests for which the extension chain is executed. For more information, see [CEL matcher language reference](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference). */ celExpression?: string | null; } @@ -1050,7 +1050,7 @@ export namespace networkservices_v1beta1 { */ forwardingRules?: string[] | null; /** - * Optional. Set of labels associated with the `LbRouteExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources. + * Optional. Set of labels associated with the `LbRouteExtension` resource. The format must comply with [the requirements for labels](https://cloud.google.com/compute/docs/labeling-resources#requirements) for Google Cloud resources. */ labels?: {[key: string]: string} | null; /** @@ -1087,7 +1087,7 @@ export namespace networkservices_v1beta1 { */ forwardingRules?: string[] | null; /** - * Optional. Set of labels associated with the `LbTrafficExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources. + * Optional. Set of labels associated with the `LbTrafficExtension` resource. The format must comply with [the requirements for labels](https://cloud.google.com/compute/docs/labeling-resources#requirements) for Google Cloud resources. */ labels?: {[key: string]: string} | null; /** diff --git a/src/apis/notebooks/v1.ts b/src/apis/notebooks/v1.ts index e8307f1dcb..b5879f9d45 100644 --- a/src/apis/notebooks/v1.ts +++ b/src/apis/notebooks/v1.ts @@ -150,7 +150,7 @@ export namespace notebooks_v1 { */ members?: string[] | null; /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). */ role?: string | null; } @@ -577,7 +577,7 @@ export namespace notebooks_v1 { */ machineType?: string | null; /** - * Custom metadata to apply to this instance. For example, to specify a Cloud Storage bucket for automatic backup, you can use the `gcs-data-bucket` metadata tag. Format: `"--metadata=gcs-data-bucket=``BUCKET''"`. + * Custom metadata to apply to this instance. For example, to specify a Cloud Storage bucket for automatic backup, you can use the `gcs-data-bucket` metadata tag. Format: `"--metadata=gcs-data-bucket=BUCKET"`. */ metadata?: {[key: string]: string} | null; /** diff --git a/src/apis/notebooks/v2.ts b/src/apis/notebooks/v2.ts index 0c4727dac3..4634ef758a 100644 --- a/src/apis/notebooks/v2.ts +++ b/src/apis/notebooks/v2.ts @@ -150,7 +150,7 @@ export namespace notebooks_v2 { */ members?: string[] | null; /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). */ role?: string | null; } diff --git a/src/apis/osconfig/v1.ts b/src/apis/osconfig/v1.ts index b0e517e3ee..105f8034be 100644 --- a/src/apis/osconfig/v1.ts +++ b/src/apis/osconfig/v1.ts @@ -1704,6 +1704,19 @@ export namespace osconfig_v1 { * A request message for pausing a patch deployment. */ export interface Schema$PausePatchDeploymentRequest {} + /** + * ProjectFeatureSettings represents the features settings for the VM Manager. The project features settings can be set for a project. + */ + export interface Schema$ProjectFeatureSettings { + /** + * Required. Immutable. Name of the config, e.g. projects/12345/locations/global/projectFeatureSettings + */ + name?: string | null; + /** + * Currently set PatchAndConfigFeatureSet for name. + */ + patchAndConfigFeatureSet?: string | null; + } /** * Sets the time for recurring patch deployments. */ @@ -2020,16 +2033,233 @@ export namespace osconfig_v1 { export class Resource$Projects$Locations { context: APIRequestContext; + global: Resource$Projects$Locations$Global; instances: Resource$Projects$Locations$Instances; osPolicyAssignments: Resource$Projects$Locations$Ospolicyassignments; constructor(context: APIRequestContext) { this.context = context; + this.global = new Resource$Projects$Locations$Global(this.context); this.instances = new Resource$Projects$Locations$Instances(this.context); this.osPolicyAssignments = new Resource$Projects$Locations$Ospolicyassignments(this.context); } } + export class Resource$Projects$Locations$Global { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * GetProjectFeatureSettings returns the feature settings for a project + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getProjectFeatureSettings( + params: Params$Resource$Projects$Locations$Global$Getprojectfeaturesettings, + options: StreamMethodOptions + ): GaxiosPromise; + getProjectFeatureSettings( + params?: Params$Resource$Projects$Locations$Global$Getprojectfeaturesettings, + options?: MethodOptions + ): GaxiosPromise; + getProjectFeatureSettings( + params: Params$Resource$Projects$Locations$Global$Getprojectfeaturesettings, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getProjectFeatureSettings( + params: Params$Resource$Projects$Locations$Global$Getprojectfeaturesettings, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getProjectFeatureSettings( + params: Params$Resource$Projects$Locations$Global$Getprojectfeaturesettings, + callback: BodyResponseCallback + ): void; + getProjectFeatureSettings( + callback: BodyResponseCallback + ): void; + getProjectFeatureSettings( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Global$Getprojectfeaturesettings + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Global$Getprojectfeaturesettings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Global$Getprojectfeaturesettings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * UpdateProjectFeatureSettings sets the feature settings for a project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + updateProjectFeatureSettings( + params: Params$Resource$Projects$Locations$Global$Updateprojectfeaturesettings, + options: StreamMethodOptions + ): GaxiosPromise; + updateProjectFeatureSettings( + params?: Params$Resource$Projects$Locations$Global$Updateprojectfeaturesettings, + options?: MethodOptions + ): GaxiosPromise; + updateProjectFeatureSettings( + params: Params$Resource$Projects$Locations$Global$Updateprojectfeaturesettings, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateProjectFeatureSettings( + params: Params$Resource$Projects$Locations$Global$Updateprojectfeaturesettings, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateProjectFeatureSettings( + params: Params$Resource$Projects$Locations$Global$Updateprojectfeaturesettings, + callback: BodyResponseCallback + ): void; + updateProjectFeatureSettings( + callback: BodyResponseCallback + ): void; + updateProjectFeatureSettings( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Global$Updateprojectfeaturesettings + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Global$Updateprojectfeaturesettings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Global$Updateprojectfeaturesettings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + 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$Global$Getprojectfeaturesettings + extends StandardParameters { + /** + * Required. Name of the billing config. "projects//locations/global/projectFeatureSettings" + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Global$Updateprojectfeaturesettings + extends StandardParameters { + /** + * Required. Immutable. Name of the config, e.g. projects/12345/locations/global/projectFeatureSettings + */ + name?: string; + /** + * Optional. Field mask that controls which fields of the ProjectFeatureSettings should be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ProjectFeatureSettings; + } + export class Resource$Projects$Locations$Instances { context: APIRequestContext; inventories: Resource$Projects$Locations$Instances$Inventories; diff --git a/src/apis/playintegrity/v1.ts b/src/apis/playintegrity/v1.ts index 942d2c3705..5d7583d313 100644 --- a/src/apis/playintegrity/v1.ts +++ b/src/apis/playintegrity/v1.ts @@ -199,7 +199,7 @@ export namespace playintegrity_v1 { tokenPayloadExternal?: Schema$TokenPayloadExternal; } /** - * Contains the device attestation information. + * Contains the device attestation information. Next tag: 4 */ export interface Schema$DeviceIntegrity { /** diff --git a/src/apis/privateca/v1.ts b/src/apis/privateca/v1.ts index dc1998e8e0..c477b48c97 100644 --- a/src/apis/privateca/v1.ts +++ b/src/apis/privateca/v1.ts @@ -418,7 +418,7 @@ export namespace privateca_v1 { */ export interface Schema$CertificateConfigKeyId { /** - * Optional. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key. + * Required. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key. */ keyId?: string | null; } diff --git a/src/apis/recaptchaenterprise/v1.ts b/src/apis/recaptchaenterprise/v1.ts index 839c2bf106..79d5a39832 100644 --- a/src/apis/recaptchaenterprise/v1.ts +++ b/src/apis/recaptchaenterprise/v1.ts @@ -612,7 +612,7 @@ export namespace recaptchaenterprise_v1 { webSettings?: Schema$GoogleCloudRecaptchaenterpriseV1WebKeySettings; } /** - * Response to request to list firewall policies belonging to a key. + * Response to request to list firewall policies belonging to a project. */ export interface Schema$GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse { /** diff --git a/src/apis/redis/v1.ts b/src/apis/redis/v1.ts index ac3c25114f..14a3648af9 100644 --- a/src/apis/redis/v1.ts +++ b/src/apis/redis/v1.ts @@ -124,6 +124,15 @@ export namespace redis_v1 { } } + /** + * Configuration of the AOF based persistence. + */ + export interface Schema$AOFConfig { + /** + * Optional. fsync configuration. + */ + appendFsync?: string | null; + } /** * Configuration for availability of database instance */ @@ -209,6 +218,10 @@ export namespace redis_v1 { * Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id\}/locations/{location_id\}/clusters/{cluster_id\}` */ name?: string | null; + /** + * Optional. Persistence config (RDB, AOF) for the cluster. + */ + persistenceConfig?: Schema$ClusterPersistenceConfig; /** * Required. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported. */ @@ -217,6 +230,10 @@ export namespace redis_v1 { * Output only. PSC connections for discovery of the cluster topology and accessing the cluster. */ pscConnections?: Schema$PscConnection[]; + /** + * Optional. Key/Value pairs of customer overrides for mutable Redis Configs + */ + redisConfigs?: {[key: string]: string} | null; /** * Optional. The number of replica nodes per shard. */ @@ -246,6 +263,23 @@ export namespace redis_v1 { */ uid?: string | null; } + /** + * Configuration of the persistence functionality. + */ + export interface Schema$ClusterPersistenceConfig { + /** + * Optional. AOF configuration. This field will be ignored if mode is not AOF. + */ + aofConfig?: Schema$AOFConfig; + /** + * Optional. The mode of persistence. + */ + mode?: string | null; + /** + * Optional. RDB configuration. This field will be ignored if mode is not RDB. + */ + rdbConfig?: Schema$RDBConfig; + } /** * Contains compliance information about a security standard indicating unmet recommendations. */ @@ -1090,6 +1124,19 @@ export namespace redis_v1 { */ pscConnectionId?: string | null; } + /** + * Configuration of the RDB based persistence. + */ + export interface Schema$RDBConfig { + /** + * Optional. Period between RDB snapshots. + */ + rdbSnapshotPeriod?: string | null; + /** + * Optional. The time that the first snapshot was/will be attempted, and to which future snapshots will be aligned. If not provided, the current time will be used. + */ + rdbSnapshotStartTime?: string | null; + } /** * Operation metadata returned by the CLH during resource state reconciliation. */ diff --git a/src/apis/retail/v2.ts b/src/apis/retail/v2.ts index ead4a600c3..793830809d 100644 --- a/src/apis/retail/v2.ts +++ b/src/apis/retail/v2.ts @@ -1824,7 +1824,7 @@ export namespace retail_v2 { */ export interface Schema$GoogleCloudRetailV2ExperimentInfoServingConfigExperiment { /** - * The fully qualified resource name of the serving config VariantArm.serving_config_id responsible for generating the search response. For example: `projects/x/locations/x/catalogs/x/servingConfigs/x`. + * The fully qualified resource name of the serving config Experiment.VariantArm.serving_config_id responsible for generating the search response. For example: `projects/x/locations/x/catalogs/x/servingConfigs/x`. */ experimentServingConfig?: string | null; /** diff --git a/src/apis/retail/v2alpha.ts b/src/apis/retail/v2alpha.ts index 9cbbf5df5f..74d9cb02d1 100644 --- a/src/apis/retail/v2alpha.ts +++ b/src/apis/retail/v2alpha.ts @@ -934,7 +934,7 @@ export namespace retail_v2alpha { */ export interface Schema$GoogleCloudRetailV2alphaExperimentInfoServingConfigExperiment { /** - * The fully qualified resource name of the serving config VariantArm.serving_config_id responsible for generating the search response. For example: `projects/x/locations/x/catalogs/x/servingConfigs/x`. + * The fully qualified resource name of the serving config Experiment.VariantArm.serving_config_id responsible for generating the search response. For example: `projects/x/locations/x/catalogs/x/servingConfigs/x`. */ experimentServingConfig?: string | null; /** @@ -4766,7 +4766,7 @@ export namespace retail_v2alpha { */ name?: string; /** - * Indicates which fields in the provided LoggingConfig to update. The following are the only supported fields: * default_log_generation_rule * per_service_log_generation_rules If not set, all supported fields are updated. + * Indicates which fields in the provided LoggingConfig to update. The following are the only supported fields: * LoggingConfig.default_log_generation_rule * LoggingConfig.per_service_log_generation_rules 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 243cc9d896..41713b8cbc 100644 --- a/src/apis/retail/v2beta.ts +++ b/src/apis/retail/v2beta.ts @@ -1404,7 +1404,7 @@ export namespace retail_v2beta { */ export interface Schema$GoogleCloudRetailV2betaExperimentInfoServingConfigExperiment { /** - * The fully qualified resource name of the serving config VariantArm.serving_config_id responsible for generating the search response. For example: `projects/x/locations/x/catalogs/x/servingConfigs/x`. + * The fully qualified resource name of the serving config Experiment.VariantArm.serving_config_id responsible for generating the search response. For example: `projects/x/locations/x/catalogs/x/servingConfigs/x`. */ experimentServingConfig?: string | null; /** diff --git a/src/apis/run/v1.ts b/src/apis/run/v1.ts index 7a03b9211d..d3caecbcdf 100644 --- a/src/apis/run/v1.ts +++ b/src/apis/run/v1.ts @@ -2496,7 +2496,7 @@ export namespace run_v1 { */ kind?: string | null; /** - * Metadata associated with this Service, including name, namespace, labels, and annotations. 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. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. + * Metadata associated with this Service, including name, namespace, labels, and annotations. 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. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. */ metadata?: Schema$ObjectMeta; /** diff --git a/src/apis/run/v2.ts b/src/apis/run/v2.ts index 9ad9d7d577..6a9931178e 100644 --- a/src/apis/run/v2.ts +++ b/src/apis/run/v2.ts @@ -5414,6 +5414,10 @@ export namespace run_v2 { * The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id. Format: projects/{project\}/locations/{location\}/services/{service_id\} */ name?: string; + /** + * Optional. The list of fields to be updated. + */ + updateMask?: string; /** * Indicates that the request should be validated and default values populated, without persisting the request or updating any resources. */ diff --git a/src/apis/serviceconsumermanagement/v1beta1.ts b/src/apis/serviceconsumermanagement/v1beta1.ts index 75d46e39ab..e8a8ebb35c 100644 --- a/src/apis/serviceconsumermanagement/v1beta1.ts +++ b/src/apis/serviceconsumermanagement/v1beta1.ts @@ -1699,11 +1699,11 @@ export namespace serviceconsumermanagement_v1beta1 { */ export interface Schema$V1Beta1ImportProducerOverridesRequest { /** - * Whether to force the creation of the quota overrides. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. + * Whether to force the creation of the quota overrides. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. If force is set to true, it is recommended to include a case id in "X-Goog-Request-Reason" header when sending the request. */ force?: boolean | null; /** - * The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. + * The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. If force_only is specified, it is recommended to include a case id in "X-Goog-Request-Reason" header when sending the request. */ forceOnly?: string[] | null; /** @@ -2845,11 +2845,11 @@ export namespace serviceconsumermanagement_v1beta1 { export interface Params$Resource$Services$Consumerquotametrics$Limits$Produceroverrides$Create extends StandardParameters { /** - * Whether to force the creation of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. + * Whether to force the creation of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. If force is set to true, it is recommended to include a case id in "X-Goog-Request-Reason" header when sending the request. */ force?: boolean; /** - * The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. + * The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. If force_only is specified, it is recommended to include a case id in "X-Goog-Request-Reason" header when sending the request. */ forceOnly?: string[]; /** @@ -2865,11 +2865,11 @@ export namespace serviceconsumermanagement_v1beta1 { export interface Params$Resource$Services$Consumerquotametrics$Limits$Produceroverrides$Delete extends StandardParameters { /** - * Whether to force the deletion of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. + * Whether to force the deletion of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. If force is set to true, it is recommended to include a case id in "X-Goog-Request-Reason" header when sending the request. */ force?: boolean; /** - * The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. + * The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. If force_only is specified, it is recommended to include a case id in "X-Goog-Request-Reason" header when sending the request. */ forceOnly?: string[]; /** @@ -2895,11 +2895,11 @@ export namespace serviceconsumermanagement_v1beta1 { export interface Params$Resource$Services$Consumerquotametrics$Limits$Produceroverrides$Patch extends StandardParameters { /** - * Whether to force the update of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. + * Whether to force the update of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. If force is set to true, it is recommended to include a case id in "X-Goog-Request-Reason" header when sending the request. */ force?: boolean; /** - * The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. + * The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. If force_only is specified, it is recommended to include a case id in "X-Goog-Request-Reason" header when sending the request. */ forceOnly?: string[]; /** diff --git a/src/apis/serviceusage/v1beta1.ts b/src/apis/serviceusage/v1beta1.ts index 911a6eccba..911b69170f 100644 --- a/src/apis/serviceusage/v1beta1.ts +++ b/src/apis/serviceusage/v1beta1.ts @@ -1275,11 +1275,11 @@ export namespace serviceusage_v1beta1 { */ export interface Schema$ImportAdminOverridesRequest { /** - * Whether to force the creation of the quota overrides. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. + * Whether to force the creation of the quota overrides. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. If force is set to true, it is recommended to include a case id in "X-Goog-Request-Reason" header when sending the request. */ force?: boolean | null; /** - * The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. + * The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. If force_only is specified, it is recommended to include a case id in "X-Goog-Request-Reason" header when sending the request. */ forceOnly?: string[] | null; /** @@ -1318,11 +1318,11 @@ export namespace serviceusage_v1beta1 { */ export interface Schema$ImportConsumerOverridesRequest { /** - * Whether to force the creation of the quota overrides. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. + * Whether to force the creation of the quota overrides. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. If force is set to true, it is recommended to include a case id in "X-Goog-Request-Reason" header when sending the request. */ force?: boolean | null; /** - * The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. + * The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. If force_only is specified, it is recommended to include a case id in "X-Goog-Request-Reason" header when sending the request. */ forceOnly?: string[] | null; /** @@ -4024,11 +4024,11 @@ export namespace serviceusage_v1beta1 { export interface Params$Resource$Services$Consumerquotametrics$Limits$Adminoverrides$Create extends StandardParameters { /** - * Whether to force the creation of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. + * Whether to force the creation of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. If force is set to true, it is recommended to include a case id in "X-Goog-Request-Reason" header when sending the request. */ force?: boolean; /** - * The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. + * The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. If force_only is specified, it is recommended to include a case id in "X-Goog-Request-Reason" header when sending the request. */ forceOnly?: string[]; /** @@ -4044,11 +4044,11 @@ export namespace serviceusage_v1beta1 { export interface Params$Resource$Services$Consumerquotametrics$Limits$Adminoverrides$Delete extends StandardParameters { /** - * Whether to force the deletion of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. + * Whether to force the deletion of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. If force is set to true, it is recommended to include a case id in "X-Goog-Request-Reason" header when sending the request. */ force?: boolean; /** - * The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. + * The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. If force_only is specified, it is recommended to include a case id in "X-Goog-Request-Reason" header when sending the request. */ forceOnly?: string[]; /** @@ -4074,11 +4074,11 @@ export namespace serviceusage_v1beta1 { export interface Params$Resource$Services$Consumerquotametrics$Limits$Adminoverrides$Patch extends StandardParameters { /** - * Whether to force the update of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. + * Whether to force the update of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. If force is set to true, it is recommended to include a case id in "X-Goog-Request-Reason" header when sending the request. */ force?: boolean; /** - * The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. + * The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. If force_only is specified, it is recommended to include a case id in "X-Goog-Request-Reason" header when sending the request. */ forceOnly?: string[]; /** @@ -4461,11 +4461,11 @@ export namespace serviceusage_v1beta1 { export interface Params$Resource$Services$Consumerquotametrics$Limits$Consumeroverrides$Create extends StandardParameters { /** - * Whether to force the creation of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. + * Whether to force the creation of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. If force is set to true, it is recommended to include a case id in "X-Goog-Request-Reason" header when sending the request. */ force?: boolean; /** - * The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. + * The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. If force_only is specified, it is recommended to include a case id in "X-Goog-Request-Reason" header when sending the request. */ forceOnly?: string[]; /** @@ -4481,11 +4481,11 @@ export namespace serviceusage_v1beta1 { export interface Params$Resource$Services$Consumerquotametrics$Limits$Consumeroverrides$Delete extends StandardParameters { /** - * Whether to force the deletion of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. + * Whether to force the deletion of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. If force is set to true, it is recommended to include a case id in "X-Goog-Request-Reason" header when sending the request. */ force?: boolean; /** - * The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. + * The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. If force_only is specified, it is recommended to include a case id in "X-Goog-Request-Reason" header when sending the request. */ forceOnly?: string[]; /** @@ -4511,11 +4511,11 @@ export namespace serviceusage_v1beta1 { export interface Params$Resource$Services$Consumerquotametrics$Limits$Consumeroverrides$Patch extends StandardParameters { /** - * Whether to force the update of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. + * Whether to force the update of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations. If force is set to true, it is recommended to include a case id in "X-Goog-Request-Reason" header when sending the request. */ force?: boolean; /** - * The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. + * The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set. If force_only is specified, it is recommended to include a case id in "X-Goog-Request-Reason" header when sending the request. */ forceOnly?: string[]; /** diff --git a/src/apis/sheets/v4.ts b/src/apis/sheets/v4.ts index 5067c2bc9a..db6244420f 100644 --- a/src/apis/sheets/v4.ts +++ b/src/apis/sheets/v4.ts @@ -4121,6 +4121,10 @@ export namespace sheets_v4 { * The default format of all cells in the spreadsheet. CellData.effectiveFormat will not be set if the cell's format is equal to this default format. This field is read-only. */ defaultFormat?: Schema$CellFormat; + /** + * Whether to allow external url access for image and import functions. Read only when true. When false, you can set to true. + */ + importFunctionsExternalUrlAccessAllowed?: boolean | null; /** * Determines whether and how circular references are resolved with iterative calculation. Absence of this field means that circular references result in calculation errors. */ diff --git a/src/apis/spanner/v1.ts b/src/apis/spanner/v1.ts index 9be1d1663e..9d5c3346ca 100644 --- a/src/apis/spanner/v1.ts +++ b/src/apis/spanner/v1.ts @@ -591,6 +591,40 @@ export namespace spanner_v1 { */ startTime?: string | null; } + /** + * Metadata type for the operation returned by CreateInstancePartition. + */ + export interface Schema$CreateInstancePartitionMetadata { + /** + * The time at which this operation was cancelled. If set, this operation is in the process of undoing itself (which is guaranteed to succeed) and cannot be cancelled again. + */ + cancelTime?: string | null; + /** + * The time at which this operation failed or was completed successfully. + */ + endTime?: string | null; + /** + * The instance partition being created. + */ + instancePartition?: Schema$InstancePartition; + /** + * The time at which the CreateInstancePartition request was received. + */ + startTime?: string | null; + } + /** + * The request for CreateInstancePartition. + */ + export interface Schema$CreateInstancePartitionRequest { + /** + * Required. The instance partition to create. The instance_partition.name may be omitted, but if specified must be `/instancePartitions/`. + */ + instancePartition?: Schema$InstancePartition; + /** + * Required. The ID of the instance partition to create. Valid identifiers are of the form `a-z*[a-z0-9]` and must be between 2 and 64 characters in length. + */ + instancePartitionId?: string | null; + } /** * The request for CreateInstance. */ @@ -1139,6 +1173,55 @@ export namespace spanner_v1 { */ startTime?: string | null; } + /** + * An isolated set of Cloud Spanner resources that databases can define placements on. + */ + export interface Schema$InstancePartition { + /** + * Required. The name of the instance partition's configuration. Values are of the form `projects//instanceConfigs/`. See also InstanceConfig and ListInstanceConfigs. + */ + config?: string | null; + /** + * Output only. The time at which the instance partition was created. + */ + createTime?: string | null; + /** + * Required. The descriptive name for this instance partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length. + */ + displayName?: string | null; + /** + * Used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance partition from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance partition updates in order to avoid race conditions: An etag is returned in the response which contains instance partitions, and systems are expected to put that etag in the request to update instance partitions to ensure that their change will be applied to the same version of the instance partition. If no etag is provided in the call to update instance partition, then the existing instance partition is overwritten blindly. + */ + etag?: string | null; + /** + * Required. A unique identifier for the instance partition. Values are of the form `projects//instances//instancePartitions/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. An instance partition's name cannot be changed after the instance partition is created. + */ + name?: string | null; + /** + * The number of nodes allocated to this instance partition. Users can set the node_count field to specify the target number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. + */ + nodeCount?: number | null; + /** + * The number of processing units allocated to this instance partition. Users can set the processing_units field to specify the target number of processing units allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. + */ + processingUnits?: number | null; + /** + * Output only. The names of the backups that reference this instance partition. Referencing backups should share the parent instance. The existence of any referencing backup prevents the instance partition from being deleted. + */ + referencingBackups?: string[] | null; + /** + * Output only. The names of the databases that reference this instance partition. Referencing databases should share the parent instance. The existence of any referencing database prevents the instance partition from being deleted. + */ + referencingDatabases?: string[] | null; + /** + * Output only. The current instance partition state. + */ + state?: string | null; + /** + * Output only. The time at which the instance partition was most recently updated. + */ + updateTime?: string | null; + } /** * KeyRange represents a range of rows in a table or index. A range has a start key and an end key. These keys can be open or closed, indicating if the range includes rows with that key. Keys are represented by lists, where the ith value in the list corresponds to the ith component of the table or index primary key. Individual values are encoded as described here. For example, consider the following table definition: CREATE TABLE UserEvents ( UserName STRING(MAX), EventDate STRING(10) ) PRIMARY KEY(UserName, EventDate); The following keys name rows in this table: "Bob", "2014-09-23" Since the `UserEvents` table's `PRIMARY KEY` clause names two columns, each `UserEvents` key has two elements; the first is the `UserName`, and the second is the `EventDate`. Key ranges with multiple components are interpreted lexicographically by component using the table or index key's declared sort order. For example, the following range returns all events for user `"Bob"` that occurred in the year 2015: "start_closed": ["Bob", "2015-01-01"] "end_closed": ["Bob", "2015-12-31"] Start and end keys can omit trailing key components. This affects the inclusion and exclusion of rows that exactly match the provided key components: if the key is closed, then rows that exactly match the provided components are included; if the key is open, then rows that exactly match are not included. For example, the following range includes all events for `"Bob"` that occurred during and after the year 2000: "start_closed": ["Bob", "2000-01-01"] "end_closed": ["Bob"] The next example retrieves all events for `"Bob"`: "start_closed": ["Bob"] "end_closed": ["Bob"] To retrieve events before the year 2000: "start_closed": ["Bob"] "end_open": ["Bob", "2000-01-01"] The following range includes all rows in the table: "start_closed": [] "end_closed": [] This range returns all users whose `UserName` begins with any character from A to C: "start_closed": ["A"] "end_open": ["D"] This range returns all users whose `UserName` begins with B: "start_closed": ["B"] "end_open": ["C"] Key ranges honor column sort order. For example, suppose a table is defined as follows: CREATE TABLE DescendingSortedTable { Key INT64, ... ) PRIMARY KEY(Key DESC); The following range retrieves all rows with key values between 1 and 100 inclusive: "start_closed": ["100"] "end_closed": ["1"] Note that 100 is passed as the start, and 1 is passed as the end, because `Key` is a descending column in the schema. */ @@ -1322,6 +1405,40 @@ export namespace spanner_v1 { */ nextPageToken?: string | null; } + /** + * The response for ListInstancePartitionOperations. + */ + export interface Schema$ListInstancePartitionOperationsResponse { + /** + * `next_page_token` can be sent in a subsequent ListInstancePartitionOperations call to fetch more of the matching metadata. + */ + nextPageToken?: string | null; + /** + * The list of matching instance partition long-running operations. Each operation's name will be prefixed by the instance partition's name. The operation's metadata field type `metadata.type_url` describes the type of the metadata. + */ + operations?: Schema$Operation[]; + /** + * The list of unreachable instance partitions. It includes the names of instance partitions whose operation metadata could not be retrieved within instance_partition_deadline. + */ + unreachableInstancePartitions?: string[] | null; + } + /** + * The response for ListInstancePartitions. + */ + export interface Schema$ListInstancePartitionsResponse { + /** + * The list of requested instancePartitions. + */ + instancePartitions?: Schema$InstancePartition[]; + /** + * `next_page_token` can be sent in a subsequent ListInstancePartitions call to fetch more of the matching instance partitions. + */ + nextPageToken?: string | null; + /** + * The list of unreachable instance partitions. It includes the names of instance partitions whose metadata could not be retrieved within instance_partition_deadline. + */ + unreachable?: string[] | null; + } /** * The response for ListInstances. */ @@ -2415,6 +2532,40 @@ export namespace spanner_v1 { */ startTime?: string | null; } + /** + * Metadata type for the operation returned by UpdateInstancePartition. + */ + export interface Schema$UpdateInstancePartitionMetadata { + /** + * The time at which this operation was cancelled. If set, this operation is in the process of undoing itself (which is guaranteed to succeed) and cannot be cancelled again. + */ + cancelTime?: string | null; + /** + * The time at which this operation failed or was completed successfully. + */ + endTime?: string | null; + /** + * The desired end state of the update. + */ + instancePartition?: Schema$InstancePartition; + /** + * The time at which UpdateInstancePartition request was received. + */ + startTime?: string | null; + } + /** + * The request for UpdateInstancePartition. + */ + export interface Schema$UpdateInstancePartitionRequest { + /** + * Required. A mask specifying which fields in InstancePartition should be updated. The field mask must always be specified; this prevents any future fields in InstancePartition from being erased accidentally by clients that do not know about them. + */ + fieldMask?: string | null; + /** + * Required. The instance partition to update, which must always include the instance partition name. Otherwise, only fields mentioned in field_mask need be included. + */ + instancePartition?: Schema$InstancePartition; + } /** * The request for UpdateInstance. */ @@ -3939,6 +4090,7 @@ export namespace spanner_v1 { backups: Resource$Projects$Instances$Backups; databaseOperations: Resource$Projects$Instances$Databaseoperations; databases: Resource$Projects$Instances$Databases; + instancePartitionOperations: Resource$Projects$Instances$Instancepartitionoperations; instancePartitions: Resource$Projects$Instances$Instancepartitions; operations: Resource$Projects$Instances$Operations; constructor(context: APIRequestContext) { @@ -3950,6 +4102,10 @@ export namespace spanner_v1 { this.databaseOperations = new Resource$Projects$Instances$Databaseoperations(this.context); this.databases = new Resource$Projects$Instances$Databases(this.context); + this.instancePartitionOperations = + new Resource$Projects$Instances$Instancepartitionoperations( + this.context + ); this.instancePartitions = new Resource$Projects$Instances$Instancepartitions(this.context); this.operations = new Resource$Projects$Instances$Operations( @@ -9785,6 +9941,133 @@ export namespace spanner_v1 { requestBody?: Schema$ReadRequest; } + export class Resource$Projects$Instances$Instancepartitionoperations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists instance partition long-running operations in the given instance. An instance partition operation has a name of the form `projects//instances//instancePartitions//operations/`. The long-running operation metadata field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.start_time` in descending order starting from the most recently started operation. Authorization requires `spanner.instancePartitionOperations.list` permission on the resource parent. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Instances$Instancepartitionoperations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Instances$Instancepartitionoperations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Instances$Instancepartitionoperations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Instances$Instancepartitionoperations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Instances$Instancepartitionoperations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Instancepartitionoperations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Instancepartitionoperations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Instancepartitionoperations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://spanner.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+parent}/instancePartitionOperations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + 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$Instances$Instancepartitionoperations$List + extends StandardParameters { + /** + * Optional. An expression that filters the list of returned operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `\>`, `<=`, `\>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for CreateInstancePartitionMetadata is `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstancePartitionMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first, if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=` \ `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstancePartitionMetadata) AND` \ `(metadata.instance_partition.name:custom-instance-partition) AND` \ `(metadata.start_time < \"2021-03-28T14:50:00Z\") AND` \ `(error:*)` - Return operations where: * The operation's metadata type is CreateInstancePartitionMetadata. * The instance partition name contains "custom-instance-partition". * The operation started before 2021-03-28T14:50:00Z. * The operation resulted in an error. + */ + filter?: string; + /** + * Optional. Deadline used while retrieving metadata for instance partition operations. Instance partitions whose operation metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancePartitionOperationsResponse. + */ + instancePartitionDeadline?: string; + /** + * Optional. Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. + */ + pageSize?: number; + /** + * Optional. If non-empty, `page_token` should contain a next_page_token from a previous ListInstancePartitionOperationsResponse to the same `parent` and with the same `filter`. + */ + pageToken?: string; + /** + * Required. The parent instance of the instance partition operations. Values are of the form `projects//instances/`. + */ + parent?: string; + } + export class Resource$Projects$Instances$Instancepartitions { context: APIRequestContext; operations: Resource$Projects$Instances$Instancepartitions$Operations; @@ -9795,6 +10078,511 @@ export namespace spanner_v1 { this.context ); } + + /** + * Creates an instance partition and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance partition. The instance partition name is assigned by the caller. If the named instance partition already exists, `CreateInstancePartition` returns `ALREADY_EXISTS`. Immediately upon completion of this request: * The instance partition is readable via the API, with all requested attributes but no allocated resources. Its state is `CREATING`. Until completion of the returned operation: * Cancelling the operation renders the instance partition immediately unreadable via the API. * The instance partition can be deleted. * All other attempts to modify the instance partition are rejected. Upon completion of the returned operation: * Billing for all successfully-allocated resources begins (some types may have lower than the requested levels). * Databases can start using this instance partition. * The instance partition's allocated resource levels are readable via the API. * The instance partition's state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance partition. The metadata field type is CreateInstancePartitionMetadata. The response field type is InstancePartition, if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Instances$Instancepartitions$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Instances$Instancepartitions$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Instances$Instancepartitions$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Instances$Instancepartitions$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Instances$Instancepartitions$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Instancepartitions$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Instancepartitions$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Instancepartitions$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://spanner.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/instancePartitions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes an existing instance partition. Requires that the instance partition is not used by any database or backup and is not the default instance partition of an instance. Authorization requires `spanner.instancePartitions.delete` permission on the resource name. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Instances$Instancepartitions$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Instances$Instancepartitions$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Instances$Instancepartitions$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Instances$Instancepartitions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Instances$Instancepartitions$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Instancepartitions$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Instancepartitions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Instancepartitions$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://spanner.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets information about a particular instance partition. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Instances$Instancepartitions$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Instances$Instancepartitions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Instances$Instancepartitions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Instances$Instancepartitions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Instances$Instancepartitions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Instancepartitions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Instancepartitions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Instancepartitions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://spanner.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists all instance partitions for the given instance. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Instances$Instancepartitions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Instances$Instancepartitions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Instances$Instancepartitions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Instances$Instancepartitions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Instances$Instancepartitions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Instancepartitions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Instancepartitions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Instancepartitions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://spanner.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/instancePartitions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an instance partition, and begins allocating or releasing resources as requested. The returned long-running operation can be used to track the progress of updating the instance partition. If the named instance partition does not exist, returns `NOT_FOUND`. Immediately upon completion of this request: * For resource types for which a decrease in the instance partition's allocation has been requested, billing is based on the newly-requested level. Until completion of the returned operation: * Cancelling the operation sets its metadata's cancel_time, and begins restoring resources to their pre-request values. The operation is guaranteed to succeed at undoing all resource changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance partition are rejected. * Reading the instance partition via the API continues to give the pre-request resource levels. Upon completion of the returned operation: * Billing begins for all successfully-allocated resources (some types may have lower than the requested levels). * All newly-reserved resources are available for serving the instance partition's tables. * The instance partition's new resource levels are readable via the API. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance partition modification. The metadata field type is UpdateInstancePartitionMetadata. The response field type is InstancePartition, if successful. Authorization requires `spanner.instancePartitions.update` permission on the resource name. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Instances$Instancepartitions$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Instances$Instancepartitions$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Instances$Instancepartitions$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Instances$Instancepartitions$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Instances$Instancepartitions$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Instancepartitions$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Instancepartitions$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Instancepartitions$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://spanner.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + 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$Instances$Instancepartitions$Create + extends StandardParameters { + /** + * Required. The name of the instance in which to create the instance partition. Values are of the form `projects//instances/`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreateInstancePartitionRequest; + } + export interface Params$Resource$Projects$Instances$Instancepartitions$Delete + extends StandardParameters { + /** + * Optional. If not empty, the API only deletes the instance partition when the etag provided matches the current status of the requested instance partition. Otherwise, deletes the instance partition without checking the current status of the requested instance partition. + */ + etag?: string; + /** + * Required. The name of the instance partition to be deleted. Values are of the form `projects/{project\}/instances/{instance\}/instancePartitions/{instance_partition\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Instances$Instancepartitions$Get + extends StandardParameters { + /** + * Required. The name of the requested instance partition. Values are of the form `projects/{project\}/instances/{instance\}/instancePartitions/{instance_partition\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Instances$Instancepartitions$List + extends StandardParameters { + /** + * Optional. Deadline used while retrieving metadata for instance partitions. Instance partitions whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancePartitionsResponse. + */ + instancePartitionDeadline?: string; + /** + * Number of instance partitions to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. + */ + pageSize?: number; + /** + * If non-empty, `page_token` should contain a next_page_token from a previous ListInstancePartitionsResponse. + */ + pageToken?: string; + /** + * Required. The instance whose instance partitions should be listed. Values are of the form `projects//instances/`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Instances$Instancepartitions$Patch + extends StandardParameters { + /** + * Required. A unique identifier for the instance partition. Values are of the form `projects//instances//instancePartitions/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. An instance partition's name cannot be changed after the instance partition is created. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UpdateInstancePartitionRequest; } export class Resource$Projects$Instances$Instancepartitions$Operations { diff --git a/src/apis/sqladmin/v1.ts b/src/apis/sqladmin/v1.ts index b5cb77f05e..0f289a532a 100644 --- a/src/apis/sqladmin/v1.ts +++ b/src/apis/sqladmin/v1.ts @@ -246,6 +246,10 @@ export namespace sqladmin_v1 { * Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`. */ startTime?: string | null; + /** + * Output only. This value contains the storage location of transactional logs for the database for point-in-time recovery. + */ + transactionalLogStorageState?: string | null; /** * The number of days of transaction logs we retain for point in time restore, from 1-7. */ @@ -578,6 +582,10 @@ export namespace sqladmin_v1 { * The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance. */ gceZone?: string | null; + /** + * Gemini configuration. + */ + geminiConfig?: Schema$GeminiInstanceConfig; /** * The instance type. */ @@ -642,6 +650,10 @@ export namespace sqladmin_v1 { * The replicas of the instance. */ replicaNames?: string[] | null; + /** + * Optional. The pair of a primary instance and disaster recovery (DR) replica. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance has regional failure. + */ + replicationCluster?: Schema$ReplicationCluster; /** * Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances. */ @@ -963,6 +975,35 @@ export namespace sqladmin_v1 { */ kind?: string | null; } + /** + * Gemini configuration. + */ + export interface Schema$GeminiInstanceConfig { + /** + * Output only. Whether active query is enabled. + */ + activeQueryEnabled?: boolean | null; + /** + * Output only. Whether gemini is enabled. + */ + entitled?: boolean | null; + /** + * Output only. Whether flag recommender is enabled. + */ + flagRecommenderEnabled?: boolean | null; + /** + * Output only. Whether vacuum management is enabled. + */ + googleVacuumMgmtEnabled?: boolean | null; + /** + * Output only. Whether index advisor is enabled. + */ + indexAdvisorEnabled?: boolean | null; + /** + * Output only. Whether oom session cancel is enabled. + */ + oomSessionCancelEnabled?: boolean | null; + } /** * Ephemeral certificate creation request. */ @@ -1659,6 +1700,19 @@ export namespace sqladmin_v1 { */ mysqlReplicaConfiguration?: Schema$MySqlReplicaConfiguration; } + /** + * Primary-DR replica pair + */ + export interface Schema$ReplicationCluster { + /** + * Output only. read-only field that indicates if the replica is a dr_replica; not set for a primary. + */ + drReplica?: boolean | null; + /** + * Optional. If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. A DR replica is an optional configuration for Enterprise Plus edition instances. If the instance is a read replica, then the field is not set. Users can set this field to set a designated DR replica for a primary. Removing this field removes the DR replica. + */ + failoverDrReplicaName?: string | null; + } export interface Schema$Reschedule { /** * Required. The type of the reschedule. @@ -1776,7 +1830,7 @@ export namespace sqladmin_v1 { */ edition?: string | null; /** - * Optional. Configuration to enable Cloud SQL Vertex AI Integration + * Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for PostgreSQL instances. */ enableGoogleMlIntegration?: boolean | null; /** @@ -1935,6 +1989,10 @@ export namespace sqladmin_v1 { * Instance start external sync request. */ export interface Schema$SqlInstancesStartExternalSyncRequest { + /** + * Optional. MigrationType decides if the migration is a physical file based migration or logical migration. + */ + migrationType?: string | null; /** * MySQL-specific settings for start external sync. */ @@ -1956,6 +2014,10 @@ export namespace sqladmin_v1 { * Instance verify external sync settings request. */ export interface Schema$SqlInstancesVerifyExternalSyncSettingsRequest { + /** + * Optional. MigrationType decides if the migration is a physical file based migration or logical migration + */ + migrationType?: string | null; /** * Optional. MySQL-specific settings for start external sync. */ diff --git a/src/apis/sqladmin/v1beta4.ts b/src/apis/sqladmin/v1beta4.ts index e8425aa237..951ca1ddd1 100644 --- a/src/apis/sqladmin/v1beta4.ts +++ b/src/apis/sqladmin/v1beta4.ts @@ -246,6 +246,10 @@ export namespace sqladmin_v1beta4 { * Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`. */ startTime?: string | null; + /** + * Output only. This value contains the storage location of transactional logs for the database for point-in-time recovery. + */ + transactionalLogStorageState?: string | null; /** * The number of days of transaction logs we retain for point in time restore, from 1-7. */ @@ -578,6 +582,10 @@ export namespace sqladmin_v1beta4 { * The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance. */ gceZone?: string | null; + /** + * Gemini instance configuration. + */ + geminiConfig?: Schema$GeminiInstanceConfig; /** * The instance type. */ @@ -642,6 +650,10 @@ export namespace sqladmin_v1beta4 { * The replicas of the instance. */ replicaNames?: string[] | null; + /** + * The pair of a primary instance and disaster recovery (DR) replica. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance has regional failure. + */ + replicationCluster?: Schema$ReplicationCluster; /** * Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances. */ @@ -966,6 +978,35 @@ export namespace sqladmin_v1beta4 { */ kind?: string | null; } + /** + * Gemini configuration. + */ + export interface Schema$GeminiInstanceConfig { + /** + * Output only. Whether active query is enabled. + */ + activeQueryEnabled?: boolean | null; + /** + * Output only. Whether Gemini is enabled. + */ + entitled?: boolean | null; + /** + * Output only. Whether flag recommender is enabled. + */ + flagRecommenderEnabled?: boolean | null; + /** + * Output only. Whether vacuum management is enabled. + */ + googleVacuumMgmtEnabled?: boolean | null; + /** + * Output only. Whether index advisor is enabled. + */ + indexAdvisorEnabled?: boolean | null; + /** + * Output only. Whether oom session cancel is enabled. + */ + oomSessionCancelEnabled?: boolean | null; + } /** * Ephemeral certificate creation request. */ @@ -1662,6 +1703,19 @@ export namespace sqladmin_v1beta4 { */ mysqlReplicaConfiguration?: Schema$MySqlReplicaConfiguration; } + /** + * Primary-DR replica pair + */ + export interface Schema$ReplicationCluster { + /** + * Output only. read-only field that indicates if the replica is a dr_replica; not set for a primary. + */ + drReplica?: boolean | null; + /** + * Optional. If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. A DR replica is an optional configuration for Enterprise Plus edition instances. If the instance is a read replica, then the field is not set. Users can set this field to set a designated DR replica for a primary. Removing this field removes the DR replica. + */ + failoverDrReplicaName?: string | null; + } export interface Schema$Reschedule { /** * Required. The type of the reschedule. @@ -1779,7 +1833,7 @@ export namespace sqladmin_v1beta4 { */ edition?: string | null; /** - * Optional. Configuration to enable Cloud SQL Vertex AI Integration + * Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for PostgreSQL instances. */ enableGoogleMlIntegration?: boolean | null; /** @@ -1935,6 +1989,10 @@ export namespace sqladmin_v1beta4 { */ export interface Schema$SqlInstancesResetReplicaSizeRequest {} export interface Schema$SqlInstancesStartExternalSyncRequest { + /** + * Optional. MigrationType decides if the migration is a physical file based migration or logical migration. + */ + migrationType?: string | null; /** * MySQL-specific settings for start external sync. */ @@ -1953,6 +2011,10 @@ export namespace sqladmin_v1beta4 { syncParallelLevel?: string | null; } export interface Schema$SqlInstancesVerifyExternalSyncSettingsRequest { + /** + * Optional. MigrationType field decides if the migration is a physical file based migration or logical migration + */ + migrationType?: string | null; /** * Optional. MySQL-specific settings for start external sync. */ diff --git a/src/apis/storage/v1.ts b/src/apis/storage/v1.ts index dd1c13e1db..122f1a28d5 100644 --- a/src/apis/storage/v1.ts +++ b/src/apis/storage/v1.ts @@ -5610,6 +5610,10 @@ export namespace storage_v1 { export interface Params$Resource$Managedfolders$Delete extends StandardParameters { + /** + * Allows the deletion of a managed folder even if it is not empty. A managed folder is empty if there are no objects or managed folders that it applies to. Callers must have storage.managedFolders.setIamPolicy permission. + */ + allowNonEmpty?: boolean; /** * Name of the bucket containing the managed folder. */ @@ -7703,7 +7707,7 @@ export namespace storage_v1 { options ), params, - requiredParams: ['bucket', 'object'], + requiredParams: ['bucket', 'object', 'generation'], pathParams: ['bucket', 'object'], context: this.context, }; diff --git a/src/apis/sts/v1.ts b/src/apis/sts/v1.ts index 65cf68da63..859ca5da01 100644 --- a/src/apis/sts/v1.ts +++ b/src/apis/sts/v1.ts @@ -210,68 +210,6 @@ export namespace sts_v1 { */ userProject?: string | null; } - /** - * Request message for ExchangeOauthToken - */ - export interface Schema$GoogleIdentityStsV1ExchangeOauthTokenRequest { - /** - * Optional. The client identifier for the OAuth 2.0 client that requested the provided token. It is REQUIRED when the [client] (https://www.rfc-editor.org/rfc/rfc6749#section-1.1) is not authenticating with the authorization server, i.e. when authentication method is [client authentication] (https://www.rfc-editor.org/rfc/rfc6749#section-3.2.1). - */ - clientId?: string | null; - /** - * Optional. The authorization code that was previously from workforce identity federation's `authorize` endpoint. Required if the flow is authorization code flow, i.e. if grant_type is 'authorization_code' - */ - code?: string | null; - /** - * Optional. The code verifier for the PKCE request, Google Cloud CLI originally generates it before the authorization request. PKCE is used to protect authorization code from interception attacks. See https://www.rfc-editor.org/rfc/rfc7636#section-1.1 and https://www.rfc-editor.org/rfc/rfc7636#section-3. It is required when the flow is authorization code flow, i.e. if grant_type is 'authorization_code' - */ - codeVerifier?: string | null; - /** - * Required. The grant types are as follows: - 'authorization_code' : an authorization code flow, i.e. exchange of authorization code for the Oauth access token - 'refresh_token' : a refresh token flow, i.e. obtain a new access token by providing the refresh token. See https://www.rfc-editor.org/rfc/rfc6749#section-6 - */ - grantType?: string | null; - /** - * Optional. redirect_url is required when the flow is authorization code flow i.e. if grant_type is `authorization_code` See https://www.rfc-editor.org/rfc/rfc6749#section-4.1.3 - */ - redirectUri?: string | null; - /** - * Optional. The Refresh token is the credential that is used to obtain a new access token when the current access token becomes invalid or expires. Required when using refresh token flow, i.e. if `grant_type` is 'refresh_token' See https://www.rfc-editor.org/rfc/rfc6749#section-1.5 and https://www.rfc-editor.org/rfc/rfc6749#section-6 - */ - refreshToken?: string | null; - /** - * Optional. An optional list of scopes that are requested for the token to be returned. See https://www.rfc-editor.org/rfc/rfc6749#section-3.3 Must be a list of space-delimited, case-sensitive strings. Note: Currently, the scopes in the request are not supported - */ - scope?: string | null; - } - /** - * Response message for ExchangeOauthToken. see https://www.rfc-editor.org/rfc/rfc6749#section-5.1 - */ - export interface Schema$GoogleIdentityStsV1ExchangeOauthTokenResponse { - /** - * An OAuth 2.0 security token, issued by Google, in response to the Oauth token exchange request for the authorization code and refresh token flows. The returned [access token](https://www.rfc-editor.org/rfc/rfc6749#section-4.1.4). Tokens can vary in size, depending, in part, on the size of mapped claims, up to a maximum of 12288 bytes (12 KB). Google reserves the right to change the token size and the maximum length at any time. - */ - access_token?: string | null; - /** - * The amount of time, in seconds, between the time when the access token was issued and the time when the access token will expires. - */ - expires_in?: number | null; - /** - * Google issued ID token in response to the OAuth token exchange request for ID token flow. - */ - id_token?: string | null; - /** - * A refresh token, issued by Google, in response to the OAuth token exchange request for refresh token flow - */ - refresh_token?: string | null; - /** - * A list of scopes associated with the returned token. - */ - scope?: string | null; - /** - * The type of token. Field reserved for RFC compliance. See https://www.rfc-editor.org/rfc/rfc6749#section-5.1 - */ - token_type?: string | null; - } /** * Request message for ExchangeToken. */ @@ -326,56 +264,6 @@ export namespace sts_v1 { */ token_type?: string | null; } - /** - * Request message for IntrospectToken. - */ - export interface Schema$GoogleIdentityStsV1IntrospectTokenRequest { - /** - * Required. The OAuth 2.0 security token issued by the Security Token Service API. - */ - token?: string | null; - /** - * Optional. The type of the given token. Supported values are `urn:ietf:params:oauth:token-type:access_token` and `access_token`. - */ - tokenTypeHint?: string | null; - } - /** - * Response message for IntrospectToken. - */ - export interface Schema$GoogleIdentityStsV1IntrospectTokenResponse { - /** - * A boolean value that indicates whether the provided access token is currently active. - */ - active?: boolean | null; - /** - * The client identifier for the OAuth 2.0 client that requested the provided token. - */ - client_id?: string | null; - /** - * The expiration timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token will expire. - */ - exp?: string | null; - /** - * The issued timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token was originally issued. - */ - iat?: string | null; - /** - * The issuer of the provided token. - */ - iss?: string | null; - /** - * A list of scopes associated with the provided token. - */ - scope?: string | null; - /** - * The unique user ID associated with the provided token. For Google Accounts, this value is based on the Google Account's user ID. For federated identities, this value is based on the identity pool ID and the value of the mapped `google.subject` attribute. - */ - sub?: string | null; - /** - * The human-readable identifier for the token principal subject. For example, if the provided token is associated with a workload identity pool, this field contains a value in the following format: `principal://iam.googleapis.com/projects//locations/global/workloadIdentityPools//subject/`. If the provided token is associated with a workforce pool, this field contains a value in the following format: `principal://iam.googleapis.com/locations/global/workforcePools//subject/`. - */ - username?: string | null; - } /** * An `Options` object configures features that the Security Token Service supports, but that are not supported by standard OAuth 2.0 token exchange endpoints, as defined in https://tools.ietf.org/html/rfc8693. */ @@ -421,190 +309,6 @@ export namespace sts_v1 { this.context = context; } - /** - * Gets information about a Google OAuth 2.0 access token issued by the Google Cloud [Security Token Service API](https://cloud.google.com/iam/docs/reference/sts/rest). - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - introspect( - params: Params$Resource$V1$Introspect, - options: StreamMethodOptions - ): GaxiosPromise; - introspect( - params?: Params$Resource$V1$Introspect, - options?: MethodOptions - ): GaxiosPromise; - introspect( - params: Params$Resource$V1$Introspect, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - introspect( - params: Params$Resource$V1$Introspect, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - introspect( - params: Params$Resource$V1$Introspect, - callback: BodyResponseCallback - ): void; - introspect( - callback: BodyResponseCallback - ): void; - introspect( - paramsOrCallback?: - | Params$Resource$V1$Introspect - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$V1$Introspect; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$V1$Introspect; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://sts.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/introspect').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Exchanges a credential that represents the resource owner's authorization for a Google-generated [OAuth 2.0 access token] (https://www.rfc-editor.org/rfc/rfc6749#section-5) or [refreshes an accesstoken] (https://www.rfc-editor.org/rfc/rfc6749#section-6) following [the OAuth 2.0 authorization framework] (https://tools.ietf.org/html/rfc8693) The credential can be one of the following: - An authorization code issued by the workforce identity federation authorization endpoint - A [refresh token](https://www.rfc-editor.org/rfc/rfc6749#section-10.4) issued by this endpoint This endpoint is only meant to be called by the Google Cloud CLI. Also note that this API only accepts the authorization code issued for workforce pools. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - oauthtoken( - params: Params$Resource$V1$Oauthtoken, - options: StreamMethodOptions - ): GaxiosPromise; - oauthtoken( - params?: Params$Resource$V1$Oauthtoken, - options?: MethodOptions - ): GaxiosPromise; - oauthtoken( - params: Params$Resource$V1$Oauthtoken, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - oauthtoken( - params: Params$Resource$V1$Oauthtoken, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - oauthtoken( - params: Params$Resource$V1$Oauthtoken, - callback: BodyResponseCallback - ): void; - oauthtoken( - callback: BodyResponseCallback - ): void; - oauthtoken( - paramsOrCallback?: - | Params$Resource$V1$Oauthtoken - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$V1$Oauthtoken; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$V1$Oauthtoken; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://sts.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/oauthtoken').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - /** * Exchanges a credential for a Google OAuth 2.0 access token. The token asserts an external identity within an identity pool, or it applies a Credential Access Boundary to a Google access token. Note that workforce pools do not support Credential Access Boundaries. When you call this method, do not send the `Authorization` HTTP header in the request. This method does not require the `Authorization` header, and using the header can cause the request to fail. * @@ -698,18 +402,6 @@ export namespace sts_v1 { } } - export interface Params$Resource$V1$Introspect extends StandardParameters { - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIdentityStsV1IntrospectTokenRequest; - } - export interface Params$Resource$V1$Oauthtoken extends StandardParameters { - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIdentityStsV1ExchangeOauthTokenRequest; - } export interface Params$Resource$V1$Token extends StandardParameters { /** * Request body metadata diff --git a/src/apis/testing/v1.ts b/src/apis/testing/v1.ts index cf3fc001cc..09daf266d4 100644 --- a/src/apis/testing/v1.ts +++ b/src/apis/testing/v1.ts @@ -649,7 +649,7 @@ export namespace testing_v1 { */ stateHistories?: Schema$SessionStateEvent[]; /** - * Optional. The amount of time that a device will be initially allocated for. This can eventually be extended with the UpdateDeviceSession RPC. Default: 30 minutes. + * Optional. The amount of time that a device will be initially allocated for. This can eventually be extended with the UpdateDeviceSession RPC. Default: 15 minutes. */ ttl?: string | null; } diff --git a/src/apis/workloadmanager/v1.ts b/src/apis/workloadmanager/v1.ts index 386a0c5b84..26b874c734 100644 --- a/src/apis/workloadmanager/v1.ts +++ b/src/apis/workloadmanager/v1.ts @@ -124,69 +124,6 @@ export namespace workloadmanager_v1 { } } - /** - * The API layer server - */ - export interface Schema$APILayerServer { - /** - * Output only. The api layer name - */ - name?: string | null; - /** - * Output only. OS information - */ - osVersion?: string | null; - /** - * Output only. resources in the component - */ - resources?: Schema$CloudResource[]; - } - /** - * The availability groups for sqlserver - */ - export interface Schema$AvailabilityGroup { - /** - * Output only. The databases - */ - databases?: string[] | null; - /** - * Output only. The availability group name - */ - name?: string | null; - /** - * Output only. The primary server - */ - primaryServer?: string | null; - /** - * Output only. The secondary servers - */ - secondaryServers?: string[] | null; - } - /** - * The backend server - */ - export interface Schema$BackendServer { - /** - * Output only. The backup file - */ - backupFile?: string | null; - /** - * Output only. The backup schedule - */ - backupSchedule?: string | null; - /** - * Output only. The backend name - */ - name?: string | null; - /** - * Output only. OS information - */ - osVersion?: string | null; - /** - * Output only. resources in the component - */ - resources?: Schema$CloudResource[]; - } /** * Message describing big query destination */ @@ -204,53 +141,6 @@ export namespace workloadmanager_v1 { * The request message for Operations.CancelOperation. */ export interface Schema$CancelOperationRequest {} - /** - * The resource on GCP - */ - export interface Schema$CloudResource { - /** - * Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc. - */ - kind?: string | null; - /** - * Output only. resource name - */ - name?: string | null; - } - /** - * The cluster for sqlserver - */ - export interface Schema$Cluster { - /** - * Output only. The nodes - */ - nodes?: string[] | null; - /** - * Output only. The witness server - */ - witnessServer?: string | null; - } - /** - * The database for sqlserver - */ - export interface Schema$Database { - /** - * Output only. The backup file - */ - backupFile?: string | null; - /** - * Output only. The backup schedule - */ - backupSchedule?: string | null; - /** - * Output only. The host VM - */ - hostVm?: string | null; - /** - * Output only. The database name - */ - name?: string | null; - } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} */ @@ -374,23 +264,6 @@ export namespace workloadmanager_v1 { */ violationMessage?: string | null; } - /** - * The front end server - */ - export interface Schema$FrontEndServer { - /** - * Output only. The frontend name - */ - name?: string | null; - /** - * Output only. OS information - */ - osVersion?: string | null; - /** - * Output only. resources in the component - */ - resources?: Schema$CloudResource[]; - } /** * Message describing compute engine instance filter */ @@ -425,44 +298,6 @@ export namespace workloadmanager_v1 { */ sqlserverValidation?: Schema$SqlserverValidation; } - /** - * a vm instance - */ - export interface Schema$Instance { - /** - * Output only. name of the VM - */ - name?: string | null; - /** - * Output only. The location of the VM - */ - region?: string | null; - /** - * Output only. The state of the VM - */ - status?: string | null; - } - /** - * The database layer - */ - export interface Schema$Layer { - /** - * the application layer - */ - applicationType?: string | null; - /** - * Optional. the database layer - */ - databaseType?: string | null; - /** - * Optional. instances in a layer - */ - instances?: Schema$Instance[]; - /** - * Output only. system identification of a layer - */ - sid?: string | null; - } /** * Message for response to listing Evaluations */ @@ -562,36 +397,6 @@ export namespace workloadmanager_v1 { */ scannedResources?: Schema$ScannedResource[]; } - /** - * List workloadResponse returns a response with the list of workload overview - */ - export interface Schema$ListWorkloadProfilesResponse { - /** - * Output only. A token identifying a page of results the server should return - */ - nextPageToken?: string | null; - /** - * Locations that could not be reached. - */ - unreachable?: string[] | null; - /** - * Output only. The list of Workload Overview - */ - workloadOverviews?: Schema$WorkloadProfileOverview[]; - } - /** - * The load balancer for sqlserver - */ - export interface Schema$LoadBalancerServer { - /** - * Output only. The IP address - */ - ip?: string | null; - /** - * Output only. The VM name - */ - vm?: string | null; - } /** * A resource that represents a Google Cloud location. */ @@ -792,27 +597,6 @@ export namespace workloadmanager_v1 { */ requestId?: string | null; } - /** - * The component of sap workload - */ - export interface Schema$SapComponent { - /** - * A list of host URIs that are part of the HA configuration if present. An empty list indicates the component is not configured for HA. - */ - haHosts?: string[] | null; - /** - * Output only. resources in the component - */ - resources?: Schema$CloudResource[]; - /** - * Output only. sid is the sap component identificator - */ - sid?: string | null; - /** - * The detected topology of the component. - */ - topologyType?: string | null; - } /** * The schema of SAP system discovery data. */ @@ -895,6 +679,10 @@ export namespace workloadmanager_v1 { * Optional. Resource URI of the recognized ASCS host of the application. */ ascsUri?: string | null; + /** + * Optional. Instance number of the SAP instance. + */ + instanceNumber?: string | null; /** * Optional. Kernel version for Netweaver running in the system. */ @@ -916,6 +704,10 @@ export namespace workloadmanager_v1 { * Optional. The version of the database software running in the system. */ databaseVersion?: string | null; + /** + * Optional. Instance number of the SAP instance. + */ + instanceNumber?: string | null; /** * Required. URI of the recognized primary instance of the database. */ @@ -1069,40 +861,6 @@ export namespace workloadmanager_v1 { */ sapValidationType?: string | null; } - /** - * The body of sap workload - */ - export interface Schema$SapWorkload { - /** - * Output only. the acsc componment - */ - application?: Schema$SapComponent; - /** - * Output only. the database componment - */ - database?: Schema$SapComponent; - /** - * Output only. The metadata for SAP workload. - */ - metadata?: {[key: string]: string} | null; - } - /** - * The overview of sap workload - */ - export interface Schema$SapWorkloadOverview { - /** - * Output only. The application SID - */ - appSid?: string | null; - /** - * Output only. The database SID - */ - dbSid?: string | null; - /** - * Output only. The UUID for a SAP workload - */ - sapSystemId?: string | null; - } /** * Message of scanned resource */ @@ -1159,40 +917,6 @@ export namespace workloadmanager_v1 { */ type?: string | null; } - /** - * The body of sqlserver workload - */ - export interface Schema$SqlserverWorkload { - /** - * Output only. The availability groups for sqlserver - */ - ags?: Schema$AvailabilityGroup[]; - /** - * Output only. The cluster for sqlserver - */ - cluster?: Schema$Cluster; - /** - * Output only. The databases for sqlserver - */ - databases?: Schema$Database[]; - /** - * Output only. The load balancer for sqlserver - */ - loadBalancerServer?: Schema$LoadBalancerServer; - } - /** - * The overview of sqlserver workload - */ - export interface Schema$SqlserverWorkloadOverview { - /** - * Output only. The availability groups - */ - availabilityGroup?: string[] | null; - /** - * Output only. The UUID for a Sqlserver workload - */ - sqlserverSystemId?: 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). */ @@ -1210,36 +934,6 @@ export namespace workloadmanager_v1 { */ message?: string | null; } - /** - * The body of three tier workload - */ - export interface Schema$ThreeTierWorkload { - /** - * Output only. The API layer for three tier workload - */ - apiLayer?: Schema$APILayerServer; - /** - * Output only. The backend for three tier workload - */ - backend?: Schema$BackendServer; - /** - * Output only. the workload endpoint - */ - endpoint?: string | null; - /** - * Output only. The frontend for three tier workload - */ - frontend?: Schema$FrontEndServer; - } - /** - * The overview of three tier workload - */ - export interface Schema$ThreeTierWorkloadOverview { - /** - * Output only. The UUID for a three tier workload - */ - threeTierSystemId?: string | null; - } /** * Message describing the violdation in execution result */ @@ -1257,76 +951,14 @@ export namespace workloadmanager_v1 { */ serviceAccount?: string | null; } - /** - * workload resource - */ - export interface Schema$WorkloadProfile { - /** - * Optional. The application layer - */ - application?: Schema$Layer; - /** - * Optional. The ascs layer - */ - ascs?: Schema$Layer; - /** - * Optional. The database layer - */ - database?: Schema$Layer; - /** - * Optional. such as name, description, version. More example can be found in deployment - */ - labels?: {[key: string]: string} | null; - /** - * Identifier. name of resource names have the form 'projects/{project_id\}/workloads/{workload_id\}' - */ - name?: string | null; - /** - * Required. time when the workload data was refreshed - */ - refreshedTime?: string | null; - /** - * The sap workload content - */ - sapWorkload?: Schema$SapWorkload; - /** - * The sqlserver workload content - */ - sqlserverWorkload?: Schema$SqlserverWorkload; - /** - * Output only. [output only] the current state if a a workload - */ - state?: string | null; - /** - * The 3 tier web app workload content - */ - threeTierWorkload?: Schema$ThreeTierWorkload; - /** - * Required. The type of the workload - */ - workloadType?: string | null; - } - /** - * a workload profile overview - */ - export interface Schema$WorkloadProfileOverview { - /** - * The sap workload overview - */ - sapWorkloadOverview?: Schema$SapWorkloadOverview; - /** - * The sqlserver workload overview - */ - sqlserverWorkloadOverview?: Schema$SqlserverWorkloadOverview; - /** - * The three tier workload overview - */ - threeTierWorkloadOverview?: Schema$ThreeTierWorkloadOverview; - } /** * Request for sending the data insights. */ export interface Schema$WriteInsightRequest { + /** + * Optional. The agent version collected this data point. + */ + agentVersion?: string | null; /** * Required. The metrics data details. */ @@ -1356,7 +988,6 @@ export namespace workloadmanager_v1 { insights: Resource$Projects$Locations$Insights; operations: Resource$Projects$Locations$Operations; rules: Resource$Projects$Locations$Rules; - workloadProfiles: Resource$Projects$Locations$Workloadprofiles; constructor(context: APIRequestContext) { this.context = context; this.evaluations = new Resource$Projects$Locations$Evaluations( @@ -1367,9 +998,6 @@ export namespace workloadmanager_v1 { this.context ); this.rules = new Resource$Projects$Locations$Rules(this.context); - this.workloadProfiles = new Resource$Projects$Locations$Workloadprofiles( - this.context - ); } /** @@ -3323,220 +2951,4 @@ export namespace workloadmanager_v1 { */ parent?: string; } - - export class Resource$Projects$Locations$Workloadprofiles { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Gets details of a single workload. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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$Workloadprofiles$Get, - options: StreamMethodOptions - ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Workloadprofiles$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Workloadprofiles$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Workloadprofiles$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Workloadprofiles$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Workloadprofiles$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Workloadprofiles$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Workloadprofiles$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://workloadmanager.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * List workloads - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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$Workloadprofiles$List, - options: StreamMethodOptions - ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Workloadprofiles$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Workloadprofiles$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Workloadprofiles$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Workloadprofiles$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Workloadprofiles$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Workloadprofiles$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Workloadprofiles$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://workloadmanager.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/workloadProfiles').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - 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$Workloadprofiles$Get - extends StandardParameters { - /** - * Required. Name of the resource - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Workloadprofiles$List - extends StandardParameters { - /** - * Optional. Filtering results - */ - 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 ListWorkloadRequest - */ - parent?: string; - } }